From add291138d03086f0cb233f2a0eb8a252d14d4f2 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 5 Nov 2026 17:09:37 +1100 Subject: [PATCH 1/2] databricks provider updates databricks_account: - add networking service - parameterise the OAuth M2M token host as account_host, selected by DATABRICKS_CLOUD (aws, azure, gcp; default aws) or overridden with DATABRICKS_ACCOUNT_HOST - regenerate billing, catalog, disasterrecovery, iam, iamv2, oauth2, provisioning, settings and settingsv2 from the Databricks Python SDK databricks_workspace: - add agentkit, aifunctions, dataclassification, domains, environments, knowledgeassistants and sandbox services - same account_host selector for the OAuth M2M token endpoint - regenerate all existing services from the Databricks Python SDK Also ignore the logs directory and stackql_mcp_server_*.log files in any directory. Co-Authored-By: Claude Fable 5.1 --- .gitignore | 3 +- .../v00.00.00000/provider.yaml | 30 +- .../v00.00.00000/services/billing.yaml | 877 +- .../v00.00.00000/services/catalog.yaml | 1279 +- .../services/disasterrecovery.yaml | 1178 +- .../v00.00.00000/services/iam.yaml | 77 +- .../v00.00.00000/services/iamv2.yaml | 3390 +++-- .../v00.00.00000/services/networking.yaml | 1725 +++ .../v00.00.00000/services/oauth2.yaml | 534 +- .../v00.00.00000/services/provisioning.yaml | 491 +- .../v00.00.00000/services/settings.yaml | 11572 +++++++------- .../v00.00.00000/services/settingsv2.yaml | 1478 +- .../v00.00.00000/provider.yaml | 96 +- .../v00.00.00000/services/agentbricks.yaml | 23 +- .../v00.00.00000/services/agentkit.yaml | 3653 +++++ .../v00.00.00000/services/aifunctions.yaml | 881 ++ .../v00.00.00000/services/aisearch.yaml | 1535 +- .../v00.00.00000/services/apps.yaml | 9573 +++++------- .../services/bundledeployments.yaml | 2198 +-- .../v00.00.00000/services/catalog.yaml | 12688 +++++++++------- .../v00.00.00000/services/cleanrooms.yaml | 1997 ++- .../v00.00.00000/services/compute.yaml | 2121 +-- .../v00.00.00000/services/dashboards.yaml | 1236 +- .../v00.00.00000/services/database.yaml | 3590 ++--- .../services/dataclassification.yaml | 513 + .../v00.00.00000/services/dataquality.yaml | 1916 +-- .../v00.00.00000/services/domains.yaml | 846 ++ .../v00.00.00000/services/environments.yaml | 1024 ++ .../v00.00.00000/services/files.yaml | 27 +- .../v00.00.00000/services/iam.yaml | 76 +- .../v00.00.00000/services/iamv2.yaml | 2043 ++- .../v00.00.00000/services/jobs.yaml | 6604 ++++---- .../services/knowledgeassistants.yaml | 2254 +++ .../v00.00.00000/services/marketplace.yaml | 169 +- .../v00.00.00000/services/ml.yaml | 11310 +++++++++----- .../v00.00.00000/services/oauth2.yaml | 43 +- .../v00.00.00000/services/pipelines.yaml | 3612 ++--- .../v00.00.00000/services/postgres.yaml | 6783 +++++---- .../services/qualitymonitorv2.yaml | 959 +- .../v00.00.00000/services/sandbox.yaml | 1414 ++ .../v00.00.00000/services/serving.yaml | 375 +- .../v00.00.00000/services/settings.yaml | 573 +- .../v00.00.00000/services/settingsv2.yaml | 1428 +- .../v00.00.00000/services/sharing.yaml | 793 +- .../v00.00.00000/services/sql.yaml | 1499 +- .../services/supervisoragents.yaml | 1399 +- .../v00.00.00000/services/tags.yaml | 312 +- .../v00.00.00000/services/vectorsearch.yaml | 869 +- .../v00.00.00000/services/workspace.yaml | 107 +- 49 files changed, 59797 insertions(+), 49376 deletions(-) create mode 100644 providers/src/databricks_account/v00.00.00000/services/networking.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/agentkit.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/aifunctions.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/dataclassification.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/domains.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/environments.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/knowledgeassistants.yaml create mode 100644 providers/src/databricks_workspace/v00.00.00000/services/sandbox.yaml diff --git a/.gitignore b/.gitignore index cc38613c..e9e6395f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,8 @@ scripts/*/node_modules/ scripts/*/package-lock.json stackql*.sh -/stackql_mcp_server_*.log +stackql_mcp_server_*.log +/logs/ /stackql stackql-zip .stackql/ diff --git a/providers/src/databricks_account/v00.00.00000/provider.yaml b/providers/src/databricks_account/v00.00.00000/provider.yaml index c3cc9a4b..8cf26728 100644 --- a/providers/src/databricks_account/v00.00.00000/provider.yaml +++ b/providers/src/databricks_account/v00.00.00000/provider.yaml @@ -57,6 +57,17 @@ providerServices: description: >- OpenAPI specification for the Databricks iamv2 service (account-level APIs), generated from the Databricks Python SDK. + networking: + id: networking:v00.00.00000 + name: networking + preferred: true + service: + $ref: databricks_account/v00.00.00000/services/networking.yaml + title: Databricks Networking API (account) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks networking service (account-level + APIs), generated from the Databricks Python SDK. oauth2: id: oauth2:v00.00.00000 name: oauth2 @@ -108,7 +119,22 @@ config: client_secret_env_var: DATABRICKS_CLIENT_SECRET grant_type: client_credentials token_url: >- - https://accounts.cloud.databricks.com/oidc/accounts/{{ - .__env__DATABRICKS_ACCOUNT_ID }}/v1/token + https://{account_host}/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token scopes: - all-apis + variables: + account_host: + description: >- + The Databricks account console host that issues OAuth M2M tokens. + Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set + explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com diff --git a/providers/src/databricks_account/v00.00.00000/services/billing.yaml b/providers/src/databricks_account/v00.00.00000/services/billing.yaml index 81fb7b58..04dd2df9 100644 --- a/providers/src/databricks_account/v00.00.00000/services/billing.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/billing.yaml @@ -5,26 +5,33 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.billing servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/accounts/{account_id}/usage/download: get: operationId: billable_usage_download - summary: Returns billable usage logs in CSV format for the specified account and date range. For the data + summary: Returns billable usage logs in CSV format for the specified account and date range. tags: - billing - billable_usage description: |- - Returns billable usage logs in CSV format for the specified account and date range. For the data - schema, see: - - - AWS: `CSV file schema - `__. - - GCP: `CSV file schema - `__. + Returns billable usage logs in CSV format for the specified account and date range. Note that this method might take multiple minutes to complete. @@ -343,8 +350,6 @@ paths: be specified even if not changed. The ``policy_id`` is used to identify the policy to update. :param limit_config: :class:`LimitConfig` (optional) DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy - :param update_mask: str (optional) - Field mask specifying which fields to update. When not provided, all fields are updated. :returns: :class:`BudgetPolicy` parameters: @@ -365,41 +370,28 @@ paths: schema: $ref: '#/components/schemas/LimitConfig' description: DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy - - name: update_mask - in: query - required: false - schema: - type: string - description: Field mask specifying which fields to update. When not provided, all fields are updated. requestBody: content: application/json: schema: type: object properties: - policy: - type: object - properties: - binding_workspace_ids: - type: array - items: - type: integer - description: List of workspaces that this budget policy will be exclusively bound to. An empty binding - implies that this budget policy is open to any workspace in the account. - custom_tags: - type: string - description: A list of tags defined by the customer. At most 20 entries are allowed per policy. - policy_id: - type: string - description: The Id of the policy. This field is generated by Databricks and globally unique. - policy_name: - type: string - description: The name of the policy. - Must be unique among active policies. - Can contain only characters - from the ISO 8859-1 (latin1) set. - Can't start with reserved keywords such as ``databricks:default-policy``. - description: The policy to update. ``creator_user_id`` cannot be specified in the request. All other fields - must be specified even if not changed. The ``policy_id`` is used to identify the policy to update. - required: - - policy + binding_workspace_ids: + type: array + items: + type: integer + description: List of workspaces that this budget policy will be exclusively bound to. An empty binding implies + that this budget policy is open to any workspace in the account. + custom_tags: + type: string + description: A list of tags defined by the customer. At most 20 entries are allowed per policy. + policy_id: + type: string + description: The Id of the policy. This field is generated by Databricks and globally unique. + policy_name: + type: string + description: The name of the policy. - Must be unique among active policies. - Can contain only characters + from the ISO 8859-1 (latin1) set. - Can't start with reserved keywords such as ``databricks:default-policy``. responses: '200': description: Success @@ -464,11 +456,29 @@ paths: action_type: type: string x-enum: + - BLOCK_USAGE - EMAIL_NOTIFICATION description: Type of action that a budget alert executes when its threshold is crossed. target: type: string description: Target for the action. For example, an email address. + principal_overrides: + type: array + items: + type: object + properties: + override_threshold: + type: string + description: Dollar amount that overrides the parent alert's quantity_threshold for this + principal. + principal_id: + type: integer + description: Account-level principal id (user, group, or service principal). + description: |- + Per-principal threshold override on a PER_USER alert: bumps the alert's quantity_threshold for + one principal_id. + description: Per-principal threshold overrides for this alert. Only applies to per-user alerts + (``scope_type`` = ``ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER``); ignored for shared alerts. quantity_threshold: type: string description: The threshold for the budget alert to determine if it is in a triggered state. The @@ -479,6 +489,13 @@ paths: - LIST_PRICE_DOLLARS_USD description: The way to calculate cost for this budget alert. This is what ``quantity_threshold`` is measured in. + scope_type: + type: string + x-enum: + - ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER + - ALERT_CONFIGURATION_SCOPE_TYPE_SHARED + description: How the alert threshold is evaluated. Determines whether spend is tracked in aggregate + or per individual user. time_period: type: string x-enum: @@ -489,8 +506,14 @@ paths: x-enum: - CUMULATIVE_SPENDING_EXCEEDED description: The evaluation method to determine when this budget alert is in a triggered state. - description: Alerts to configure when this budget is in a triggered state. Budgets must have exactly - one alert configuration. + description: Alerts to configure when this budget is in a triggered state. Budgets must have at least + one alert configuration. A budget can have up to four shared alerts per time period, each with a unique + ``quantity_threshold``. Budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` + can also use per-user alerts, with optional ``principal_overrides``. These budgets can have at most + one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` + action is only supported on budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. + At most one shared alert per time period can have a ``BLOCK_USAGE`` action, and it must be the shared + alert with the highest threshold in that period. display_name: type: string description: 'Human-readable name of budget configuration. Max Length: 128' @@ -604,6 +627,19 @@ paths: 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. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. + include_external_spend: + type: boolean + description: Whether this budget tracks external pass-through spend (third-party costs billed through + a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, + i.e. when ``resource_type`` is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is immutable + after create. + resource_type: + type: string + x-enum: + - BUDGET_RESOURCE_TYPE_ALL_RESOURCES + - BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY + description: The resource scope for this budget. Determines whether the budget tracks all resources + or a specific resource. description: Properties of the new budget configuration. required: - budget @@ -810,6 +846,7 @@ paths: action_type: type: string x-enum: + - BLOCK_USAGE - EMAIL_NOTIFICATION description: The type of the action. target: @@ -818,6 +855,23 @@ paths: alert_configuration_id: type: string description: Databricks alert configuration ID. + principal_overrides: + type: array + items: + type: object + properties: + override_threshold: + type: string + description: Dollar amount that overrides the parent alert's quantity_threshold for this + principal. + principal_id: + type: integer + description: Account-level principal id (user, group, or service principal). + description: |- + Per-principal threshold override on a PER_USER alert: bumps the alert's quantity_threshold for + one principal_id. + description: Per-principal threshold overrides for this alert. Only applies to per-user alerts + (``scope_type`` = ``ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER``); ignored for shared alerts. quantity_threshold: type: string description: The threshold for the budget alert to determine if it is in a triggered state. The @@ -828,6 +882,13 @@ paths: - LIST_PRICE_DOLLARS_USD description: The way to calculate cost for this budget alert. This is what ``quantity_threshold`` is measured in. + scope_type: + type: string + x-enum: + - ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER + - ALERT_CONFIGURATION_SCOPE_TYPE_SHARED + description: How the alert threshold is evaluated. Determines whether spend is tracked in aggregate + or per individual user. time_period: type: string x-enum: @@ -838,8 +899,14 @@ paths: x-enum: - CUMULATIVE_SPENDING_EXCEEDED description: The evaluation method to determine when this budget alert is in a triggered state. - description: Alerts to configure when this budget is in a triggered state. Budgets must have exactly - one alert configuration. + description: Alerts to configure when this budget is in a triggered state. Budgets must have at least + one alert configuration. A budget can have up to four shared alerts per time period, each with a unique + ``quantity_threshold``. Budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` + can also use per-user alerts, with optional ``principal_overrides``. These budgets can have at most + one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` + action is only supported on budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. + At most one shared alert per time period can have a ``BLOCK_USAGE`` action, and it must be the shared + alert with the highest threshold in that period. budget_configuration_id: type: string description: Databricks budget configuration ID. @@ -956,6 +1023,19 @@ paths: 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. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. + include_external_spend: + type: boolean + description: Whether this budget tracks external pass-through spend (third-party costs billed through + a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, + i.e. when ``resource_type`` is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is immutable + after create. + resource_type: + type: string + x-enum: + - BUDGET_RESOURCE_TYPE_ALL_RESOURCES + - BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY + description: The resource scope for this budget. Determines whether the budget tracks all resources + or a specific resource. description: The updated budget. This will overwrite the budget specified by the budget ID. required: - budget @@ -978,6 +1058,148 @@ paths: message: type: string x-stackql-sdk-source: BudgetsAPI + /api/2.1/accounts/{account_id}/budget-spend-statuses/{budget_id}: + get: + operationId: budgets_get_budget_spend_status + summary: Get the calling user's live spend against the blocking thresholds of a single Unity Gateway budget. + tags: + - billing + - budgets + description: |- + Get the calling user's live spend against the blocking thresholds of a single Unity Gateway budget. + Any account user can call this for their own spend. Spend is reported in USD at list price and is + near-real-time, so it may differ slightly from billing data. Returns NOT_FOUND if the budget doesn't + exist or has no blocking thresholds. + + :param name: str + The resource name of the budget spend status to read, of the form + ``accounts/{account_id}/budget-spend-statuses/{budget_id}``. A ``budget_id`` that isn't a valid UUID + fails with INVALID_PARAMETER_VALUE. + + :returns: :class:`BudgetSpendStatus` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: The `account_id` segment of the `name` resource name (`accounts/{account_id}/budget-spend-statuses/{budget_id}`). + The resource name of the budget spend status to read, of the form ``accounts/{account_id}/budget-spend-statuses/{budget_id}``. + A ``budget_id`` that isn't a valid UUID fails with INVALID_PARAMETER_VALUE. + - name: budget_id + in: path + required: true + schema: + type: string + description: The `budget_id` segment of the `name` resource name (`accounts/{account_id}/budget-spend-statuses/{budget_id}`). + The resource name of the budget spend status to read, of the form ``accounts/{account_id}/budget-spend-statuses/{budget_id}``. + A ``budget_id`` that isn't a valid UUID fails with INVALID_PARAMETER_VALUE. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BudgetSpendStatus' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: BudgetsAPI + /api/2.1/accounts/{account_id}/budget-spend-statuses: + get: + operationId: budgets_list_budget_spend_statuses + summary: List the calling user's live spend against the blocking thresholds across the account's Unity Gateway + tags: + - billing + - budgets + description: |- + List the calling user's live spend against the blocking thresholds across the account's Unity Gateway + budgets. Any account user can call this for their own spend. Spend is reported in USD at list price + and is near-real-time, so it may differ slightly from billing data. By default, returns every budget + in the account that has a blocking threshold. Use ``filter`` to narrow results by workspace. + + :param parent: str + The parent account whose budget spend statuses to list, of the form ``accounts/{account_id}``. + :param filter: str (optional) + A filter expression that narrows the returned budgets by workspace. Only ``workspace_id`` is + supported, in lower case with numeric workspace IDs, for example ``workspace_id = 123`` or + ``workspace_id IN (123, 456)``. Matches budgets that apply to any of the listed workspaces, + including budgets that apply to all workspaces. Any other expression, such as an empty ``IN ()`` + list, fails with INVALID_PARAMETER_VALUE. If empty, returns every budget in the account that has a + blocking threshold. + :param page_size: int (optional) + The maximum number of spend statuses to return per page. If unspecified or 0, at most 100 are + returned. The maximum value is 100; values above 100 are coerced to 100. Negative values fail with + INVALID_PARAMETER_VALUE. The server may return fewer results than requested, including zero, even + when more pages remain; page until ``next_page_token`` is absent. + :param page_token: str (optional) + A page token from a previous ``ListBudgetSpendStatuses`` response, used to fetch the next page. + Requests the first page if absent. All other request parameters except ``page_size`` must match the + request that returned the token; otherwise the request fails with INVALID_PARAMETER_VALUE. + + :returns: :class:`ListBudgetSpendStatusesResponse` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: The `account_id` segment of the `parent` resource name (`accounts/{account_id}`). The parent account + whose budget spend statuses to list, of the form ``accounts/{account_id}``. + - name: filter + in: query + required: false + schema: + type: string + description: A filter expression that narrows the returned budgets by workspace. Only ``workspace_id`` is supported, + in lower case with numeric workspace IDs, for example ``workspace_id = 123`` or ``workspace_id IN (123, 456)``. + Matches budgets that apply to any of the listed workspaces, including budgets that apply to all workspaces. Any + other expression, such as an empty ``IN ()`` list, fails with INVALID_PARAMETER_VALUE. If empty, returns every budget + in the account that has a blocking threshold. + - name: page_size + in: query + required: false + schema: + type: integer + description: The maximum number of spend statuses to return per page. If unspecified or 0, at most 100 are returned. + The maximum value is 100; values above 100 are coerced to 100. Negative values fail with INVALID_PARAMETER_VALUE. + The server may return fewer results than requested, including zero, even when more pages remain; page until ``next_page_token`` + is absent. + - name: page_token + in: query + required: false + schema: + type: string + description: A page token from a previous ``ListBudgetSpendStatuses`` response, used to fetch the next page. Requests + the first page if absent. All other request parameters except ``page_size`` must match the request that returned + the token; otherwise the request fails with INVALID_PARAMETER_VALUE. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListBudgetSpendStatusesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: BudgetsAPI /api/2.0/accounts/{account_id}/log-delivery: post: operationId: log_delivery_create @@ -1414,305 +1636,6 @@ paths: message: type: string x-stackql-sdk-source: UsageDashboardsAPI - /api/2.1/accounts/{account_id}/usage-policies: - post: - operationId: usage_policy_create - summary: Creates a new usage policy. - tags: - - billing - - usage_policy - description: |- - Creates a new usage policy. - - :param policy: :class:`UsagePolicy` (optional) - The policy to create. ``policy_id`` needs to be empty as it will be generated - :param request_id: str (optional) - A unique identifier for this request. Restricted to 36 ASCII characters. - - :returns: :class:`UsagePolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - policy: - type: object - properties: - binding_workspace_ids: - type: array - items: - type: integer - description: List of workspaces that this usage policy will be exclusively bound to. - custom_tags: - type: string - description: A list of tags defined by the customer. At most 20 entries are allowed per policy. - policy_id: - type: string - description: The Id of the policy. This field is generated by Databricks and globally unique. - policy_name: - type: string - description: The name of the policy. - description: The policy to create. ``policy_id`` needs to be empty as it will be generated - request_id: - type: string - description: A unique identifier for this request. Restricted to 36 ASCII characters. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UsagePolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: UsagePolicyAPI - get: - operationId: usage_policy_list - summary: Lists all usage policies. Policies are returned in the alphabetically ascending order of their names. - tags: - - billing - - usage_policy - description: |- - Lists all usage policies. Policies are returned in the alphabetically ascending order of their names. - - :param filter_by: :class:`Filter` (optional) - A filter to apply to the list of policies. - :param page_size: int (optional) - The maximum number of usage policies to return. - :param page_token: str (optional) - A page token, received from a previous ``ListUsagePolicies`` call. - :param sort_spec: :class:`SortSpec` (optional) - The sort specification. - - :returns: Iterator over :class:`UsagePolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: filter_by - in: query - required: false - schema: - $ref: '#/components/schemas/Filter' - description: A filter to apply to the list of policies. - - name: page_size - in: query - required: false - schema: - type: integer - description: The maximum number of usage policies to return. - - name: page_token - in: query - required: false - schema: - type: string - description: A page token, received from a previous ``ListUsagePolicies`` call. - - name: sort_spec - in: query - required: false - schema: - $ref: '#/components/schemas/SortSpec' - description: The sort specification. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListUsagePoliciesResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: UsagePolicyAPI - /api/2.1/accounts/{account_id}/usage-policies/{policy_id}: - delete: - operationId: usage_policy_delete - summary: Deletes a usage policy - tags: - - billing - - usage_policy - description: |- - Deletes a usage policy - - :param policy_id: str - The Id of the policy. - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: policy_id - in: path - required: true - schema: - type: string - description: The Id of the policy. - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: UsagePolicyAPI - get: - operationId: usage_policy_get - summary: Retrieves a usage policy by it's ID. - tags: - - billing - - usage_policy - description: |- - Retrieves a usage policy by it's ID. - - :param policy_id: str - The Id of the policy. - - :returns: :class:`UsagePolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: policy_id - in: path - required: true - schema: - type: string - description: The Id of the policy. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UsagePolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: UsagePolicyAPI - patch: - operationId: usage_policy_update - summary: Updates a usage policy - tags: - - billing - - usage_policy - description: |- - Updates a usage policy - - :param policy_id: str - The Id of the policy. This field is generated by Databricks and globally unique. - :param policy: :class:`UsagePolicy` - The policy to update. ``creator_user_id`` cannot be specified in the request. - :param limit_config: :class:`LimitConfig` (optional) - DEPRECATED. This is redundant field as LimitConfig is part of the UsagePolicy - - :returns: :class:`UsagePolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: policy_id - in: path - required: true - schema: - type: string - description: The Id of the policy. This field is generated by Databricks and globally unique. - - name: limit_config - in: query - required: false - schema: - $ref: '#/components/schemas/LimitConfig' - description: DEPRECATED. This is redundant field as LimitConfig is part of the UsagePolicy - requestBody: - content: - application/json: - schema: - type: object - properties: - policy: - type: object - properties: - binding_workspace_ids: - type: array - items: - type: integer - description: List of workspaces that this usage policy will be exclusively bound to. - custom_tags: - type: string - description: A list of tags defined by the customer. At most 20 entries are allowed per policy. - policy_id: - type: string - description: The Id of the policy. This field is generated by Databricks and globally unique. - policy_name: - type: string - description: The name of the policy. - description: The policy to update. ``creator_user_id`` cannot be specified in the request. - required: - - policy - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UsagePolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: UsagePolicyAPI components: schemas: ActionConfiguration: @@ -1736,6 +1659,12 @@ components: alert_configuration_id: type: string description: Databricks alert configuration ID. + principal_overrides: + type: array + items: + $ref: '#/components/schemas/PrincipalOverride' + description: Per-principal threshold overrides for this alert. Only applies to per-user alerts (``scope_type`` = + ``ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER``); ignored for shared alerts. quantity_threshold: type: string description: The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated @@ -1743,12 +1672,44 @@ components: quantity_type: $ref: '#/components/schemas/AlertConfigurationQuantityType' description: The way to calculate cost for this budget alert. This is what ``quantity_threshold`` is measured in. + scope_type: + $ref: '#/components/schemas/AlertConfigurationScopeType' + description: How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual + user. time_period: $ref: '#/components/schemas/AlertConfigurationTimePeriod' description: The time window of usage data for the budget. trigger_type: $ref: '#/components/schemas/AlertConfigurationTriggerType' description: The evaluation method to determine when this budget alert is in a triggered state. + AlertSpendStatus: + type: object + properties: + percent_consumed: + type: string + description: Percentage of the threshold consumed, as a decimal string rounded down to one decimal place (for example, + "68.4" means 68.4%). May exceed 100 when spend is over the threshold. Returns "0.0" if there's no spend, and is + omitted if the threshold is $0. For shared thresholds, this is the only value returned; the absolute ``spend`` + and ``threshold`` dollar amounts are withheld. + scope_type: + $ref: '#/components/schemas/AlertConfigurationScopeType' + description: Whether the threshold is evaluated per individual user (``ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER``) + or on the shared spend across all users (``ALERT_CONFIGURATION_SCOPE_TYPE_SHARED``). + spend: + type: string + description: The calling user's live spend against this threshold, in USD at list price. Returns "0" if the caller + has no usage. Omitted for shared thresholds, where only ``percent_consumed`` is returned. + threshold: + type: string + description: The calling user's effective threshold, in USD at list price. The effective threshold is the actual + threshold amount that applies to the user, after adjusting for any user or group overrides. Omitted for shared + thresholds, where only ``percent_consumed`` is returned. + time_period: + $ref: '#/components/schemas/AlertConfigurationTimePeriod' + description: The time window the threshold applies to, for example ``MONTH``. + description: |- + The calling user's spend against a single blocking threshold. Values may be omitted if live + spend or threshold data is temporarily unavailable. BudgetConfiguration: type: object properties: @@ -1758,7 +1719,13 @@ components: type: array items: $ref: '#/components/schemas/AlertConfiguration' - description: Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration. + description: Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert + configuration. A budget can have up to four shared alerts per time period, each with a unique ``quantity_threshold``. + Budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, + with optional ``principal_overrides``. These budgets can have at most one per-user alert per time period, and + can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported on budgets with + ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one shared alert per time period can + have a ``BLOCK_USAGE`` action, and it must be the shared alert with the highest threshold in that period. budget_configuration_id: type: string description: Databricks budget configuration ID. @@ -1773,6 +1740,15 @@ components: 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. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. + include_external_spend: + type: boolean + description: Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks + product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when ``resource_type`` + is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is immutable after create. + resource_type: + $ref: '#/components/schemas/BudgetResourceType' + description: The resource scope for this budget. Determines whether the budget tracks all resources or a specific + resource. update_time: type: integer description: Update time of this budget configuration. @@ -1831,6 +1807,19 @@ components: description: The name of the policy. - Must be unique among active policies. - Can contain only characters from the ISO 8859-1 (latin1) set. - Can't start with reserved keywords such as ``databricks:default-policy``. description: Contains the BudgetPolicy details. + BudgetSpendStatus: + type: object + properties: + alert_spend_statuses: + type: array + items: + $ref: '#/components/schemas/AlertSpendStatus' + description: The calling user's spend against each blocking threshold on this budget, one entry per scope type and + time period. A blocking threshold is a threshold that, once reached, blocks further requests through Unity Gateway. + name: + type: string + description: The resource name of this budget spend status, of the form ``accounts/{account_id}/budget-spend-statuses/{budget_id}``. + description: The calling user's live spend against the blocking thresholds of a single budget. CreateBillingUsageDashboardResponse: type: object properties: @@ -1845,7 +1834,13 @@ components: type: array items: $ref: '#/components/schemas/CreateBudgetConfigurationBudgetAlertConfigurations' - description: Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration. + description: Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert + configuration. A budget can have up to four shared alerts per time period, each with a unique ``quantity_threshold``. + Budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, + with optional ``principal_overrides``. These budgets can have at most one per-user alert per time period, and + can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported on budgets with + ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one shared alert per time period can + have a ``BLOCK_USAGE`` action, and it must be the shared alert with the highest threshold in that period. display_name: type: string description: 'Human-readable name of budget configuration. Max Length: 128' @@ -1854,6 +1849,15 @@ components: 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. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. + include_external_spend: + type: boolean + description: Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks + product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when ``resource_type`` + is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is immutable after create. + resource_type: + $ref: '#/components/schemas/BudgetResourceType' + description: The resource scope for this budget. Determines whether the budget tracks all resources or a specific + resource. CreateBudgetConfigurationBudgetActionConfigurations: type: object properties: @@ -1869,6 +1873,12 @@ components: type: array items: $ref: '#/components/schemas/CreateBudgetConfigurationBudgetActionConfigurations' + principal_overrides: + type: array + items: + $ref: '#/components/schemas/PrincipalOverride' + description: Per-principal threshold overrides for this alert. Only applies to per-user alerts (``scope_type`` = + ``ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER``); ignored for shared alerts. quantity_threshold: type: string description: The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated @@ -1876,6 +1886,10 @@ components: quantity_type: $ref: '#/components/schemas/AlertConfigurationQuantityType' description: The way to calculate cost for this budget alert. This is what ``quantity_threshold`` is measured in. + scope_type: + $ref: '#/components/schemas/AlertConfigurationScopeType' + description: How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual + user. time_period: $ref: '#/components/schemas/AlertConfigurationTimePeriod' description: The time window of usage data for the budget. @@ -2023,20 +2037,20 @@ components: description: A token that can be sent as ``page_token`` to retrieve the previous page. In this field is omitted, there are no previous pages. description: A list of policies. - ListUsagePoliciesResponse: + ListBudgetSpendStatusesResponse: type: object properties: - next_page_token: - type: string - description: A token that can be sent as ``page_token`` to retrieve the next page. - policies: + budget_spend_statuses: type: array items: - $ref: '#/components/schemas/UsagePolicy' - previous_page_token: + $ref: '#/components/schemas/BudgetSpendStatus' + description: The calling user's spend status, one entry per returned budget. + next_page_token: type: string - description: A token that can be sent as ``page_token`` to retrieve the previous page. - description: A list of usage policies. + description: Token to pass as ``page_token`` to retrieve the next page. Absent when there are no more results. A + page can contain fewer results than ``page_size``, or none, while this token is still set, so keep paging until + it's absent. + description: Response for ListBudgetSpendStatuses. LogDeliveryConfiguration: type: object properties: @@ -2133,6 +2147,18 @@ components: PatchStatusResponse: type: object properties: {} + PrincipalOverride: + type: object + properties: + override_threshold: + type: string + description: Dollar amount that overrides the parent alert's quantity_threshold for this principal. + principal_id: + type: integer + description: Account-level principal id (user, group, or service principal). + description: |- + Per-principal threshold override on a PER_USER alert: bumps the alert's quantity_threshold for + one principal_id. SortSpec: type: object properties: @@ -2150,7 +2176,13 @@ components: type: array items: $ref: '#/components/schemas/AlertConfiguration' - description: Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration. + description: Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert + configuration. A budget can have up to four shared alerts per time period, each with a unique ``quantity_threshold``. + Budgets with ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`` can also use per-user alerts, + with optional ``principal_overrides``. These budgets can have at most one per-user alert per time period, and + can use shared alerts, a per-user alert, or both. The ``BLOCK_USAGE`` action is only supported on budgets with + ``resource_type`` set to ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. At most one shared alert per time period can + have a ``BLOCK_USAGE`` action, and it must be the shared alert with the highest threshold in that period. budget_configuration_id: type: string description: Databricks budget configuration ID. @@ -2162,29 +2194,20 @@ components: 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. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. + include_external_spend: + type: boolean + description: Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks + product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when ``resource_type`` + is ``BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY``. This field is immutable after create. + resource_type: + $ref: '#/components/schemas/BudgetResourceType' + description: The resource scope for this budget. Determines whether the budget tracks all resources or a specific + resource. UpdateBudgetConfigurationResponse: type: object properties: budget: $ref: '#/components/schemas/BudgetConfiguration' - UsagePolicy: - type: object - properties: - binding_workspace_ids: - type: array - items: - type: integer - description: List of workspaces that this usage policy will be exclusively bound to. - custom_tags: - type: string - description: A list of tags defined by the customer. At most 20 entries are allowed per policy. - policy_id: - type: string - description: The Id of the policy. This field is generated by Databricks and globally unique. - policy_name: - type: string - description: The name of the policy. - description: Contains the UsagePolicy details (same structure as BudgetPolicy) WrappedLogDeliveryConfiguration: type: object properties: @@ -2204,6 +2227,7 @@ components: ActionConfigurationType: type: string x-enum: + - BLOCK_USAGE - EMAIL_NOTIFICATION description: Type of action that a budget alert executes when its threshold is crossed. AlertConfigurationQuantityType: @@ -2247,6 +2271,12 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + AlertConfigurationScopeType: + type: string + x-enum: + - ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER + - ALERT_CONFIGURATION_SCOPE_TYPE_SHARED + description: Evaluation scope for an alert configuration. AlertConfigurationTimePeriod: type: string x-enum: @@ -2370,6 +2400,14 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + BudgetResourceType: + type: string + x-enum: + - BUDGET_RESOURCE_TYPE_ALL_RESOURCES + - BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY + description: |- + Resource scope for a budget configuration. Determines whether the budget tracks all resources or + a specific resource. DeliveryStatus: type: string x-enum: @@ -2663,6 +2701,32 @@ components: - $ref: '#/components/x-stackQL-resources/budgets/methods/budgets_delete' replace: - $ref: '#/components/x-stackQL-resources/budgets/methods/budgets_update' + budget_spend_statuses: + id: databricks_account.billing.budget_spend_statuses + name: budget_spend_statuses + title: Budget Spend Statuses + methods: + get: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budget-spend-statuses~1{budget_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1budget-spend-statuses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.budget_spend_statuses + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/budget_spend_statuses/methods/get' + - $ref: '#/components/x-stackQL-resources/budget_spend_statuses/methods/list' + insert: [] + update: [] + delete: [] + replace: [] log_delivery: id: databricks_account.billing.log_delivery name: log_delivery @@ -2738,59 +2802,6 @@ components: update: [] delete: [] replace: [] - usage_policy: - id: databricks_account.billing.usage_policy - name: usage_policy - title: Usage Policy - methods: - usage_policy_create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1usage-policies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - usage_policy_list: - operation: - $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1usage-policies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.policies - usage_policy_delete: - operation: - $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1usage-policies~1{policy_id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - usage_policy_get: - operation: - $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1usage-policies~1{policy_id}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - usage_policy_update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.1~1accounts~1{account_id}~1usage-policies~1{policy_id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/usage_policy/methods/usage_policy_get' - - $ref: '#/components/x-stackQL-resources/usage_policy/methods/usage_policy_list' - insert: - - $ref: '#/components/x-stackQL-resources/usage_policy/methods/usage_policy_create' - update: - - $ref: '#/components/x-stackQL-resources/usage_policy/methods/usage_policy_update' - delete: - - $ref: '#/components/x-stackQL-resources/usage_policy/methods/usage_policy_delete' - replace: [] vw_budget_policies: name: vw_budget_policies id: databricks_account.billing.vw_budget_policies @@ -2828,7 +2839,6 @@ components: w.value AS binding_workspace_id FROM databricks_account.billing.budget_policy p, JSON_EACH(p.binding_workspace_ids) w - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -2840,7 +2850,6 @@ components: w.value AS binding_workspace_id FROM databricks_account.billing.budget_policy p, jsonb_array_elements(p.binding_workspace_ids::jsonb) AS w - WHERE account_id = '{{ account_id }}' vw_budgets: name: vw_budgets id: databricks_account.billing.vw_budgets @@ -2914,7 +2923,6 @@ components: JSON_EXTRACT(ac.value, '$.action_configurations') AS action_configurations FROM databricks_account.billing.budgets b, JSON_EACH(b.alert_configurations) ac - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -2935,7 +2943,6 @@ components: ac.value->'action_configurations' AS action_configurations FROM databricks_account.billing.budgets b, jsonb_array_elements(b.alert_configurations::jsonb) AS ac - WHERE account_id = '{{ account_id }}' vw_budget_alert_actions: name: vw_budget_alert_actions id: databricks_account.billing.vw_budget_alert_actions @@ -2986,7 +2993,6 @@ components: FROM databricks_account.billing.budgets b, JSON_EACH(b.alert_configurations) ac, JSON_EACH(JSON_EXTRACT(ac.value, '$.action_configurations')) act - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3002,7 +3008,6 @@ components: FROM databricks_account.billing.budgets b, jsonb_array_elements(b.alert_configurations::jsonb) AS ac, jsonb_array_elements((ac.value->'action_configurations')::jsonb) AS act - WHERE account_id = '{{ account_id }}' vw_log_delivery_configurations: name: vw_log_delivery_configurations id: databricks_account.billing.vw_log_delivery_configurations @@ -3087,7 +3092,6 @@ components: JSON_EXTRACT(ld.log_delivery_status, '$.last_successful_attempt_time') AS last_successful_attempt_time, ld.workspace_ids_filter FROM databricks_account.billing.log_delivery ld - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3110,7 +3114,6 @@ components: ld.log_delivery_status->>'last_successful_attempt_time' AS last_successful_attempt_time, ld.workspace_ids_filter FROM databricks_account.billing.log_delivery ld - WHERE account_id = '{{ account_id }}' vw_log_delivery_workspace_filter: name: vw_log_delivery_workspace_filter id: databricks_account.billing.vw_log_delivery_workspace_filter @@ -3156,7 +3159,6 @@ components: w.value AS workspace_id FROM databricks_account.billing.log_delivery ld, JSON_EACH(ld.workspace_ids_filter) w - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3170,7 +3172,6 @@ components: w.value AS workspace_id FROM databricks_account.billing.log_delivery ld, jsonb_array_elements(ld.workspace_ids_filter::jsonb) AS w - WHERE account_id = '{{ account_id }}' vw_budget_filter_tags: name: vw_budget_filter_tags id: databricks_account.billing.vw_budget_filter_tags @@ -3212,7 +3213,6 @@ components: JSON_EXTRACT(t.value, '$.value.values') AS tag_values FROM databricks_account.billing.budgets b, JSON_EACH(JSON_EXTRACT(b.filter, '$.tags')) t - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3225,7 +3225,6 @@ components: t.value->'value'->'values' AS tag_values FROM databricks_account.billing.budgets b, jsonb_array_elements((b.filter->'tags')::jsonb) AS t - WHERE account_id = '{{ account_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/catalog.yaml b/providers/src/databricks_account/v00.00.00000/services/catalog.yaml index e16bd1c1..0dae4cf9 100644 --- a/providers/src/databricks_account/v00.00.00000/services/catalog.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/catalog.yaml @@ -5,10 +5,23 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.catalog servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}: post: @@ -994,7 +1007,6 @@ paths: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: Whether the current securable is accessible from all workspaces or a specific set of workspaces. owner: type: string @@ -1464,7 +1476,6 @@ paths: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: Whether the current securable is accessible from all workspaces or a specific set of workspaces. new_name: type: string @@ -1793,109 +1804,6 @@ components: credential_info: $ref: '#/components/schemas/StorageCredentialInfo' description: The storage credential was successfully updated. - AgentService: - type: object - properties: - agent_service_type: - $ref: '#/components/schemas/AgentServiceAgentServiceType' - description: Type of agent service. Required on create. Immutable after creation. For future internal / genie / - app kinds, determines how the backing agent surface is provisioned. - browse_only: - type: boolean - description: Whether the caller sees only metadata available through the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: - $ref: '#/components/schemas/AgentServiceConfig' - description: 'Operational configuration: connection, base_path, system_prompt, model_service, optional inference - table, optional rate limits. Required on CreateAgentService; on UpdateAgentService it is required only when ``config`` - (or a ``config.*`` subpath) appears in ``update_mask``.' - create_time: - type: string - format: date-time - description: When the agent service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: The resolved owner of the agent service. Falls back to the caller's identity when ``owner`` is not - explicitly set on creation. - etag: - type: string - description: Optimistic concurrency control token. Server-generated from the entity's state and returned on every - read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the agent service. - name: - type: string - description: 'Resource name of the agent service. Format: ``agent-services/{catalog}.{schema}.{agent_service}``. - Each ``{...}`` component is capped at 255 characters individually. Server-derived on Create from ``parent`` + - ``agent_service_id``; required and immutable on Update/Get/Delete.' - owner: - type: string - description: The owner of the agent service. Write-only; read owner via effective_owner. - update_time: - type: string - format: date-time - description: When the agent service was last modified. - updated_by: - type: string - description: Identity of the last updater. - description: |- - An agent service represents a governed registration of an external AI agent (Bedrock Agents, - Snowflake Cortex Agents, Foundry, etc) in Unity Catalog. It acts as a schema-scoped securable - that references a UC Connection holding the agent platform's auth + endpoint, and exposes the - agent for discovery, authorization, and audit logging. Initial kind: AGENT_SERVICE_STANDARD. - Future kinds (INTERNAL, GENIE, APP) can be added as separate enum values. - AgentServiceConfig: - type: object - properties: - base_path: - type: string - description: 'Vendor base path appended to the connection url at invocation time. Bedrock example: ``/agents/AGENT123/agentAliases/ALIAS1/sessions``. - Empty when the agent platform does not require a per-agent suffix.' - inference_table: - $ref: '#/components/schemas/InferenceTableConfig' - description: Inference table config for invocation payload logging. Reuses the shared InferenceTableConfig (same - as ModelServiceConfig.inference_table). - model_service: - type: string - description: 'Resource name of the model service backing this agent. Empty when the agent platform manages its own - model selection (e.g. Bedrock Agents). Format: ``model-services/{catalog}.{schema}.{model_service}``.' - rate_limits: - type: array - items: - $ref: '#/components/schemas/RateLimit' - description: Per-principal rate limits applied to invocations routed through this agent service. Repeated to support - per-USER / USER_GROUP / SERVICE_PRINCIPAL / SERVICE / USER_DEFAULT scopes simultaneously, mirroring McpServiceConfig.rate_limits. - Empty when no rate limit is configured. - source_connection: - $ref: '#/components/schemas/AgentServiceConfigSourceConnection' - description: External agent referenced via a UC Connection. - system_prompt: - type: string - description: System prompt prepended to invocations. Max 8 KB. - description: |- - Operational configuration for an agent service. Groups the source connection, base path, system - prompt, model service reference, optional inference table, and optional rate limits. The - ``source_connection.name`` is supplied on create. - AgentServiceConfigSourceConnection: - type: object - properties: - name: - type: string - is_deleted: - type: boolean - required: - - name - description: |- - UC Connection for the agent platform, such as Bedrock Agents, Snowflake Cortex Agents, or - Foundry. On create, provide ``name`` in the schema-scoped form - ``connections/{catalog}.{schema}.{connection}``. On read, the service returns ``name``. ArtifactAllowlistInfo: type: object properties: @@ -2118,21 +2026,11 @@ components: CancelRefreshResponse: type: object properties: {} - CatalogFederationConfig: - type: object - properties: - schema_filter_type: - $ref: '#/components/schemas/SchemaFilterType' - description: Controls how the catalog's schema filter items are treated. - description: Federation-only configuration for a FOREIGN catalog. CatalogInfo: type: object properties: browse_only: type: boolean - catalog_federation_config: - $ref: '#/components/schemas/CatalogFederationConfig' - description: Federation-only configuration, present only for FOREIGN catalogs. catalog_type: $ref: '#/components/schemas/CatalogType' comment: @@ -2141,9 +2039,6 @@ components: connection_name: type: string description: The name of the connection to an external data source. - conversion_info: - $ref: '#/components/schemas/ConversionInfo' - description: Status of conversion of FOREIGN catalog to UC Native catalog. created_at: type: integer description: Time at which this catalog was created, in epoch milliseconds. @@ -2153,9 +2048,6 @@ components: custom_max_retention_hours: type: integer description: Custom maximum retention period in hours for the catalog - dr_replication_info: - $ref: '#/components/schemas/DrReplicationInfo' - description: Disaster Recovery replication state snapshot. effective_predictive_optimization_flag: $ref: '#/components/schemas/EffectivePredictiveOptimizationFlag' enable_predictive_optimization: @@ -2271,9 +2163,9 @@ components: type: array items: $ref: '#/components/schemas/PolicyFunctionArgument' - description: The list of additional table columns or literals to be passed as additional arguments to a column mask - function. This is the replacement of the deprecated using_column_names field and carries information about the - types (alias or constant) of the arguments to the mask function. + description: 'The list of table columns or literals to be passed as additional arguments to a column mask function, + carrying the type (column reference vs constant literal) of each argument. Deprecated: use using_column_names + instead.' using_column_names: type: array items: @@ -2319,28 +2211,6 @@ components: - column_alias - tag_key description: 'Extracts the value of a column-level tag: get_column_tag_value(col, "tagKey").' - ConditionalDisplay: - type: object - properties: - depends_on_option: - type: string - description: The name of the option whose value determines visibility of this option. - hidden_when_values: - type: array - items: - type: string - description: The values of the depends_on_option that will hide this option. If empty or not set, this option follows - default visibility (shown unless is_hidden is true). If depends_on_option has any of these values, this option - is hidden. - description: |- - Defines when an option should be hidden based on another option's value. For example, for - pre-created OAuth connections, some options are conditionally hidden. This field works in - conjunction with OptionSpec.is_hidden: - - - If OptionSpec.is_hidden is true, the option is always hidden regardless of ConditionalDisplay. - - If OptionSpec.is_hidden is false (or unset), ConditionalDisplay determines visibility: - - If depends_on_option matches any value in hidden_when_values, hide this option. - - Otherwise, show this option. ConnectionDependency: type: object properties: @@ -2425,13 +2295,6 @@ components: description: |- Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE or the ONLINE_UPDATING_PIPELINE_RESOURCES state. - ConversionInfo: - type: object - properties: - state: - $ref: '#/components/schemas/ConversionInfoState' - description: The conversion state of the resource. - description: Status of conversion of FOREIGN entity into UC Native entity. CreateAccessRequest: type: object properties: @@ -2564,7 +2427,8 @@ components: description: Table function return parameters. routine_dependencies: $ref: '#/components/schemas/DependencyList' - description: function dependencies. + description: Function dependencies. For external UDFs, dependencies may contain only credential, secret, or volume + objects. sql_path: type: string description: List of schemes whose objects can be referenced without qualification. @@ -2723,6 +2587,12 @@ components: DeleteCredentialResponse: type: object properties: {} + DeleteMcpServiceUserMappedCredentialResponse: + type: object + properties: {} + description: |- + Delete returns no resource; a dedicated (empty) response keeps the revoke RPC's shape owned here + rather than google.protobuf.Empty. DeleteMonitorResponse: type: object properties: {} @@ -2778,18 +2648,8 @@ components: $ref: '#/components/schemas/CredentialDependency' function: $ref: '#/components/schemas/FunctionDependency' - metastore_name: - type: string - description: Metastore context for the dependency. Global UC server responses currently populate this with the metastore - UUID string so clients can disambiguate dependencies with identical names across metastores. - secret: - $ref: '#/components/schemas/SecretDependency' - description: A dependency on a Unity Catalog secret. table: $ref: '#/components/schemas/TableDependency' - volume: - $ref: '#/components/schemas/VolumeDependency' - description: A dependency on a Unity Catalog volume. description: |- A dependency of a SQL object. One of the following fields must be defined: **table**, **function**, **connection**, **credential**, **volume**, or **secret**. @@ -2805,19 +2665,6 @@ components: DisableResponse: type: object properties: {} - DrReplicationInfo: - type: object - properties: - last_failover_time_ms: - type: integer - description: Wall-clock epoch milliseconds when this catalog was last promoted to primary via failover or failback. - Set by DR Manager. Used by Predictive Optimization to suppress operations until sufficient workload history accumulates. - replicated_entities: - type: string - description: See https://docs.google.com/document/d/1X0A_3hMhzuS2V1E3zB0x5wxPsFx70bVYK5rHep2AjW8. - status: - $ref: '#/components/schemas/DrReplicationStatus' - description: Metadata related to Disaster Recovery. EffectivePermissionsList: type: object properties: @@ -2902,9 +2749,6 @@ components: entity_type: type: string description: The type of the entity to which the tag is assigned. - inherited: - type: boolean - description: Boolean which indicates whether this tag is inherited. source_type: $ref: '#/components/schemas/TagAssignmentSourceType' description: The source type of the tag assignment, e.g., user-assigned or system-assigned @@ -2990,9 +2834,6 @@ components: table_info: $ref: '#/components/schemas/ExternalLineageTableInfo' description: Information about the table involved in the lineage relationship. - volume_info: - $ref: '#/components/schemas/ExternalLineageVolumeInfo' - description: Information about the volume involved in the lineage relationship. description: Lineage response containing lineage information of a data asset. ExternalLineageModelVersion: type: object @@ -3025,8 +2866,6 @@ components: $ref: '#/components/schemas/ExternalLineagePath' table: $ref: '#/components/schemas/ExternalLineageTable' - volume: - $ref: '#/components/schemas/ExternalLineageVolume' ExternalLineagePath: type: object properties: @@ -3097,26 +2936,6 @@ components: type: string description: Name of Schema. description: Represents the table information in the lineage event. - ExternalLineageVolume: - type: object - properties: - name: - type: string - ExternalLineageVolumeInfo: - type: object - properties: - catalog_name: - type: string - event_time: - type: string - format: date-time - description: Timestamp of the lineage event. - name: - type: string - description: Name of the volume. - schema_name: - type: string - description: Name of the schema. ExternalLocationInfo: type: object properties: @@ -3253,16 +3072,12 @@ components: properties: managed_aqs: $ref: '#/components/schemas/AzureQueueStorage' - managed_onelake: - $ref: '#/components/schemas/OneLakeEventQueue' managed_pubsub: $ref: '#/components/schemas/GcpPubsub' managed_sqs: $ref: '#/components/schemas/AwsSqsQueue' provided_aqs: $ref: '#/components/schemas/AzureQueueStorage' - provided_onelake: - $ref: '#/components/schemas/OneLakeEventQueue' provided_pubsub: $ref: '#/components/schemas/GcpPubsub' provided_sqs: @@ -3395,7 +3210,8 @@ components: description: Function body. routine_dependencies: $ref: '#/components/schemas/DependencyList' - description: function dependencies. + description: Function dependencies. For external UDFs, dependencies may contain only credential, secret, or volume + objects. schema_name: type: string description: Name of parent Schema relative to its parent Catalog. @@ -3501,8 +3317,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -3543,8 +3357,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -3565,8 +3377,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -3663,6 +3473,18 @@ components: type: string description: Opaque token to retrieve the next page of results. Absent if there are no more pages. **page_token** should be set to this value for the next request (for the next page of results). + GovernedTagReference: + type: object + properties: + tag_key: + type: string + description: The governed tag key. + tag_value: + type: string + description: The governed tag value, when the policy references a specific value. + required: + - tag_key + description: A governed tag referenced by a policy condition. GrantOptions: type: object properties: @@ -3677,38 +3499,27 @@ components: properties: parent: type: string - description: 'Parent UC schema where the inference table is created. Format: ``schemas/{catalog}.{schema}``. Set - at create time and immutable thereafter; changing it on an existing service is rejected.' - disabled: - type: boolean - description: Indicates whether payload logging is disabled (opt-out). Unset means that payload logging is active - (the on-by-default state coincides with the proto zero-value, so the server never fills this field for a client - that leaves it unset). Set ``disabled = true`` to pause runtime logging while keeping the sub-message attached - (preserving ``parent`` and ``table_name_prefix`` for a later flip back to active). ``parent`` remains required - either way. + description: Parent Unity Catalog schema where the inference table is created, in the form ``schemas/{catalog}.{schema}``. + Required when configuring an inference table. After the inference table is created, this field cannot be changed. is_deleted: type: boolean - description: True when the bound inference TABLE has been deleted but the parent service still references it. The - dangling reference is surfaced (not silently dropped) so callers can see the broken dependency. AI Gateway payload - logging fails closed in this state. + description: Whether the referenced inference table has been deleted. The configuration remains visible so you can + identify the broken dependency. Payload logging cannot continue until the table is restored or the configuration + is updated. table: type: string description: 'Resolved UC table for payload logs. Format: ``tables/{catalog}.{schema}.{table}``.' table_name_prefix: type: string - description: Prefix for the inference-table's UC-registered name. The actual leaf name UC stores is ``_payload``; - the ``_payload`` suffix is appended automatically. To find the actual UC table after Create, read the ``table`` - field on the response. Defaults to ``_payload`` when unset. Set at create time and immutable - thereafter; changing it on an existing service is rejected. + description: Prefix used to form the inference table's registered name. AI Gateway appends ``_payload``; for example, + ``table_name_prefix = "orders"`` creates ``orders_payload``. If unset, the prefix defaults to the service name. + Read ``table`` from the response for the resulting resource name. After the inference table is created, this field + cannot be changed. required: - parent description: |- - Inference table configuration for payload logging on a model service. - - ``parent`` is always REQUIRED when the sub-message is set; the destination UC schema is needed - to construct or rebind the payload TABLE regardless of whether payload logging is currently - active. Payload logging is active by default; set ``disabled = true`` to pause runtime logging - without dropping the table or the binding. + Configuration for logging request and response payloads to a Unity Catalog inference table. When + this configuration is present, payload logging is enabled by default. ListAccountMetastoreAssignmentsResponse: type: object properties: @@ -3726,18 +3537,6 @@ components: $ref: '#/components/schemas/StorageCredentialInfo' description: An array of metastore storage credentials. description: The metastore storage credentials were successfully returned. - ListAgentServicesResponse: - type: object - properties: - agent_services: - type: array - items: - $ref: '#/components/schemas/AgentService' - description: The list of agent services. - next_page_token: - type: string - description: Pagination token for retrieving the next page of results. - description: Response for listing agent services. ListCatalogsResponse: type: object properties: @@ -3842,7 +3641,7 @@ components: description: The list of MCP services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: Pagination token for retrieving the next page. Empty when there are no more results. description: Response for listing MCP services. ListMetastoresResponse: type: object @@ -3865,7 +3664,7 @@ components: description: The list of model provider services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: Pagination token for retrieving the next page. Empty when there are no more results. description: Response for listing model provider services. ListModelServicesResponse: type: object @@ -3877,7 +3676,7 @@ components: description: The list of model services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: Pagination token for retrieving the next page. Empty when there are no more results. description: Response for listing model services. ListModelVersionsResponse: type: object @@ -3951,6 +3750,18 @@ components: $ref: '#/components/schemas/Secret' description: An array of secret objects. description: Response message for ListSecrets. + ListSkillsResponse: + type: object + properties: + next_page_token: + type: string + description: Pagination token for retrieving the next page of results. + skills: + type: array + items: + $ref: '#/components/schemas/Skill' + description: The list of skills. + description: Response for listing skills. ListStorageCredentialsResponse: type: object properties: @@ -4010,32 +3821,28 @@ components: McpService: type: object properties: - browse_only: - type: boolean - description: Whether the caller sees only metadata available through the BROWSE privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/McpServiceConfig' - description: 'Operational configuration: connection, tool selectors, rate limit. Required on CreateMcpService; on - UpdateMcpService it is required only when ``config`` (or a ``config.*`` subpath) appears in ``update_mask``.' + description: Connection, tool selectors, and rate limits. Required on Create. On Update, provide this field when + ``update_mask`` contains ``config`` or one of its subpaths. create_time: type: string format: date-time - description: When the MCP service was created. + description: Time the MCP service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: The resolved owner of the MCP service. Falls back to the caller's identity when ``owner`` is not explicitly - set on creation. + description: Owner of the MCP service. etag: type: string - description: Optimistic concurrency control token. Server-generated from the entity's state and returned on every - read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects the mutation if the stored etag differs. + description: Optimistic concurrency token returned on every read. To make an Update or Delete conditional, pass + the last-read value in that request's ``etag`` field. In REST responses, this value is a base64 string; URL-encode + it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the MCP service. @@ -4044,20 +3851,16 @@ components: description: '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.' - owner: - type: string - description: The owner of the MCP service. Write-only; read owner via effective_owner. update_time: type: string format: date-time - description: When the MCP service was last modified. + description: Time the MCP service was last modified. updated_by: type: string description: Identity of the last updater. description: |- - A governed MCP server registration in Unity Catalog. Acts as a container securable that - references an MCP server -- customer-external via a UC Connection, or Databricks-hosted via an - internal server -- and exposes its tools for discovery, authorization, and invocation. + A Unity Catalog securable that registers an MCP server through a Unity Catalog connection and + exposes its tools for discovery, authorization, and invocation. McpServiceConfig: type: object properties: @@ -4065,35 +3868,62 @@ components: type: array items: type: string - description: Glob or exact-match patterns selecting which tools from the MCP server to expose. Prefix match for - patterns with ``*``, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars. + description: Tool names or prefix patterns to expose from the MCP server. Use exact tool names or prefix patterns + such as ``read_*``. An empty list exposes all tools. At most 1,024 selectors are allowed, and each selector can + contain at most 256 characters. rate_limits: type: array items: $ref: '#/components/schemas/RateLimit' - description: Per-principal rate limits applied to tool invocations routed through this MCP service. Repeated to - support per-USER / USER_GROUP / SERVICE_PRINCIPAL / SERVICE / USER_DEFAULT scopes simultaneously, mirroring the - ``ModelServiceConfig.rate_limits`` shape. Empty when no rate limit is configured. + description: Rate limits for tool invocations. Supported scopes are user, group, service principal, the service + as a whole, and each user by default. Request and token limits are supported. Empty when no rate limit is configured. source_connection: $ref: '#/components/schemas/McpServiceConfigSourceConnection' - description: UC Connection referencing the MCP server. + description: Unity Catalog connection referencing the MCP server. Required on Create. description: |- Operational configuration for an MCP service. Groups the source reference, tool selectors, and - rate limit -- the fields that configure how the MCP service behaves at invocation time. + rate limits -- the fields that configure how the MCP service behaves at invocation time. McpServiceConfigSourceConnection: type: object properties: name: type: string + description: Resource name of the Unity Catalog connection used to access the MCP server, in the form ``connections/{catalog}.{schema}.{connection}``. is_deleted: type: boolean + description: Whether the referenced connection has been deleted. The MCP service keeps the reference so callers + can identify the broken dependency; tool invocation fails until the source connection is updated. + options: + type: object + description: 'Options needed to build the U2M authorize request, returned as a flat map. When set, it includes: + ``authorization_endpoint`` (OAuth authorize URL), ``token_endpoint`` (token-exchange URL), ``oauth_scope`` (space-separated + scopes to request), ``client_id`` (OAuth client id), and ``oauth_provider`` (the OAuth provider).' required: - name description: |- - UC Connection that hosts the MCP server. On create, provide ``name`` in the schema-scoped form - ``connections/{catalog}.{schema}.{connection}``. On read, the service populates the resolved - connection metadata and preserves a dangling source so callers can diagnose a deleted backing - connection. + Unity Catalog connection that points to the MCP server. On Create, provide ``name`` in the + schema-scoped form ``connections/{catalog}.{schema}.{connection}``. On read, the service + populates the resolved connection metadata. If the connection is deleted, its reference remains + visible so you can identify the broken dependency. + McpServiceUserMappedCredential: + type: object + properties: + options: + type: object + description: 'Token-expiry info for the credential, returned as a flat map: ``access_token_expiration`` (always + set) and ``refresh_token_expiration`` (set when the credential has a refresh token). Both values are timestamps.' + provisioning_info: + $ref: '#/components/schemas/ProvisioningInfo' + description: Provisioning state of the credential. ``ACTIVE`` means the caller is logged in and the credential is + usable; any other state means the login has not completed. + description: A caller's per-user OAuth credential for an MCP service. + McpServiceUserMappedCredentialLogin: + type: object + properties: + options: + type: object + description: 'OAuth exchange fields: ``pkce_verifier``, ``authorization_code``, and ``oauth_redirect_uri``.' + description: Login input for an MCP service user credential. Carries the OAuth exchange fields as a flat map. MetastoreAssignment: type: object properties: @@ -4172,33 +4002,28 @@ components: ModelProviderService: type: object properties: - browse_only: - type: boolean - description: Whether the caller sees only metadata available through the BROWSE privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/ModelProviderServiceConfig' - description: 'Behavioral configuration: provider connection, model catalog, and passthrough policy. See ``ModelProviderServiceConfig`` - for the per-field contract. Required on CreateModelProviderService; on Update it is required only when ``config`` - (or a ``config.*`` subpath) appears in ``update_mask``.' + description: Provider authentication, exposed models, request-forwarding controls, rate limits, and payload logging. + Required on Create. On Update, it is required only when ``config`` or one of its subpaths appears in ``update_mask``. create_time: type: string format: date-time - description: When the provider service was created. + description: Time the provider service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: The resolved owner of the model provider service. Falls back to the caller's identity when ``owner`` - is not explicitly set on creation. + description: Owner of the model provider service. etag: type: string - description: Optimistic concurrency control token. Server-generated from the entity's state and returned on every - read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects the mutation if the stored etag differs. + description: Optimistic concurrency token returned on every read. To make an Update or Delete conditional, pass + the last-read value in that request's ``etag`` field. In REST responses, this value is a base64 string; URL-encode + it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the provider service. @@ -4207,89 +4032,90 @@ components: description: '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.' - owner: - type: string - description: The owner of the model provider service. Write-only; read owner via effective_owner. update_time: type: string format: date-time - description: When the provider service was last modified. + description: Time the provider service was last modified. updated_by: type: string description: Identity of the last updater. description: |- - A governed external model-provider connection stored in Unity Catalog (e.g. an OpenAI API - account, an Azure OpenAI deployment, an Amazon Bedrock account). Owns the provider type and the - auth/configuration the platform needs to invoke that provider, and is referenced from - ``ExternalModelConfig.model_provider_service`` on a ModelService. - - One ModelProviderService can back many ModelServices (e.g. an ``openai_prod`` provider serving - multiple models); a single ModelService can fan out across multiple ModelProviderServices for - traffic split or failover. + A Unity Catalog securable that stores authentication and request configuration for an external + model provider, such as OpenAI, Azure OpenAI, or Amazon Bedrock. Model service destinations + reference it to send requests to that provider. + + A model provider service can be referenced by multiple model services. A model service can route + across multiple model provider services for traffic splitting or failover. ModelProviderServiceConfig: type: object properties: allow_all_targets: type: boolean - description: When true, accepts any model exposed by the upstream provider; ``targets`` is not required and does - not restrict routability. When false, only models listed in ``targets`` are routable. + description: When true, allows models from the provider's built-in model catalog in addition to explicit ``targets``. + When false, only models listed in ``targets`` are routable. Defaults to false. CUSTOM providers have no built-in + model catalog and must leave this false and list their models in ``targets``. amazon_bedrock: $ref: '#/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderConfig' anthropic: $ref: '#/components/schemas/ModelProviderServiceConfigAnthropicProviderConfig' azure_openai: $ref: '#/components/schemas/ModelProviderServiceConfigAzureOpenAiProviderConfig' + bedrock_mantle: + $ref: '#/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderConfig' custom: $ref: '#/components/schemas/ModelProviderServiceConfigCustomProviderConfig' forward_headers: type: boolean - description: Whether to forward incoming request headers to the upstream provider. Applies to managed (multi-model) - requests as well as passthrough requests served by this provider service. Governance-level decision by the provider - service owner; not selectable per inference call. + description: Whether to forward incoming HTTP headers to the upstream provider. Defaults to false and is configured + for the entire provider service, not per request. Upstream authentication is configured separately in the provider-specific + configuration. forward_query_parameters: type: boolean - description: Whether to forward incoming request query parameters to the upstream provider. Same trust-boundary - semantics as ``forward_headers``. + description: Whether to forward incoming query parameters to the upstream provider. Defaults to false and is configured + for the entire provider service, not per request. forward_unmanaged_paths: type: boolean - description: Whether to forward request paths that fall outside this service's managed API set to the upstream provider - as opaque passthrough. When true, requests addressed to subpaths not recognized by the managed API surface are - proxied to the upstream provider over the same provider connection. When false, only managed-API paths are served. - Governance-level decision by the provider service owner; expanding this expands the trust boundary that the ModelProviderService - exposes. + description: Whether to proxy paths that AI Gateway does not recognize as configured provider-native API types. + Defaults to false. When true, these paths are forwarded unchanged to the upstream provider. When false, only recognized + API paths are served. Enabling this broadens the upstream API surface exposed through the provider service. AI + Gateway cannot evaluate Service Policies on opaque unmanaged requests, so unmanaged requests are rejected whenever + Service Policies are attached to this securable. gemini_enterprise: $ref: '#/components/schemas/ModelProviderServiceConfigGeminiEnterpriseProviderConfig' inference_table: $ref: '#/components/schemas/InferenceTableConfig' - description: Inference table configuration for payload logging when this provider service is invoked directly. When - it is invoked through a model service, the model service's own inference table captures the invocation instead. - Mirrors ``ModelServiceConfig.inference_table`` / ``AgentServiceConfig.inference_table``. + description: Payload logging configuration for requests sent directly to this provider service. Requests routed + through a model service are captured by that model service's inference table instead. microsoft_foundry: $ref: '#/components/schemas/ModelProviderServiceConfigMicrosoftFoundryProviderConfig' openai: $ref: '#/components/schemas/ModelProviderServiceConfigOpenAiProviderConfig' + pricing: + $ref: '#/components/schemas/ModelProviderServiceConfigProviderPricingConfig' + description: Pricing configuration for this provider service. An explicitly empty configuration is retained on Create + and Update and applies no adjustment. provider_type: $ref: '#/components/schemas/ModelProviderServiceConfigExternalModelProviderType' - description: Provider type discriminator. Required at create time; immutable after. Determines which variant of - the ``provider`` oneof must be set. May not be changed via Update; attempts to include ``config.provider_type`` - in ``UpdateModelProviderServiceRequest.update_mask`` are rejected. Required on CreateModelProviderService and - immutable thereafter. + description: External model provider. Required on Create and immutable thereafter. Set the matching provider-specific + configuration, such as ``openai``, ``azure_openai``, or ``amazon_bedrock``. rate_limits: type: array items: $ref: '#/components/schemas/RateLimit' - description: Rate limits applied when this provider service is invoked directly. When it is invoked through a model - service, the model service's own ``rate_limits`` apply instead. Mirrors ``ModelServiceConfig.rate_limits`` / ``McpServiceConfig.rate_limits``. + description: Rate limits for requests sent directly to this provider service. Requests routed through a model service + use that model service's rate limits instead. targets: type: array items: $ref: '#/components/schemas/ModelProviderServiceConfigModelTargetConfig' - description: Routing targets this provider service exposes (provider-side model identifier + unified API types per - entry). Required (>=1) when ``allow_all_targets = false``; optional and additive when ``allow_all_targets = true``. - References from ``ExternalModelConfig.target`` must match an entry here unless ``allow_all_targets = true``. + description: Models and provider-native API types exposed by this provider service. Each entry must include at least + one ``native_api_types`` value. When ``allow_all_targets`` is false, at least one entry is required and model + service destinations can reference only listed models. When ``allow_all_targets`` is true, models from the provider's + built-in model catalog are also routable. CUSTOM providers must explicitly list their models here and cannot enable + ``allow_all_targets``. description: |- - Behavioral configuration for a ModelProviderService: provider connection (auth + - provider-specific fields), the catalog of models this provider service can route to, and the + Behavioral configuration for a ModelProviderService: provider authentication and + provider-specific fields, the catalog of models this provider service can route to, and the passthrough policy that governs how request headers, query parameters, and unmanaged subpaths cross the trust boundary to the upstream provider. ModelProviderServiceConfigAmazonBedrockProviderConfig: @@ -4297,33 +4123,24 @@ components: properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderDirectConfig' + description: Amazon Bedrock region and authentication configuration. description: Amazon Bedrock provider configuration. ModelProviderServiceConfigAmazonBedrockProviderDirectConfig: type: object properties: aws_access_key: $ref: '#/components/schemas/ModelProviderServiceConfigAwsAccessKey' - description: AWS access-key-pair auth. Mutually exclusive with ``service_credential``. Supersedes the flat ``aws_access_key_id`` - / ``aws_secret_access_key`` fields. - aws_access_key_id: - type: string - description: 'Deprecated flat AWS access key ID. Superseded by ``aws_access_key.access_key_id``. Kept for one migration - cycle; the handler mirrors it to/from ``aws_access_key``. Treated as username-equivalent (not a secret value): - round-trips on reads and is scrubbed from audit logs.' - aws_secret_access_key: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Deprecated flat AWS secret access key. Superseded by ``aws_access_key.secret_access_key``. Kept for - one migration cycle; the handler mirrors it to/from ``aws_access_key``. Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: AWS access-key-pair authentication. Set ``access_key_id`` and ``secret_access_key.plaintext``. Mutually + exclusive with ``service_credential``. region: type: string description: AWS region where the Bedrock endpoint is hosted (e.g., ``us-east-1``). Required on Create. service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' - description: Reference to a UC service credential authorizing Bedrock requests. On Create the caller supplies ``service_credential.name`` - in the AIP-122 resource-name form ``credentials/{name}``. Required on Create when using UC-service-credential - auth; mutually exclusive with ``aws_access_key``. The credential is referenced by name; its value is not carried - here. On read the resolved ``id`` and ``is_deleted`` are also populated. Only supported on AWS-hosted workspaces; - Create requests from other clouds are rejected with INVALID_PARAMETER_VALUE. + description: Reference to a Unity Catalog service credential authorizing Bedrock requests. On Create, supply ``service_credential.name`` + in the form ``credentials/{name}``. Required on Create when using service-credential authentication; mutually + exclusive with ``aws_access_key``. The credential is referenced by name; its value is not carried here. Only supported + on AWS-hosted workspaces. description: |- Direct form of Amazon Bedrock provider config. @@ -4331,21 +4148,21 @@ components: Create: - Access keys: set ``aws_access_key``, leave ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form - ``credentials/{name}``, leave ``aws_access_key`` unset. The credential value lives in UC and - is referenced by name, not held on this message. Setting more than one mode is rejected. + - Unity Catalog service credential: set ``service_credential.name`` to the resource name + ``credentials/{name}``, leave ``aws_access_key`` unset. The credential value lives in Unity + Catalog and is referenced by name, not held on this message. Setting more than one mode is + rejected. ModelProviderServiceConfigAnthropicProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigAnthropicProviderDirectConfig' - description: 'Direct (inline-credentials) form: caller supplies the API key in the request body. Required on Create - unless ``relayed`` is set.' + description: Direct authentication with an API key supplied in ``direct.api_key.plaintext``. Required unless ``relayed`` + is set. relayed: $ref: '#/components/schemas/ModelProviderServiceConfigAnthropicProviderRelayedConfig' - description: 'Relayed (credential-less) form: no Anthropic credential is stored. Each inference request instead - carries the caller''s own OAuth token, which the platform forwards to Anthropic on outbound requests. Mutually - exclusive with ``direct``; no ``api_key`` is required or persisted.' + description: Relayed authentication. Each inference request supplies the caller's OAuth token, which is forwarded + to Anthropic. No Anthropic credential is stored. Mutually exclusive with ``direct``. description: |- Anthropic provider configuration. Exactly one of ``direct`` or ``relayed`` must be set on Create; the two are mutually exclusive. @@ -4354,21 +4171,14 @@ components: properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Anthropic API key. Required on Create. Sent as the ``x-api-key`` header on outbound requests. Supplied - as inline plaintext via ``ProviderSecret.plaintext``. + description: Anthropic API key. Required when creating the service. Supply the value in ``api_key.plaintext``. description: Direct form of Anthropic provider config. ModelProviderServiceConfigAnthropicProviderRelayedConfig: type: object - properties: - plan_type: - $ref: '#/components/schemas/ModelProviderServiceConfigAnthropicProviderRelayedConfigAnthropicRelayedPlanType' - description: Which Anthropic subscription tier the relayed token belongs to. Optional; when unset the MPS gets the - full governance surface (see TEAM_ENTERPRISE). Immutable after Create, so the tier cannot be flipped in place. + properties: {} description: |- - Relayed form of Anthropic provider config: no credential is stored. Authentication is the - caller's own OAuth token, forwarded to Anthropic on outbound requests, so there is no persisted - secret. Presence of this variant is the signal that the provider service uses relayed auth; - ``plan_type`` further distinguishes which Anthropic subscription tier the token belongs to. + Relayed Anthropic provider configuration. Each inference request supplies the caller's OAuth + token, which is forwarded to Anthropic. No Anthropic credential is stored. ModelProviderServiceConfigAwsAccessKey: type: object properties: @@ -4378,49 +4188,36 @@ components: a secret value): round-trips on reads and is scrubbed from audit logs.' secret_access_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: AWS secret access key paired with ``access_key_id``. Required on Create when using access-key auth. - Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: AWS secret access key paired with ``access_key_id``. Required when creating a service with access-key + authentication. Supply the value in ``secret_access_key.plaintext``. description: 'AWS access-key-pair auth for Amazon Bedrock: a SigV4-signing key pair.' ModelProviderServiceConfigAzureOpenAiProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigAzureOpenAiProviderDirectConfig' + description: Azure OpenAI endpoint and authentication configuration. description: Azure OpenAI provider configuration. ModelProviderServiceConfigAzureOpenAiProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Azure OpenAI API key. Mutually exclusive with the Entra and service-credential modes. Supplied as inline - plaintext via ``ProviderSecret.plaintext``. + description: Azure OpenAI API key. Supply the value in ``api_key.plaintext``. Mutually exclusive with Entra ID and + Unity Catalog service credential authentication. base_url: type: string description: Full Azure OpenAI endpoint base URL, e.g. ``https://myresource.openai.azure.com``. Required on Create. - client_id: - type: string - description: Deprecated flat Entra client ID. Superseded by ``entra_service_principal.client_id``. Kept for one - migration cycle; the handler mirrors it to/from ``entra_service_principal``. - client_secret: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Deprecated flat Entra client secret. Superseded by ``entra_service_principal.client_secret``. Kept - for one migration cycle; the handler mirrors it to/from ``entra_service_principal``. Supplied as inline plaintext - via ``ProviderSecret.plaintext``. entra_service_principal: $ref: '#/components/schemas/ModelProviderServiceConfigEntraServicePrincipal' - description: Entra ID (service principal) auth. Mutually exclusive with ``api_key`` and ``service_credential``. - Supersedes the flat ``tenant_id`` / ``client_id`` / ``client_secret`` fields. + description: Entra ID service-principal authentication. Set ``tenant_id``, ``client_id``, and ``client_secret.plaintext``. + Mutually exclusive with ``api_key`` and ``service_credential``. service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' - description: Reference to a UC service credential authorizing Azure OpenAI requests. On Create the caller supplies - ``service_credential.name`` in the AIP-122 resource-name form ``credentials/{name}``. Required on Create when - using UC-service-credential auth; mutually exclusive with ``api_key`` and ``entra_service_principal``. The credential - is referenced by name; its value is not carried here. On read the resolved ``id`` and ``is_deleted`` are also - populated. Only supported on Azure-hosted workspaces; Create requests from other clouds are rejected with INVALID_PARAMETER_VALUE. - tenant_id: - type: string - description: Deprecated flat Entra tenant ID. Superseded by ``entra_service_principal.tenant_id``. Kept for one - migration cycle; the handler mirrors it to/from ``entra_service_principal``. + description: Reference to a Unity Catalog service credential authorizing Azure OpenAI requests. On Create, supply + ``service_credential.name`` in the form ``credentials/{name}``. Required on Create when using service-credential + authentication; mutually exclusive with ``api_key`` and ``entra_service_principal``. The credential is referenced + by name; its value is not carried here. Only supported on Azure-hosted workspaces. description: |- Direct form of Azure OpenAI provider config. Exactly one of three mutually-exclusive auth modes must be supplied on Create: @@ -4428,36 +4225,48 @@ components: - API key: set ``api_key``, leave ``entra_service_principal`` and ``service_credential`` unset. - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form + - Unity Catalog service credential: set ``service_credential.name`` to the resource name ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. + credential value lives in Unity Catalog and is referenced by name, not held on this message. + Only supported on Azure-hosted workspaces. Setting more than one mode is rejected. + ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth: + type: object + properties: + api_key_name: + type: string + description: HTTP header name that carries the API key on outbound requests (e.g., ``Ocp-Apim-Subscription-Key``). + The value forwarded under this header is supplied via ``api_key_value``. + api_key_value: + $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' + description: Secret value forwarded under the ``api_key_name`` header on outbound requests. Supplied as inline plaintext + via ``ProviderSecret.plaintext``. + description: |- + Header-based API-key authentication for a custom provider: the secret is forwarded on outbound + requests under a caller-chosen HTTP header, as ``: ``. ModelProviderServiceConfigCustomProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigCustomProviderDirectConfig' - description: 'Custom provider configuration: arbitrary HTTP endpoint with bearer-token auth.' + description: Endpoint and authentication configuration for the custom provider. + description: Custom OpenAI-compatible provider configuration. ModelProviderServiceConfigCustomProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: 'Bearer token forwarded as the ``Authorization: Bearer ...`` header on outbound requests. Supplied - as inline plaintext via ``ProviderSecret.plaintext``. Set this for bearer-token auth.' + description: Bearer token forwarded in the ``Authorization`` header. Supply the value in ``api_key.plaintext``. base_url: type: string description: Endpoint URL of the OpenAI-compatible service (e.g., ``https://api.example.com/v1``). Required on Create. + header_auth: + $ref: '#/components/schemas/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth' + description: 'Header-based API-key auth: the secret is forwarded on outbound requests under a caller-chosen HTTP + header rather than as an ``Authorization`` bearer token. Set this instead of ``api_key`` for header auth.' description: |- - Direct form of custom provider config. - - Authentication is one of two mutually exclusive modes, exactly one of which must be supplied on - Create: - - - Bearer: set ``api_key``, leave ``header_auth`` unset. The secret is forwarded as - ``Authorization: Bearer ``. - - Header: set ``header_auth``, leave ``api_key`` unset. The secret is forwarded as - ``: ``. Setting both modes or neither mode is rejected. + Direct form of a custom provider configuration. Set ``api_key`` to send the secret as an + ``Authorization`` bearer token, or ``header_auth`` to forward it under a caller-chosen HTTP + header. ModelProviderServiceConfigEntraServicePrincipal: type: object properties: @@ -4466,74 +4275,69 @@ components: description: Entra ID client (application) ID. Required on Create. client_secret: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Entra ID client secret. Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: Entra ID client secret. Supply the value in ``client_secret.plaintext``. tenant_id: type: string description: Entra ID (Azure AD) tenant ID. Required on Create. description: |- - Entra ID (Azure AD) service-principal auth: AI Gateway exchanges the ``tenant_id`` + - ``client_id`` identify the service principal, and the ``credential`` oneof proves that identity, - exchanged for an Entra bearer token on outbound requests via the OAuth2 client-credentials - grant. Shared by the Azure OpenAI and Microsoft Foundry provider configs. + Entra ID (Azure AD) service-principal authentication. The ``tenant_id`` and ``client_id`` + identify the service principal, and ``client_secret`` authenticates it. AI Gateway exchanges + these credentials for an Entra bearer token for requests to Azure OpenAI or Microsoft Foundry. ModelProviderServiceConfigGeminiEnterpriseProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig' + description: Gemini Enterprise project, region, and authentication configuration. description: Gemini Enterprise provider configuration. ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Google Gemini Enterprise API key. Required on Create. Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: Google Gemini Enterprise API key. Required when creating the service. Supply the value in ``api_key.plaintext``. project_id: type: string description: GCP project ID hosting the Gemini Enterprise endpoint. Required on Create. region: type: string description: GCP region of the Gemini Enterprise endpoint (e.g., ``us-central1``). Required on Create. - description: Direct form of Gemini Enterprise provider config. + service_credential: + $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' + description: Reference to a Unity Catalog service credential authorizing Gemini Enterprise requests. On Create, + supply ``service_credential.name`` as ``credentials/{name}``; required when using service-credential authentication + and mutually exclusive with ``api_key``. The credential is referenced by name; its value is not carried here. + On read, the resolved ``id`` and ``is_deleted`` are also populated. Supported only on GCP-hosted workspaces. + description: |- + Direct Gemini Enterprise provider configuration. An API key is required when creating the + service. ModelProviderServiceConfigMicrosoftFoundryProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig' + description: Microsoft Foundry endpoint and authentication configuration. description: Microsoft Foundry provider configuration. ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Microsoft AI Foundry API key. Mutually exclusive with the Entra and service-credential modes. Supplied - as inline plaintext via ``ProviderSecret.plaintext``. + description: Microsoft Foundry API key. Supply the value in ``api_key.plaintext``. Mutually exclusive with Entra + ID and Unity Catalog service credential authentication. base_url: type: string - description: Microsoft AI Foundry endpoint URL. Required on Create. - client_id: - type: string - description: Deprecated flat Entra client ID. Superseded by ``entra_service_principal.client_id``. Kept for one - migration cycle; the handler mirrors it to/from ``entra_service_principal``. - client_secret: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: Deprecated flat Entra client secret. Superseded by ``entra_service_principal.client_secret``. Kept - for one migration cycle; the handler mirrors it to/from ``entra_service_principal``. Supplied as inline plaintext - via ``ProviderSecret.plaintext``. + description: Microsoft Foundry endpoint URL. Required on Create. entra_service_principal: $ref: '#/components/schemas/ModelProviderServiceConfigEntraServicePrincipal' - description: Entra ID (service principal) auth. Mutually exclusive with ``api_key`` and ``service_credential``. - Supersedes the flat ``tenant_id`` / ``client_id`` / ``client_secret`` fields. + description: Entra ID service-principal authentication. Set ``tenant_id``, ``client_id``, and ``client_secret.plaintext``. + Mutually exclusive with ``api_key`` and ``service_credential``. service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' - description: Reference to a UC service credential authorizing Microsoft Foundry requests. On Create the caller supplies - ``service_credential.name`` in the AIP-122 resource-name form ``credentials/{name}``. Required on Create when - using UC-service-credential auth; mutually exclusive with ``api_key`` and ``entra_service_principal``. The credential - is referenced by name; its value is not carried here. On read the resolved ``id`` and ``is_deleted`` are also - populated. Only supported on Azure-hosted workspaces; Create requests from other clouds are rejected with INVALID_PARAMETER_VALUE. - tenant_id: - type: string - description: Deprecated flat Entra tenant ID. Superseded by ``entra_service_principal.tenant_id``. Kept for one - migration cycle; the handler mirrors it to/from ``entra_service_principal``. + description: Reference to a Unity Catalog service credential authorizing Microsoft Foundry requests. On Create, + supply ``service_credential.name`` in the form ``credentials/{name}``. Required on Create when using service-credential + authentication; mutually exclusive with ``api_key`` and ``entra_service_principal``. The credential is referenced + by name; its value is not carried here. Only supported on Azure-hosted workspaces. description: |- Direct form of Microsoft Foundry provider config. @@ -4544,40 +4348,49 @@ components: - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and ``service_credential`` unset. AI Gateway exchanges these for an Entra bearer token on outbound requests via the OAuth2 client-credentials grant. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form + - Unity Catalog service credential: set ``service_credential.name`` to the resource name ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. + credential value lives in Unity Catalog and is referenced by name, not held on this message. + Only supported on Azure-hosted workspaces. Setting more than one mode is rejected. ModelProviderServiceConfigModelTargetConfig: type: object properties: model: type: string - description: Provider-side model identifier (e.g. "gpt-5", "claude-opus-4-7"). This is a string on the LLM provider's - side, not a UC entity. The UC governance hook for external destinations is the ModelProviderService referenced - by ``ExternalModelConfig.model_provider_service``, not the model itself. + description: Provider-side model identifier, such as ``gpt-5`` or ``claude-opus-4-7``. This identifies a model at + the upstream provider; it is not a Unity Catalog model resource. + endpoint_route: + type: string + description: Relative path appended to a custom provider's ``base_url`` for this model, such as ``serve/openai/chat``. + Nonempty values are only supported for custom model provider service targets; other provider types reject them. + Model service destinations do not support this field. Do not include URI templates, queries, or fragments. When + empty, ``base_url`` is used unchanged. native_api_types: type: array items: type: string - description: Provider-native API types the model supports (e.g. "openai/v1/chat/completions"). Used by the platform - for request/response translation from the unified API type. At most 64 entries of at most 256 characters each; - the list is persisted into the destination binding's bounded storage envelope. + description: Provider-native API types supported by this model, such as ``openai/v1/chat/completions``. A model + provider service target requires at least one value. A model service destination may omit the list to use the + matching provider service target's types when available. AI Gateway uses the selected types for translation. At + most 64 entries of 256 characters each are allowed. required: - model - description: Model target configuration for an external model destination. + description: |- + Model target configuration shared by model provider service targets and external model + destinations on model services. ModelProviderServiceConfigOpenAiProviderConfig: type: object properties: direct: $ref: '#/components/schemas/ModelProviderServiceConfigOpenAiProviderDirectConfig' + description: OpenAI configuration with an API key supplied in the request. description: OpenAI provider configuration. ModelProviderServiceConfigOpenAiProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: OpenAI API key. Required on Create. Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: OpenAI API key. Required when creating the service. Supply the value in ``api_key.plaintext``. base_url: type: string description: Optional custom base URL. Defaults to ``https://api.openai.com/v1``. Use for OpenAI-API-compatible @@ -4587,60 +4400,82 @@ components: description: Optional OpenAI organization ID. When set, the platform forwards it as the ``OpenAI-Organization`` header. description: Direct (inline-credentials) form of the OpenAI provider config. + ModelProviderServiceConfigProviderPricingConfig: + type: object + properties: + default_discount_basis_points: + type: integer + description: 'Provider-wide adjustment to external-model spend estimates in basis points: 2000 = 20% off; -2000 + = a 20% markup. Negative values have no lower bound beyond the int32 range. Values cannot exceed 10000 (100% off). + An omitted value or zero leaves the estimate unchanged.' + description: Pricing adjustments applied to this provider service's external-model spend estimates. ModelProviderServiceConfigProviderSecret: type: object properties: plaintext: type: string description: 'Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses - omit ``plaintext``; the field''s presence in the read shape only indicates that a secret is configured.' + omit ``plaintext``; the enclosing secret object remains present to indicate that a secret is configured.' + secret_reference: + $ref: '#/components/schemas/ModelProviderServiceConfigSecretReference' + description: Reference to a customer-owned UC Secret that carries this secret value. The value is read at invoke + time under the model provider service owner's access and is never copied onto the model provider service, so rotating + the UC Secret takes effect with no change to the model provider service. On Create, supply ``secret_reference.name`` + as ``secrets/{catalog}.{schema}.{secret}``. description: |- A secret value supplied as part of an inline provider config. The caller supplies the value as inline ``plaintext`` on writes; the platform stores it encrypted. The ``plaintext`` field is ``INPUT_ONLY`` and never round-trips on reads. - ModelProviderServiceConfigServiceCredential: + ModelProviderServiceConfigSecretReference: type: object properties: name: type: string - description: Resource name of the bound UC service credential, in the AIP-122 form ``credentials/{name}`` (a metastore-level - single-part credential name). On create the caller supplies the name here. On read it reflects the credential's - current name at read time. + description: Resource name of the bound UC Secret, in the form ``secrets/{catalog}.{schema}.{secret}``. On Create + the caller supplies the name here. On read it reflects the secret's current name at read time. required: - name description: |- - ---- Provider configuration (nested; see the ``provider`` oneof below) ---- The customer-owned - UC service credential a ModelProviderService uses to authenticate to its provider, referenced by + Reference to a customer-owned UC Secret backing a secret-bearing provider field, in the + ``ProviderSecret.secret_reference`` arm. + ModelProviderServiceConfigServiceCredential: + type: object + properties: + name: + type: string + description: Resource name of the bound Unity Catalog service credential, in the form ``credentials/{name}``. Supply + this field when creating the service or rebinding its credential. On read, it reflects the credential's current name. + required: + - name + description: |- + The customer-owned Unity Catalog service credential a model provider service uses to + authenticate to its provider, referenced by name. ModelService: type: object properties: - browse_only: - type: boolean - description: Whether the caller sees only metadata available through the BROWSE privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/ModelServiceConfig' - description: 'Operational configuration: destinations, routing, rate limits, inference table. Required on CreateModelService; - on UpdateModelService it is required only when ``config`` (or a ``config.*`` subpath) appears in ``update_mask``.' + description: Destinations, routing, rate limits, and payload logging configuration. Required on Create. On Update, + provide this field when ``update_mask`` contains ``config`` or one of its subpaths. create_time: type: string format: date-time - description: When the model service was created. + description: Time the model service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: The resolved owner of the ModelService. Falls back to the caller's identity when ``owner`` is not explicitly - set on creation. + description: Owner of the model service. etag: type: string - description: Optimistic concurrency control token. Server-generated from the entity's state and returned on every - read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects the mutation if the stored etag differs. + description: Optimistic concurrency token returned on every read. To make an Update or Delete conditional, pass + the last-read value in that request's ``etag`` field. In REST responses, this value is a base64 string; URL-encode + it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the model service. @@ -4649,33 +4484,29 @@ components: description: 'Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. Each ``{...}`` component is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``model_service_id``; required and immutable on Update/Get/Delete.' - owner: - type: string - description: The owner of the model service. Write-only; read owner via effective_owner. supported_api_types: type: array items: type: string - description: Unified API types this endpoint supports (e.g. "chat", "embeddings", "completions"). Derived from the - destinations' backing models / providers at read time. + description: API types supported across this service's destinations, such as ``openai/v1/chat/completions``, ``openai/v1/embeddings``, + and ``mlflow/v1/chat/completions``. Derived from the backing models and providers at read time. update_time: type: string format: date-time - description: When the model service was last modified. + description: Time the model service was last modified. updated_by: type: string description: Identity of the last updater. description: |- A governed AI Gateway endpoint in Unity Catalog that routes inference requests to one or more - model destinations (for example a foundation model or an external LLM reached through a - ModelProviderService). Applies centralized access control, rate limits, guardrails, and auditing - to the traffic it serves. + destinations, such as a Databricks foundation model or an external model reached through a model + provider service. Applies centralized access control, rate limits, and auditing to its traffic. ModelServiceConfig: type: object properties: inference_table: $ref: '#/components/schemas/InferenceTableConfig' - description: Inference table config for payload logging. + description: Inference table configuration for payload logging. rate_limits: type: array items: @@ -4683,7 +4514,7 @@ components: description: Rate limits applied to requests routed through this model service. routing: $ref: '#/components/schemas/ModelServiceConfigRoutingConfig' - description: 'Routing configuration: destinations, routing strategy, and fallback.' + description: 'Routing configuration: destinations and fallback.' description: Operational configuration wrapped around the ModelService resource. ModelServiceConfigDestinationConfig: type: object @@ -4693,22 +4524,27 @@ components: description: User-facing label for this destination, used in routing references. destination_type: $ref: '#/components/schemas/ModelServiceConfigDestinationConfigDestinationType' - description: Backing-model category. Determines which oneof variant is populated. + description: Backing-model category. Provide the matching type-specific configuration and leave the other type-specific + configurations unset. external_model_config: $ref: '#/components/schemas/ModelServiceConfigExternalModelConfig' + description: Configuration for an external model reached through a model provider service. is_deleted: type: boolean - description: True when the destination's backing UC entity (MODEL for foundation-model destinations, MODEL_PROVIDER_SERVICE - for external destinations) has been deleted but the destination row still references it. The dangling destination - is surfaced (not silently dropped) so callers can see the broken routing. Inference traffic through this destination - fails closed (BAD_REQUEST / FAILED_PRECONDITION). + description: Whether the destination's backing model or model provider service has been deleted. The destination + remains visible so you can identify the broken dependency. Requests cannot use this destination until the backing + resource is restored or the destination is replaced. pay_per_token_config: $ref: '#/components/schemas/ModelServiceConfigPayPerTokenConfig' + description: Configuration for a pay-per-token Databricks foundation model. provisioned_throughput_config: $ref: '#/components/schemas/ModelServiceConfigProvisionedThroughputConfig' + description: Configuration for a provisioned-throughput Databricks foundation model. traffic_percentage: type: integer - description: Share of traffic sent to this destination, 0-100. Optional on fallback destinations; see FallbackConfig. + description: Percentage of primary traffic sent to this destination, from 0 to 100. Required when there is more + than one primary destination, in which case the primary percentages must sum to 100; a single primary destination + receives all traffic. Fallback destinations are ordered and do not use this field. required: - name - destination_type @@ -4742,17 +4578,16 @@ components: type: array items: $ref: '#/components/schemas/ModelServiceConfigDestinationConfig' - description: Ordered list of fallback destinations. Traversal is in list order; the attempt count is the length - of the list. At most 5 are allowed. + description: Fallback destinations, tried in the listed order. At most 5 are allowed. description: |- - Fallback routing, applied after the primary destination returns a retryable error. Traversal is - in list order; the attempt count is the length of the list. + Fallback routing applied after a primary destination fails. Fallback destinations are tried in + the listed order. ModelServiceConfigPayPerTokenConfig: type: object properties: model: type: string - description: 'Resource name of the UC model. Format: ``models/{catalog}.{schema}.{model}``.' + description: 'Resource name of the Unity Catalog model. Format: ``models/{catalog}.{schema}.{model}``.' required: - model description: |- @@ -4763,10 +4598,10 @@ components: properties: model_serving_endpoint: type: string - description: Name of the backing Model Serving endpoint serving the provisioned- throughput foundation model, as - the AIP-122 typed resource name ``serving-endpoints/{name}``. The same UC model can be served on multiple Model - Serving endpoints (different throughput / region / config); the caller picks which one this destination routes - to. The endpoint must exist at create time. + description: Name of the backing Model Serving endpoint serving the provisioned- throughput foundation model, in + the form ``serving-endpoints/{name}``. The same Unity Catalog model can be served on multiple Model Serving endpoints + with different throughput, regions, or configurations. The caller selects the endpoint to which this destination + routes. The endpoint must exist at create time. model: type: string description: UC model FQN of the model served by the backing endpoint (e.g., ``system.ai.databricks-claude-opus-4-6``). @@ -4784,30 +4619,16 @@ components: type: array items: $ref: '#/components/schemas/ModelServiceConfigDestinationConfig' - description: Primary routing destinations. At most 10 are allowed. At least one is required on CreateModelService; - on UpdateModelService it is required only when ``config.routing`` (or a ``config.routing.*`` subpath) appears - in ``update_mask``. + description: Primary routing destinations. At most 10 are allowed. At least one is required on Create. On Update, + provide this list when replacing the full ``config`` or updating ``config.routing.destinations``; other granular + routing updates do not require resending destinations. The intermediate ``config.routing`` mask path is not supported. fallback: $ref: '#/components/schemas/ModelServiceConfigFallbackConfig' - description: Fallback routing config, applied after primary destinations fail. - first_token_timeout: - type: string - description: Timeout for the first token of a streaming response. If a destination does not return its first token - within this duration, AI Gateway aborts the attempt and fails over to the next destination. Applies to streaming - requests only. Leave unset for no first-token timeout. - traffic_splitting: - $ref: '#/components/schemas/ModelServiceConfigRoutingConfigTrafficSplitting' - description: Marker message selecting request-based traffic splitting. Traffic is distributed according to each - destination's traffic_percentage value; no configuration lives on this message itself. - description: |- - Routing configuration for a model service, nesting destinations, routing strategy, and fallback - under a single sub-message. - ModelServiceConfigRoutingConfigTrafficSplitting: - type: object - properties: {} + description: Fallback routing applied after a primary destination fails. Fallback destinations are tried in the + listed order. description: |- - Marker message selecting request-based traffic splitting across primary destinations. Split - weights are read from each DestinationConfig.traffic_percentage. + Routing configuration for a model service, nesting destinations and fallback under a single + sub-message. ModelVersionInfo: type: object properties: @@ -5116,32 +4937,6 @@ components: The special destination cannot be assigned to a securable and only represents the default destination of the securable. The securable types that support default special destinations are: "catalog", "external_location", "connection", "credential", and "metastore". The **destination_type** of a **special_destination** is always EMAIL.' - OneLakeEventQueue: - type: object - properties: - consumer_group: - type: string - description: 'Event Hubs consumer group used to consume file events. Defaults to "$Default" when unset. Recommended - for provided_onelake: create a dedicated consumer group on the Event Hub for file events to avoid contending with - the customer''s other consumers.' - event_hub_name: - type: string - description: Event Hub entity name within the namespace. Only required for provided_onelake. - event_hub_url: - type: string - description: 'The Event Hub URL in the format https://{namespace}.servicebus.windows.net/{event_hub_name}. Deprecated: - use fully_qualified_namespace + event_hub_name instead.' - fully_qualified_namespace: - type: string - description: The fully qualified domain name of the Event Hubs namespace, e.g. {yournamespace}.servicebus.windows.net. - Only required for provided_onelake. - managed_resource_id: - type: string - description: Unique identifier included in the name of the file events managed resources. - description: |- - File event queue for OneLake (Microsoft Fabric) locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). OnlineTable: type: object properties: @@ -5228,10 +5023,6 @@ components: type: string description: For drop down / radio button selections, UI will want to know the possible input values, it can also be used by other option types to limit input selections. - conditional_display: - $ref: '#/components/schemas/ConditionalDisplay' - description: Conditional display configuration. Specifies when this option should be hidden based on another option's - value. default_value: type: string description: The default value of the option, for example, value '443' for 'port' option. @@ -5287,12 +5078,6 @@ components: type: string description: The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time. - principal_id: - type: integer - description: An opaque internal ID that identifies the principal whose privileges should be removed. This field - is intended for removing privileges associated with a deleted user. When set, only the entries specified in the - remove field are processed; any entries in the add field will be rejected. Only one of principal or principal_id - should be specified, never both at the same time. remove: type: array items: @@ -5339,8 +5124,7 @@ components: type: string for_securable_type: $ref: '#/components/schemas/SecurableType' - description: Type of securables that the policy should take effect on. Only ``TABLE`` is supported at this moment. - Required on create and optional on update. + description: Type of securables that the policy should take effect on. Required on create and optional on update. policy_type: $ref: '#/components/schemas/PolicyType' description: Type of the policy. Required on create. @@ -5367,6 +5151,12 @@ components: items: type: string description: Optional list of user or group names that should be excluded from the policy. + governed_tags: + type: array + items: + $ref: '#/components/schemas/GovernedTagReference' + description: Governed tag keys and values referenced by this policy's conditions and function arguments. Output + only. grant: $ref: '#/components/schemas/GrantOptions' description: Options for grant policies. Valid only if ``policy_type`` is ``POLICY_TYPE_GRANT``. Required on create @@ -5402,13 +5192,6 @@ components: updated_by: type: string description: Username of the user who last modified the policy. Output only. - use_session_identity: - type: boolean - description: Temporary for migrating customers to session identity. Customers not currently using ABAC will not - be able to set this field to false and all new policies will have this field default to true. Existing customers - will have this field default to false, but can set it to true to opt in to session identity. after a grace period, - this field will be removed and all policies will use session identity. Only for row filter and column mask policies. - Not applicable to deny policies. when_condition: type: string description: Optional condition when the policy should take effect. @@ -5449,10 +5232,6 @@ components: properties: principal: type: string - principal_id: - type: integer - description: Unique identifier of the principal. For active principals, both ``principal`` and ``principal_id`` - are present. privileges: type: array items: @@ -5515,30 +5294,23 @@ components: properties: key: $ref: '#/components/schemas/RateLimitRateLimitKey' - description: Scope key. Determines whether ``principal`` is required. + description: Scope of the rate limit. Depending on this value, the limit applies to a principal, the service as + a whole, or each user by default. renewal_period: $ref: '#/components/schemas/RateLimitRateLimitRenewalPeriod' description: Renewal period. principal: type: string description: 'Principal this limit applies to: user email, group name, or service principal application ID. Required - unless ``key`` is ``RATE_LIMIT_KEY_SERVICE``, ``RATE_LIMIT_KEY_USER_DEFAULT``, or ``RATE_LIMIT_KEY_REQUEST_TAG`` - (which must not set a principal).' - request_tag_key: - type: string - description: Request tag key this limit applies to. Required when ``key`` is ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: Request tag value this limit applies to. Only valid when ``key`` is ``RATE_LIMIT_KEY_REQUEST_TAG``. - Leave unset to apply the limit to every value of ``request_tag_key`` (an any-value default); a set value is a - specific override for that value. + when ``key`` applies to a user, group, or service principal; otherwise it must be unset.' requests: type: integer - description: Max requests allowed within a renewal period. Leave unset for no request limit. + description: Maximum requests allowed in one renewal period. Leave unset for no request limit. Set to ``0`` to deny + all requests. tokens: type: integer - description: Max tokens allowed within a renewal period. Leave unset for no token limit. + description: Maximum tokens allowed in one renewal period. Leave unset for no token limit. Set to ``0`` to deny + all requests. required: - key - renewal_period @@ -5757,15 +5529,6 @@ components: A secret stored in Unity Catalog. Secrets are three-level namespace objects (catalog.schema.secret) that securely store sensitive credential data such as passwords, tokens, and keys. - SecretDependency: - type: object - properties: - secret_full_name: - type: string - description: Full name of the dependent secret, in the form of **catalog_name**.**schema_name**.**secret_name**. - required: - - secret_full_name - description: A secret that is dependent on a SQL object. Securable: type: object properties: @@ -5817,6 +5580,61 @@ components: securable: $ref: '#/components/schemas/Securable' description: The securable for which the access request destinations are being requested. + Skill: + type: object + properties: + bundle_name: + type: string + description: Name from the most recently successfully finalized SKILL.md. It may differ from the final component + of the Skill resource name. Unset until FinalizeSkill succeeds. + comment: + type: string + description: 'User-provided comment for the skill. Free-text, user-editable via UpdateSkill (listed in its ``update_mask``). + DISTINCT from ``description``, which is the server-parsed, OUTPUT_ONLY SKILL.md frontmatter value: ``comment`` + is the customer''s own annotation and is preserved across bundle re-uploads. When ``comment`` is in the update + mask, omitting it clears the field, while an explicitly empty string is retained.' + create_time: + type: string + format: date-time + description: Time the skill was created. + created_by: + type: string + description: Creator identity. + description: + type: string + description: Description from the most recently successfully finalized SKILL.md. Unset until FinalizeSkill succeeds. + effective_owner: + type: string + description: Owner of the skill. + etag: + type: string + description: Optimistic concurrency token returned on every read. To make an Update or Delete conditional, pass + the last-read value in that request's ``etag`` field. In REST responses, this value is a base64 string; URL-encode + it when setting the ``etag`` query parameter. + finalize_time: + type: string + format: date-time + description: Time of the most recent successful FinalizeSkill. Unset until one succeeds. + metastore_id: + type: string + description: Metastore hosting the skill. + name: + type: string + description: 'Resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component + is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``skill_id``; required and + immutable on Update/Get/Delete.' + update_time: + type: string + format: date-time + description: Time of the most recent Skill metadata mutation. Uploading bundle files alone does not change this + value. + updated_by: + type: string + description: Identity of the last updater. + description: |- + A Skill is an agentskills.io bundle registered in Unity Catalog. Clients transfer bundle bytes + through the Files API. FinalizeSkill reads the uploaded SKILL.md and projects its frontmatter + onto the Skill metadata. SseEncryptionDetails: type: object properties: @@ -6043,9 +5861,9 @@ components: type: array items: $ref: '#/components/schemas/PolicyFunctionArgument' - description: The list of additional table columns or literals to be passed as additional arguments to a row filter - function. This is the replacement of the deprecated input_column_names field and carries information about the - types (alias or constant) of the arguments to the filter function. + description: 'The list of table columns or literals to be passed as additional arguments to a row filter function, + carrying the type (column reference vs constant literal) of each argument. Deprecated: use input_column_names + instead.' required: - function_name - input_column_names @@ -6117,15 +5935,6 @@ components: description: |- Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE or the ONLINE_NO_PENDING_UPDATE state. - UcEncryptedToken: - type: object - properties: - encrypted_payload: - type: string - description: Stores encrypted ScopedCloudToken as a base64-encoded string - description: |- - Encrypted token used when we cannot downscope the cloud provider token appropriately See: - https://docs.google.com/document/d/1hEKDnSckuU5PIS798CtfqBElrMR6OJuR2wgz_BjhMSY UnassignResponse: type: object properties: {} @@ -6277,15 +6086,6 @@ components: result: $ref: '#/components/schemas/ValidationResultResult' description: The results of the tested operation. - VolumeDependency: - type: object - properties: - volume_full_name: - type: string - description: Full name of the dependent volume, in the form of **catalog_name**.**schema_name**.**volume_name**. - required: - - volume_full_name - description: A volume that is dependent on a SQL object. VolumeInfo: type: object properties: @@ -6349,14 +6149,6 @@ components: description: One of READ_WRITE/READ_ONLY. Default is READ_WRITE. required: - workspace_id - AgentServiceAgentServiceType: - type: string - x-enum: - - AGENT_SERVICE_TYPE_EXTERNAL - description: |- - Type of agent service. Determines how the backing agent surface is provisioned and how - invocation routes to the runtime. Nested to scope enum values (guardrail: - avoid-generic-enum-names). ArtifactType: type: string x-enum: @@ -6369,7 +6161,6 @@ components: x-enum: - ISOLATED - OPEN - - OPEN_IN_ACCOUNT description: |- Create a collection of name/value pairs. @@ -6428,7 +6219,6 @@ components: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -6440,9 +6230,7 @@ components: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -6487,136 +6275,39 @@ components: ConnectionType: type: string x-enum: - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AMPLITUDE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - - BIGLAKE + - AWS_SECRETS_MANAGER + - AZURE_KEY_VAULT - BIGQUERY - - CERIDIAN_DAYFORCE - CONFLUENCE - DATABRICKS - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - GITHUB - - GITLAB - GLUE - - GMAIL - - GONG - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - - GOOGLE_CLOUD_LAKEHOUSE - - GOOGLE_WORKSPACE - - GURU - - HIBOB - HIVE_METASTORE - HTTP - HUBSPOT - - ICEBERG_REST - - IRONCLAD - JDBC - - KINESIS - - LINEAR - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - - NOTION + - NETSUITE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - OUTLOOK - - PAGERDUTY - - PALANTIR - - PARTNERSTACK - - PENDO - POSTGRESQL - POWER_BI - - PUBSUB - - QUICKBOOKS - REDSHIFT - SALESFORCE - SALESFORCE_DATA_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - SMARTSHEET - - SNAPCHAT_ADS - SNOWFLAKE - - SPLUNK - SQLDW - SQLSERVER - - SQUARE - TERADATA + - TIKTOK_ADS - UNKNOWN_CONNECTION_TYPE - - VERKADA - WORKDAY_RAAS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - ConversionInfoState: - type: string - x-enum: - - COMPLETED - - IN_PROGRESS description: |- Create a collection of name/value pairs. @@ -6869,11 +6560,7 @@ components: - ANY_STATIC_CREDENTIAL - BEARER_TOKEN - EDGEGRID_AKAMAI - - GENERIC_TOKEN_EXCHANGE - - INLINE_YAML - OAUTH_ACCESS_TOKEN - - OAUTH_DCR - - OAUTH_GOOGLE_SERVICE_ACCOUNT - OAUTH_M2M - OAUTH_MTLS - OAUTH_REFRESH_TOKEN @@ -7042,48 +6729,6 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - DrReplicationStatus: - type: string - x-enum: - - DR_REPLICATION_STATUS_PRIMARY - - DR_REPLICATION_STATUS_SECONDARY - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. EffectivePredictiveOptimizationFlagInheritedFromType: @@ -7426,7 +7071,6 @@ components: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: |- Create a collection of name/value pairs. @@ -7512,9 +7156,9 @@ components: - BASIC - FULL description: |- - Controls which fields are populated on each McpService in the response. The server treats unset - / VIEW_UNSPECIFIED as BASIC. Callers needing the full configuration must request it explicitly - with ``view = FULL``. + Controls which fields are populated on each McpService in the response. The server uses + ``BASIC`` when ``view`` is unset. Callers needing the full configuration must request it + explicitly with ``view = FULL``. ListModelProviderServicesRequestView: type: string x-enum: @@ -7522,7 +7166,7 @@ components: - FULL description: |- Controls which fields are populated on each ModelProviderService in the response. The server - treats unset / VIEW_UNSPECIFIED as BASIC. Callers needing the full configuration must request it + uses ``BASIC`` when ``view`` is unset. Callers needing the full configuration must request it explicitly with ``view = FULL``. ListModelServicesRequestView: type: string @@ -7530,30 +7174,21 @@ components: - BASIC - FULL description: |- - Controls which fields are populated on each ModelService in the response. The server treats - unset / VIEW_UNSPECIFIED as BASIC. Callers needing the full configuration must request it + Controls which fields are populated on each ModelService in the response. The server uses + ``BASIC`` when ``view`` is unset. Callers needing the full configuration must request it explicitly with ``view = FULL``. MatchType: type: string x-enum: - PREFIX_MATCH description: The artifact pattern matching type - ModelProviderServiceConfigAnthropicProviderRelayedConfigAnthropicRelayedPlanType: - type: string - x-enum: - - ANTHROPIC_RELAYED_PLAN_TYPE_MAX - - ANTHROPIC_RELAYED_PLAN_TYPE_TEAM_ENTERPRISE - description: |- - Which Anthropic subscription tier the relayed OAuth token belongs to. Immutable after Create - (switching tiers changes which governance controls the platform enforces). Only MAX and - TEAM_ENTERPRISE differ in the governance surface the gateway can enforce, not in how the token - is relayed. ModelProviderServiceConfigExternalModelProviderType: type: string x-enum: - EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK - EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC - EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI + - EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE - EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM - EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE - EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY @@ -7811,7 +7446,6 @@ components: - OPTION_MULTILINE_STRING - OPTION_NUMBER - OPTION_SERVICE_CREDENTIAL - - OPTION_STORAGE_CREDENTIAL - OPTION_STRING description: |- Type of the option, we purposely follow JavaScript types so that the UI can map the options to @@ -7955,70 +7589,42 @@ components: - APPLY_TAG - BROWSE - CREATE - - CREATE_CASE_COLLECTION - CREATE_CATALOG - CREATE_CLEAN_ROOM - CREATE_CONNECTION - - CREATE_DATASOURCE - CREATE_EXTERNAL_LOCATION - CREATE_EXTERNAL_TABLE - CREATE_EXTERNAL_VOLUME - - CREATE_FEATURE - - CREATE_FLOW - CREATE_FOREIGN_CATALOG - CREATE_FOREIGN_SECURABLE - CREATE_FUNCTION - CREATE_MANAGED_STORAGE - CREATE_MATERIALIZED_VIEW - - CREATE_MEMORY_STORE - CREATE_MODEL - CREATE_PROVIDER - CREATE_RECIPIENT - - CREATE_RULE - CREATE_SCHEMA - - CREATE_SEMANTIC_GRAPH - - CREATE_SERVICE - CREATE_SERVICE_CREDENTIAL - CREATE_SHARE - - CREATE_SKILL - CREATE_STORAGE_CREDENTIAL - - CREATE_STREAM - CREATE_TABLE - CREATE_VIEW - CREATE_VOLUME - - DELETE - - DELETE_EVENTS - - DELETE_SECURITY_DATA - EXECUTE - EXECUTE_CLEAN_ROOM_TASK + - EXTERNAL_USE_LOCATION - EXTERNAL_USE_SCHEMA - - INSERT - - INSERT_SECURITY_DATA - MANAGE - - MANAGE_ACCESS - - MANAGE_ACCESS_CONTROL - MANAGE_ALLOWLIST - - MANAGE_GRANTS - MODIFY - MODIFY_CLEAN_ROOM - - READ_EVENTS - - READ_FEATURE - READ_FILES - - READ_FLOW - - READ_MEMORY_STORE - READ_METADATA - READ_PRIVATE_FILES - - READ_SECURITY_DATA - - READ_SEMANTIC_GRAPH - - READ_SKILL - - READ_STREAM - READ_VOLUME - REFRESH - SELECT - SET_SHARE_PERMISSION - - UPDATE - - UPDATE_EVENTS - - UPDATE_SECURITY_DATA - USAGE - USE_CATALOG - USE_CONNECTION @@ -8027,16 +7633,8 @@ components: - USE_RECIPIENT - USE_SCHEMA - USE_SHARE - - USE_VOLUME - - VIEW_ADMIN_METADATA - - VIEW_METADATA - - VIEW_OBJECT - WRITE_FILES - - WRITE_FLOW - - WRITE_MEMORY_STORE - WRITE_PRIVATE_FILES - - WRITE_SEMANTIC_GRAPH - - WRITE_SKILL - WRITE_VOLUME description: |- Create a collection of name/value pairs. @@ -8124,7 +7722,6 @@ components: RateLimitRateLimitKey: type: string x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - RATE_LIMIT_KEY_SERVICE - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - RATE_LIMIT_KEY_USER @@ -8137,33 +7734,9 @@ components: - RATE_LIMIT_RENEWAL_PERIOD_HOUR - RATE_LIMIT_RENEWAL_PERIOD_MINUTE description: Renewal period for a rate limit. - SchemaFilterType: - type: string - x-enum: - - SCHEMA_FILTER_TYPE_EXCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE_ALL - description: Determines how a FOREIGN catalog's schema filter items are interpreted. SecurableKind: type: string x-enum: - - CATALOG_FOREIGN_BIGLAKE - - CATALOG_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - - CATALOG_FOREIGN_ICEBERG_REST - - CONNECTION_BIGLAKE_SERVICE_ACCOUNT - - CONNECTION_COMMUNITY_OAUTH_M2M - - CONNECTION_COMMUNITY_OAUTH_U2M - - CONNECTION_COMMUNITY_OAUTH_U2M_MAPPING - - CONNECTION_GOOGLE_CLOUD_LAKEHOUSE_OAUTH_U2M - - CONNECTION_GOOGLE_CLOUD_LAKEHOUSE_SERVICE_ACCOUNT - - CONNECTION_ICEBERG_REST_BEARER_TOKEN - - CONNECTION_ICEBERG_REST_OAUTH_M2M - - RECIPIENT_EMAIL - - RECIPIENT_EMAIL_DATABRICKS - - RECIPIENT_EMAIL_TOKEN - - SCHEMA_FOREIGN_BIGLAKE - - SCHEMA_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - - SCHEMA_FOREIGN_ICEBERG_REST - TABLE_DB_STORAGE - TABLE_DELTA - TABLE_DELTASHARING @@ -8182,12 +7755,10 @@ components: - TABLE_EXTERNAL - TABLE_FEATURE_STORE - TABLE_FEATURE_STORE_EXTERNAL - - TABLE_FOREIGN_BIGLAKE - TABLE_FOREIGN_BIGQUERY - TABLE_FOREIGN_DATABRICKS - TABLE_FOREIGN_DELTASHARING - TABLE_FOREIGN_DELTA_DELTASHARING - - TABLE_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - TABLE_FOREIGN_HIVE_METASTORE - TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL - TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED @@ -8199,12 +7770,10 @@ components: - TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL - TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED - TABLE_FOREIGN_HIVE_METASTORE_VIEW - - TABLE_FOREIGN_ICEBERG_REST - TABLE_FOREIGN_MONGODB - TABLE_FOREIGN_MYSQL - TABLE_FOREIGN_NETSUITE - TABLE_FOREIGN_ORACLE - - TABLE_FOREIGN_PALANTIR - TABLE_FOREIGN_POSTGRESQL - TABLE_FOREIGN_REDSHIFT - TABLE_FOREIGN_SALESFORCE @@ -8273,6 +7842,7 @@ components: SecurableType: type: string x-enum: + - AGENT_SERVICE - CATALOG - CLEAN_ROOM - CONNECTION @@ -8280,12 +7850,17 @@ components: - EXTERNAL_LOCATION - EXTERNAL_METADATA - FUNCTION + - MCP_SERVICE - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE - PIPELINE - PROVIDER - RECIPIENT - SCHEMA - SHARE + - SKILL - STAGING_TABLE - STORAGE_CREDENTIAL - TABLE @@ -9027,8 +8602,6 @@ components: ELSE 'UNKNOWN' END AS cloud_type FROM databricks_account.catalog.account_storage_credentials sc - WHERE account_id = '{{ account_id }}' - AND metastore_id = '{{ metastore_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -9068,8 +8641,6 @@ components: ELSE 'UNKNOWN' END AS cloud_type FROM databricks_account.catalog.account_storage_credentials sc - WHERE account_id = '{{ account_id }}' - AND metastore_id = '{{ metastore_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/disasterrecovery.yaml b/providers/src/databricks_account/v00.00.00000/services/disasterrecovery.yaml index 8159f22f..9653b2be 100644 --- a/providers/src/databricks_account/v00.00.00000/services/disasterrecovery.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/disasterrecovery.yaml @@ -6,12 +6,27 @@ info: (account-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.disasterrecovery servers: - - url: https://accounts.cloud.databricks.com + - url: https://{account_host} + variables: + account_host: + description: >- + The Databricks account console host. Selected by DATABRICKS_CLOUD + (aws, azure or gcp; default aws), or set explicitly with + DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: - /api/disaster-recovery/v1/{parent}/failover-groups: + /api/disaster-recovery/v1/accounts/{account_id}/failover-groups: post: operationId: disaster_recovery_create_failover_group summary: Create a new failover group. @@ -33,12 +48,15 @@ paths: :returns: :class:`FailoverGroup` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: 'The parent resource. Format: accounts/{account_id}.' + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource. Format: + accounts/{account_id}. - name: failover_group_id in: query required: true @@ -61,227 +79,175 @@ paths: schema: type: object properties: - failover_group: + regions: + type: array + items: + type: string + description: List of all regions participating in this failover group. + workspace_sets: + type: array + items: + type: object + properties: + name: + type: string + description: Resource name for this workspace set. + workspace_ids: + type: array + items: + type: string + description: >- + Workspace IDs in this set. The system derives and + validates regions. All workspaces must be in the + Mission Critical tier. + replicate_workspace_assets: + type: boolean + description: >- + Whether to enable control plane DR (notebooks, jobs, + clusters, etc.) for this set. Defaults to false. + stable_url_names: + type: array + items: + type: string + description: >- + Resource names of stable URLs associated with this + workspace set. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. The + referenced stable URLs must already exist (via + CreateStableUrl). + required: + - name + - workspace_ids + description: >- + A set of workspaces that replicate to each other across + regions. + description: >- + Workspace sets, each containing workspaces that replicate to + each other. + initial_primary_region: + type: string + description: >- + Initial primary region. Used only in Create requests to set + the starting primary region. Not returned in responses. + create_time: + type: string + format: date-time + description: Time at which this failover group was created. + effective_primary_region: + type: string + description: >- + Current effective primary region. Replication flows FROM + workspaces in this region. Changes after a successful + failover. + etag: + type: string + description: >- + Opaque version string for optimistic locking. + Server-generated and returned in responses. + has_replication_point_blocking_errors: + type: boolean + description: True if errors currently block the replication point. + initial_replication_progress: type: object properties: - regions: + completed: + type: integer + description: Percent complete, 0-100. + description: >- + Initial replication progress of all in-scope assets. Set + only when the FailoverGroup is in INITIAL_REPLICATION state. + name: + type: string + description: >- + Fully qualified resource name in the format + accounts/{account_id}/failover-groups/{failover_group_id}. + replication_point: + type: string + format: date-time + description: The latest point in time to which data has been replicated. + state: + type: string + x-enum: + - ACTIVE + - CREATING + - CREATION_FAILED + - DELETING + - DELETION_FAILED + - FAILING_OVER + - FAILOVER_FAILED + - INITIAL_REPLICATION + description: Aggregate state of the failover group. + unity_catalog_assets: + type: object + properties: + catalogs: type: array items: - type: string + type: object + properties: + name: + type: string + description: The name of the UC catalog to replicate. + required: + - name + description: A Unity Catalog catalog to replicate. + description: UC catalogs to replicate. + data_replication_workspace_set: + type: string description: >- - List of all regions participating in this failover - group. - workspace_sets: + The workspace set whose workspaces will be used for data + replication of all UC catalogs' underlying storage. + location_mappings: type: array items: type: object properties: name: type: string - description: Resource name for this workspace set. - workspace_ids: - type: array - items: - type: string - description: >- - Workspace IDs in this set. The system derives and - validates regions. All workspaces must be in the - Mission Critical tier. - asset_replication_config: - type: object - properties: - enable_jobs: - type: boolean - description: Whether to replicate jobs. - enable_clusters: - type: boolean - description: >- - Whether to replicate clusters (including - cluster policies, instance profiles, global - init scripts, and worker environment - overlays). - enable_warehouse: - type: boolean - description: Whether to replicate SQL warehouses. - enable_sql_workspace: - type: boolean - description: Whether to replicate the SQL workspace. - enable_libraries: - type: boolean - description: Whether to replicate libraries. - enable_notebooks: - type: boolean - description: Whether to replicate notebooks. - enable_files: - type: boolean - description: Whether to replicate workspace files. - enable_queries: - type: boolean - description: Whether to replicate SQL queries. - enable_dashboards: - type: boolean - description: Whether to replicate dashboards. - required: - - enable_jobs - - enable_clusters - - enable_warehouse - - enable_sql_workspace - - enable_libraries - - enable_notebooks - - enable_files - - enable_queries - - enable_dashboards - description: >- - Per-asset-type control over which workspace assets - are replicated. Applies only when - replicate_workspace_assets is true. When omitted - while control plane DR is enabled, every asset - type is replicated. - replicate_workspace_assets: - type: boolean - description: >- - Whether to enable control plane DR (notebooks, - jobs, clusters, etc.) for this set. Defaults to - false. - stable_url_names: + description: Resource name for this location. + uri_by_region: type: array items: - type: string + type: object + properties: + region: + type: string + description: The region name. + uri: + type: string + description: The storage URI for this region. + required: + - region + - uri + description: >- + A single entry in a location mapping, mapping a + region to a storage URI. Used instead of + map for proto2 compatibility. description: >- - Resource names of stable URLs associated with this - workspace set. Format: - accounts/{account_id}/stable-urls/{stable_url_id}. - The referenced stable URLs must already exist (via - CreateStableUrl). + URI for each region. Each entry maps a region name + to a storage URI. required: - name - - workspace_ids + - uri_by_region description: >- - A set of workspaces that replicate to each other - across regions. + A location mapping identified by a name, with URIs per + region. The system derives replication + direction from effective_primary_region. description: >- - Workspace sets, each containing workspaces that - replicate to each other. - initial_primary_region: - type: string - description: >- - Initial primary region. Used only in Create requests to - set the starting primary region. Not returned in - responses. - create_time: - type: string - format: date-time - description: Time at which this failover group was created. - effective_primary_region: - type: string - description: >- - Current effective primary region. Replication flows FROM - workspaces in this region. Changes after a successful - failover. - etag: - type: string - description: >- - Opaque version string for optimistic locking. - Server-generated and returned in responses. - name: - type: string - description: >- - Fully qualified resource name in the format - accounts/{account_id}/failover-groups/{failover_group_id}. - replication_point: - type: string - format: date-time - description: >- - The latest point in time to which data has been - replicated. - state: - type: string - x-enum: - - ACTIVE - - CREATING - - CREATION_FAILED - - DELETING - - DELETION_FAILED - - FAILING_OVER - - FAILOVER_FAILED - - INITIAL_REPLICATION - description: Aggregate state of the failover group. - unity_catalog_assets: - type: object - properties: - catalogs: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the UC catalog to replicate. - required: - - name - description: A Unity Catalog catalog to replicate. - description: UC catalogs to replicate. - data_replication_workspace_set: - type: string - description: >- - The workspace set whose workspaces will be used for - data replication of all UC catalogs' underlying - storage. - location_mappings: - type: array - items: - type: object - properties: - name: - type: string - description: Resource name for this location. - uri_by_region: - type: array - items: - type: object - properties: - region: - type: string - description: The region name. - uri: - type: string - description: The storage URI for this region. - required: - - region - - uri - description: >- - A single entry in a location mapping, - mapping a region to a storage URI. Used - instead of - map for proto2 compatibility. - description: >- - URI for each region. Each entry maps a region - name to a storage URI. - required: - - name - - uri_by_region - description: >- - A location mapping identified by a name, with URIs - per region. The system derives replication - direction from effective_primary_region. - description: >- - Location mappings - storage URI per region for each - location. - required: - - catalogs - - data_replication_workspace_set - description: Unity Catalog replication configuration. - update_time: - type: string - format: date-time - description: Time at which this failover group was last modified. + Location mappings - storage URI per region for each + location. required: - - regions - - workspace_sets - - initial_primary_region - description: The failover group to create. + - catalogs + - data_replication_workspace_set + description: Unity Catalog replication configuration. + update_time: + type: string + format: date-time + description: Time at which this failover group was last modified. required: - - failover_group + - regions + - workspace_sets + - initial_primary_region responses: '200': description: Success @@ -332,12 +298,15 @@ paths: :returns: Iterator over :class:`FailoverGroup` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: 'The parent resource. Format: accounts/{account_id}.' + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource. Format: + accounts/{account_id}. - name: page_size in: query required: false @@ -376,7 +345,7 @@ paths: message: type: string x-stackql-sdk-source: DisasterRecoveryAPI - /api/disaster-recovery/v1/{parent}/stable-urls: + /api/disaster-recovery/v1/accounts/{account_id}/stable-urls: post: operationId: disaster_recovery_create_stable_url summary: Create a new stable URL. @@ -398,12 +367,15 @@ paths: :returns: :class:`StableUrl` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: 'The parent resource. Format: accounts/{account_id}.' + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource. Format: + accounts/{account_id}. - name: stable_url_id in: query required: true @@ -424,60 +396,53 @@ paths: schema: type: object properties: - stable_url: - type: object - properties: - initial_workspace_id: - type: string - description: >- - The workspace this stable URL is initially bound to. - Used only in Create requests to associate the stable URL - with a workspace. Not returned in responses. - effective_workspace_id: - type: string - description: >- - The workspace this stable URL currently routes to. Set - to ``initial_workspace_id`` at creation, advanced to the - failover group's primary while attached (including - across a failover), and preserved when the stable URL is - detached from its failover group. Read this to see where - an unattached stable URL points: after a failover - followed by a detach it reflects the post-failover - primary, not ``initial_workspace_id``. - failover_group_name: - type: string - description: >- - Fully qualified resource name of the FailoverGroup this - stable URL is currently linked to, in the format - ``accounts/{account_id}/failover-groups/{failover_group_id}``. - Empty when the stable URL is not attached to any - failover group. - name: - type: string - description: >- - Fully qualified resource name. Format: - accounts/{account_id}/stable-urls/{stable_url_id}. - stable_workspace_id: - type: string - description: >- - The stable workspace ID for this stable URL. Generated - on creation and immutable thereafter; identifies the URL - across failovers and is the same value embedded in the - ``url`` (as the ``w=`` query parameter for SPOG URLs, or - in the ``conn-`` hostname for Private-Link URLs). - url: - type: string - description: >- - The stable URL endpoint. Generated on creation and - immutable thereafter. For non-Private-Link workspaces - this is ``https:///?w=``. For - Private-Link workspaces this is the per-connection - hostname. - required: - - initial_workspace_id - description: The stable URL to create. + initial_workspace_id: + type: string + description: >- + The workspace this stable URL is initially bound to. Used + only in Create requests to associate the stable URL with a + workspace. Not returned in responses. + effective_workspace_id: + type: string + description: >- + The workspace this stable URL currently routes to. Set to + ``initial_workspace_id`` at creation, advanced to the + failover group's primary while attached (including across a + failover), and preserved when the stable URL is detached + from its failover group. Read this to see where an + unattached stable URL points: after a failover followed by a + detach it reflects the post-failover primary, not + ``initial_workspace_id``. + failover_group_name: + type: string + description: >- + Fully qualified resource name of the FailoverGroup this + stable URL is currently linked to, in the format + ``accounts/{account_id}/failover-groups/{failover_group_id}``. + Empty when the stable URL is not attached to any failover + group. + name: + type: string + description: >- + Fully qualified resource name. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. + stable_workspace_id: + type: string + description: >- + The stable workspace ID for this stable URL. Generated on + creation and immutable thereafter; identifies the URL across + failovers and is the same value embedded in the ``url`` (as + the ``w=`` query parameter for SPOG URLs, or in the + ``conn-`` hostname for Private-Link URLs). + url: + type: string + description: >- + The stable URL endpoint. Generated on creation and immutable + thereafter. For non-Private-Link workspaces this is + ``https:///?w=``. For Private-Link + workspaces this is the per-connection hostname. required: - - stable_url + - initial_workspace_id responses: '200': description: Success @@ -521,12 +486,15 @@ paths: :returns: Iterator over :class:`StableUrl` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: 'The parent resource. Format: accounts/{account_id}.' + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource. Format: + accounts/{account_id}. - name: page_size in: query required: false @@ -565,27 +533,52 @@ paths: message: type: string x-stackql-sdk-source: DisasterRecoveryAPI - /api/disaster-recovery/v1/{name}: + /api/disaster-recovery/v1/accounts/{account_id}/failover-groups/{failover_group_id}: delete: - operationId: disaster_recovery_delete_stable_url - summary: Delete a stable URL. + operationId: disaster_recovery_delete_failover_group + summary: Delete a failover group. tags: - disasterrecovery - disaster_recovery description: |- - Delete a stable URL. + Delete a failover group. :param name: str - The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}. + The fully qualified resource name of the failover group to delete. Format: + accounts/{account_id}/failover-groups/{failover_group_id}. + :param etag: str (optional) + Opaque version string for optimistic locking. If provided, must match the current etag. If omitted, + the delete proceeds without an etag check. parameters: - - name: name + - name: account_id in: path required: true schema: type: string description: >- - The fully qualified resource name. Format: - accounts/{account_id}/stable-urls/{stable_url_id}. + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group to delete. + Format: accounts/{account_id}/failover-groups/{failover_group_id}. + - name: failover_group_id + in: path + required: true + schema: + type: string + description: >- + The `failover_group_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group to delete. + Format: accounts/{account_id}/failover-groups/{failover_group_id}. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Opaque version string for optimistic locking. If provided, must + match the current etag. If omitted, the delete proceeds without an + etag check. responses: '200': description: Success @@ -602,34 +595,47 @@ paths: type: string x-stackql-sdk-source: DisasterRecoveryAPI get: - operationId: disaster_recovery_get_stable_url - summary: Get a stable URL. + operationId: disaster_recovery_get_failover_group + summary: Get a failover group. tags: - disasterrecovery - disaster_recovery description: |- - Get a stable URL. + Get a failover group. :param name: str - The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}. + The fully qualified resource name of the failover group. Format: + accounts/{account_id}/failover-groups/{failover_group_id}. - :returns: :class:`StableUrl` + :returns: :class:`FailoverGroup` parameters: - - name: name + - name: account_id in: path required: true schema: type: string description: >- - The fully qualified resource name. Format: - accounts/{account_id}/stable-urls/{stable_url_id}. + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group. Format: + accounts/{account_id}/failover-groups/{failover_group_id}. + - name: failover_group_id + in: path + required: true + schema: + type: string + description: >- + The `failover_group_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group. Format: + accounts/{account_id}/failover-groups/{failover_group_id}. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/StableUrl' + $ref: '#/components/schemas/FailoverGroup' default: description: Error response content: @@ -666,13 +672,25 @@ paths: :returns: :class:`FailoverGroup` parameters: - - name: name + - name: account_id in: path required: true schema: type: string description: >- - Fully qualified resource name in the format + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). Fully + qualified resource name in the format + accounts/{account_id}/failover-groups/{failover_group_id}. + - name: failover_group_id + in: path + required: true + schema: + type: string + description: >- + The `failover_group_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). Fully + qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}. - name: update_mask in: query @@ -696,229 +714,175 @@ paths: schema: type: object properties: - failover_group: + regions: + type: array + items: + type: string + description: List of all regions participating in this failover group. + workspace_sets: + type: array + items: + type: object + properties: + name: + type: string + description: Resource name for this workspace set. + workspace_ids: + type: array + items: + type: string + description: >- + Workspace IDs in this set. The system derives and + validates regions. All workspaces must be in the + Mission Critical tier. + replicate_workspace_assets: + type: boolean + description: >- + Whether to enable control plane DR (notebooks, jobs, + clusters, etc.) for this set. Defaults to false. + stable_url_names: + type: array + items: + type: string + description: >- + Resource names of stable URLs associated with this + workspace set. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. The + referenced stable URLs must already exist (via + CreateStableUrl). + required: + - name + - workspace_ids + description: >- + A set of workspaces that replicate to each other across + regions. + description: >- + Workspace sets, each containing workspaces that replicate to + each other. + initial_primary_region: + type: string + description: >- + Initial primary region. Used only in Create requests to set + the starting primary region. Not returned in responses. + create_time: + type: string + format: date-time + description: Time at which this failover group was created. + effective_primary_region: + type: string + description: >- + Current effective primary region. Replication flows FROM + workspaces in this region. Changes after a successful + failover. + etag: + type: string + description: >- + Opaque version string for optimistic locking. + Server-generated and returned in responses. + has_replication_point_blocking_errors: + type: boolean + description: True if errors currently block the replication point. + initial_replication_progress: + type: object + properties: + completed: + type: integer + description: Percent complete, 0-100. + description: >- + Initial replication progress of all in-scope assets. Set + only when the FailoverGroup is in INITIAL_REPLICATION state. + name: + type: string + description: >- + Fully qualified resource name in the format + accounts/{account_id}/failover-groups/{failover_group_id}. + replication_point: + type: string + format: date-time + description: The latest point in time to which data has been replicated. + state: + type: string + x-enum: + - ACTIVE + - CREATING + - CREATION_FAILED + - DELETING + - DELETION_FAILED + - FAILING_OVER + - FAILOVER_FAILED + - INITIAL_REPLICATION + description: Aggregate state of the failover group. + unity_catalog_assets: type: object properties: - regions: + catalogs: type: array items: - type: string + type: object + properties: + name: + type: string + description: The name of the UC catalog to replicate. + required: + - name + description: A Unity Catalog catalog to replicate. + description: UC catalogs to replicate. + data_replication_workspace_set: + type: string description: >- - List of all regions participating in this failover - group. - workspace_sets: + The workspace set whose workspaces will be used for data + replication of all UC catalogs' underlying storage. + location_mappings: type: array items: type: object properties: name: type: string - description: Resource name for this workspace set. - workspace_ids: - type: array - items: - type: string - description: >- - Workspace IDs in this set. The system derives and - validates regions. All workspaces must be in the - Mission Critical tier. - asset_replication_config: - type: object - properties: - enable_jobs: - type: boolean - description: Whether to replicate jobs. - enable_clusters: - type: boolean - description: >- - Whether to replicate clusters (including - cluster policies, instance profiles, global - init scripts, and worker environment - overlays). - enable_warehouse: - type: boolean - description: Whether to replicate SQL warehouses. - enable_sql_workspace: - type: boolean - description: Whether to replicate the SQL workspace. - enable_libraries: - type: boolean - description: Whether to replicate libraries. - enable_notebooks: - type: boolean - description: Whether to replicate notebooks. - enable_files: - type: boolean - description: Whether to replicate workspace files. - enable_queries: - type: boolean - description: Whether to replicate SQL queries. - enable_dashboards: - type: boolean - description: Whether to replicate dashboards. - required: - - enable_jobs - - enable_clusters - - enable_warehouse - - enable_sql_workspace - - enable_libraries - - enable_notebooks - - enable_files - - enable_queries - - enable_dashboards - description: >- - Per-asset-type control over which workspace assets - are replicated. Applies only when - replicate_workspace_assets is true. When omitted - while control plane DR is enabled, every asset - type is replicated. - replicate_workspace_assets: - type: boolean - description: >- - Whether to enable control plane DR (notebooks, - jobs, clusters, etc.) for this set. Defaults to - false. - stable_url_names: + description: Resource name for this location. + uri_by_region: type: array items: - type: string + type: object + properties: + region: + type: string + description: The region name. + uri: + type: string + description: The storage URI for this region. + required: + - region + - uri + description: >- + A single entry in a location mapping, mapping a + region to a storage URI. Used instead of + map for proto2 compatibility. description: >- - Resource names of stable URLs associated with this - workspace set. Format: - accounts/{account_id}/stable-urls/{stable_url_id}. - The referenced stable URLs must already exist (via - CreateStableUrl). + URI for each region. Each entry maps a region name + to a storage URI. required: - name - - workspace_ids + - uri_by_region description: >- - A set of workspaces that replicate to each other - across regions. - description: >- - Workspace sets, each containing workspaces that - replicate to each other. - initial_primary_region: - type: string + A location mapping identified by a name, with URIs per + region. The system derives replication + direction from effective_primary_region. description: >- - Initial primary region. Used only in Create requests to - set the starting primary region. Not returned in - responses. - create_time: - type: string - format: date-time - description: Time at which this failover group was created. - effective_primary_region: - type: string - description: >- - Current effective primary region. Replication flows FROM - workspaces in this region. Changes after a successful - failover. - etag: - type: string - description: >- - Opaque version string for optimistic locking. - Server-generated and returned in responses. - name: - type: string - description: >- - Fully qualified resource name in the format - accounts/{account_id}/failover-groups/{failover_group_id}. - replication_point: - type: string - format: date-time - description: >- - The latest point in time to which data has been - replicated. - state: - type: string - x-enum: - - ACTIVE - - CREATING - - CREATION_FAILED - - DELETING - - DELETION_FAILED - - FAILING_OVER - - FAILOVER_FAILED - - INITIAL_REPLICATION - description: Aggregate state of the failover group. - unity_catalog_assets: - type: object - properties: - catalogs: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the UC catalog to replicate. - required: - - name - description: A Unity Catalog catalog to replicate. - description: UC catalogs to replicate. - data_replication_workspace_set: - type: string - description: >- - The workspace set whose workspaces will be used for - data replication of all UC catalogs' underlying - storage. - location_mappings: - type: array - items: - type: object - properties: - name: - type: string - description: Resource name for this location. - uri_by_region: - type: array - items: - type: object - properties: - region: - type: string - description: The region name. - uri: - type: string - description: The storage URI for this region. - required: - - region - - uri - description: >- - A single entry in a location mapping, - mapping a region to a storage URI. Used - instead of - map for proto2 compatibility. - description: >- - URI for each region. Each entry maps a region - name to a storage URI. - required: - - name - - uri_by_region - description: >- - A location mapping identified by a name, with URIs - per region. The system derives replication - direction from effective_primary_region. - description: >- - Location mappings - storage URI per region for each - location. - required: - - catalogs - - data_replication_workspace_set - description: Unity Catalog replication configuration. - update_time: - type: string - format: date-time - description: Time at which this failover group was last modified. + Location mappings - storage URI per region for each + location. required: - - regions - - workspace_sets - - initial_primary_region - description: >- - The failover group with updated fields. The name field - identifies the resource and is populated from the URL path. + - catalogs + - data_replication_workspace_set + description: Unity Catalog replication configuration. + update_time: + type: string + format: date-time + description: Time at which this failover group was last modified. required: - - failover_group + - regions + - workspace_sets + - initial_primary_region responses: '200': description: Success @@ -938,7 +902,108 @@ paths: message: type: string x-stackql-sdk-source: DisasterRecoveryAPI - /api/disaster-recovery/v1/{name}/failover: + /api/disaster-recovery/v1/accounts/{account_id}/stable-urls/{stable_url_id}: + delete: + operationId: disaster_recovery_delete_stable_url + summary: Delete a stable URL. + tags: + - disasterrecovery + - disaster_recovery + description: |- + Delete a stable URL. + + :param name: str + The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}. + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/stable-urls/{stable_url_id}`). The fully + qualified resource name. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. + - name: stable_url_id + in: path + required: true + schema: + type: string + description: >- + The `stable_url_id` segment of the `name` resource name + (`accounts/{account_id}/stable-urls/{stable_url_id}`). The fully + qualified resource name. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DisasterRecoveryAPI + get: + operationId: disaster_recovery_get_stable_url + summary: Get a stable URL. + tags: + - disasterrecovery + - disaster_recovery + description: |- + Get a stable URL. + + :param name: str + The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}. + + :returns: :class:`StableUrl` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/stable-urls/{stable_url_id}`). The fully + qualified resource name. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. + - name: stable_url_id + in: path + required: true + schema: + type: string + description: >- + The `stable_url_id` segment of the `name` resource name + (`accounts/{account_id}/stable-urls/{stable_url_id}`). The fully + qualified resource name. Format: + accounts/{account_id}/stable-urls/{stable_url_id}. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StableUrl' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DisasterRecoveryAPI + /api/disaster-recovery/v1/accounts/{account_id}/failover-groups/{failover_group_id}/failover: post: operationId: disaster_recovery_failover_failover_group summary: Initiate a failover to a new primary region. @@ -962,13 +1027,25 @@ paths: :returns: :class:`FailoverGroup` parameters: - - name: name + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group to failover. + Format: accounts/{account_id}/failover-groups/{failover_group_id}. + - name: failover_group_id in: path required: true schema: type: string description: >- - The fully qualified resource name of the failover group to failover. + The `failover_group_id` segment of the `name` resource name + (`accounts/{account_id}/failover-groups/{failover_group_id}`). The + fully qualified resource name of the failover group to failover. Format: accounts/{account_id}/failover-groups/{failover_group_id}. requestBody: content: @@ -1017,59 +1094,6 @@ paths: x-stackql-sdk-source: DisasterRecoveryAPI components: schemas: - AssetReplicationConfig: - type: object - properties: - enable_jobs: - type: boolean - description: Whether to replicate jobs. - enable_clusters: - type: boolean - description: >- - Whether to replicate clusters (including cluster policies, instance - profiles, global init scripts, and worker environment overlays). - enable_warehouse: - type: boolean - description: Whether to replicate SQL warehouses. - enable_sql_workspace: - type: boolean - description: Whether to replicate the SQL workspace. - enable_libraries: - type: boolean - description: Whether to replicate libraries. - enable_notebooks: - type: boolean - description: Whether to replicate notebooks. - enable_files: - type: boolean - description: Whether to replicate workspace files. - enable_queries: - type: boolean - description: Whether to replicate SQL queries. - enable_dashboards: - type: boolean - description: Whether to replicate dashboards. - required: - - enable_jobs - - enable_clusters - - enable_warehouse - - enable_sql_workspace - - enable_libraries - - enable_notebooks - - enable_files - - enable_queries - - enable_dashboards - description: >- - Per-asset-type control over which workspace assets are replicated for a - workspace set. Applies - only when replicate_workspace_assets is true. Each toggle enables replication of one asset type - (or, for the workspace tree, one sub-type). Folders and permissions are always replicated for a - coherent recovery copy and therefore have no toggle. - - This message is all-or-nothing: if it is provided, every toggle must be set (a partial config is - rejected). Omitting the containing asset_replication_config field entirely selects the default - of replicating every asset type; sending the message means the caller opts into explicit - per-type control and must therefore state each type. FailoverGroup: type: object properties: @@ -1104,6 +1128,14 @@ components: description: >- Opaque version string for optimistic locking. Server-generated and returned in responses. + has_replication_point_blocking_errors: + type: boolean + description: True if errors currently block the replication point. + initial_replication_progress: + $ref: '#/components/schemas/InitialReplicationProgress' + description: >- + Initial replication progress of all in-scope assets. Set only when + the FailoverGroup is in INITIAL_REPLICATION state. name: type: string description: >- @@ -1131,6 +1163,16 @@ components: A failover group manages disaster recovery across workspace sets, coordinating Unity Catalog and workspace assets replication. + InitialReplicationProgress: + type: object + properties: + completed: + type: integer + description: Percent complete, 0-100. + description: >- + Progress of the initial replication of all in-scope assets (Unity + Catalog and workspace assets) + of a FailoverGroup. Populated only while the FailoverGroup is in INITIAL_REPLICATION. ListFailoverGroupsResponse: type: object properties: @@ -1289,12 +1331,6 @@ components: description: >- Workspace IDs in this set. The system derives and validates regions. All workspaces must be in the Mission Critical tier. - asset_replication_config: - $ref: '#/components/schemas/AssetReplicationConfig' - description: >- - Per-asset-type control over which workspace assets are replicated. - Applies only when replicate_workspace_assets is true. When omitted - while control plane DR is enabled, every asset type is replicated. replicate_workspace_assets: type: boolean description: >- @@ -1341,24 +1377,39 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~1disaster-recovery~1v1~1{parent}~1failover-groups/post + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1api~1disaster-recovery~1v1~1{parent}~1failover-groups/get + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.failover_groups + delete: + operation: + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups~1{failover_group_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups~1{failover_group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' update: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{name}/patch' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups~1{failover_group_id}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1367,18 +1418,21 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{name}~1failover/post' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1failover-groups~1{failover_group_id}~1failover/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/failover_groups/methods/get' - $ref: '#/components/x-stackQL-resources/failover_groups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/failover_groups/methods/create' update: - $ref: '#/components/x-stackQL-resources/failover_groups/methods/update' - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/failover_groups/methods/delete' replace: [] stable_urls: id: databricks_account.disasterrecovery.stable_urls @@ -1390,33 +1444,37 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{parent}~1stable-urls/post' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1stable-urls/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{parent}~1stable-urls/get' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1stable-urls/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.stable_urls delete: operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{name}/delete' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1stable-urls~1{stable_url_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~1disaster-recovery~1v1~1{name}/get' + $ref: >- + #/paths/~1api~1disaster-recovery~1v1~1accounts~1{account_id}~1stable-urls~1{stable_url_id}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/stable_urls/methods/list' - $ref: '#/components/x-stackQL-resources/stable_urls/methods/get' + - $ref: '#/components/x-stackQL-resources/stable_urls/methods/list' insert: - $ref: '#/components/x-stackQL-resources/stable_urls/methods/create' update: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/iam.yaml b/providers/src/databricks_account/v00.00.00000/services/iam.yaml index 0a0b375c..0cf214c0 100644 --- a/providers/src/databricks_account/v00.00.00000/services/iam.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/iam.yaml @@ -5,10 +5,23 @@ info: SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.iam servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/preview/accounts/{account_id}/access-control/assignable-roles: get: @@ -1650,12 +1663,13 @@ paths: x-stackql-sdk-source: AccountUsersV2API put: operationId: account_users_v2_update - summary: Replaces a user's information with the data supplied in request. + summary: Replaces a user's information with the data supplied in request. The ``userName`` and ``emails`` tags: - iam - account_users_v2 description: |- - Replaces a user's information with the data supplied in request. + Replaces a user's information with the data supplied in request. The ``userName`` and ``emails`` + attributes cannot be updated through this API; any supplied changes to them are ignored (no-op). :param id: str Databricks user ID. @@ -1664,14 +1678,16 @@ paths: :param display_name: str (optional) String that represents a concatenation of given and family names. For example ``John Smith``. :param emails: List[:class:`ComplexValue`] (optional) - All the emails associated with the Databricks user. + All the emails associated with the Databricks user. This attribute cannot be updated through the + SCIM PATCH or PUT APIs; any supplied change is ignored. :param external_id: str (optional) External ID is not currently supported. It is reserved for future use. :param name: :class:`Name` (optional) :param roles: List[:class:`ComplexValue`] (optional) Indicates if the group has the admin role. :param user_name: str (optional) - Email address of the Databricks user. + Email address of the Databricks user. This attribute cannot be updated through the SCIM PATCH or PUT + APIs; any supplied change is ignored. parameters: - name: account_id in: path @@ -1711,7 +1727,8 @@ paths: type: string value: type: string - description: All the emails associated with the Databricks user. + description: All the emails associated with the Databricks user. This attribute cannot be updated through + the SCIM PATCH or PUT APIs; any supplied change is ignored. externalId: type: string description: External ID is not currently supported. It is reserved for future use. @@ -1741,7 +1758,8 @@ paths: description: Indicates if the group has the admin role. userName: type: string - description: Email address of the Databricks user. + description: Email address of the Databricks user. This attribute cannot be updated through the SCIM PATCH + or PUT APIs; any supplied change is ignored. responses: '200': description: Success @@ -1976,12 +1994,6 @@ paths: :param workspace_id: int The workspace ID for the account. - :param filter: str (optional) - Filter string to search principals. - :param max_results: int (optional) - Maximum number of permission assignments to return. - :param page_token: str (optional) - Page token returned by previous call to retrieve the next page of results. :returns: Iterator over :class:`PermissionAssignment` parameters: @@ -1996,24 +2008,6 @@ paths: schema: type: integer description: The workspace ID for the account. - - name: filter - in: query - required: false - schema: - type: string - description: Filter string to search principals. - - name: max_results - in: query - required: false - schema: - type: integer - description: Maximum number of permission assignments to return. - - name: page_token - in: query - required: false - schema: - type: string - description: Page token returned by previous call to retrieve the next page of results. responses: '200': description: Success @@ -2505,16 +2499,10 @@ components: PermissionAssignments: type: object properties: - next_page_token: - type: string permission_assignments: type: array items: $ref: '#/components/schemas/PermissionAssignment' - description: Array of permissions assignments defined for a workspace. - prev_page_token: - type: string - description: Token to retrieve the previous page of results. PermissionOutput: type: object properties: @@ -2961,7 +2949,6 @@ components: - CAN_VIEW - CAN_VIEW_METADATA - IS_OWNER - - UNSPECIFIED description: Permission level RequestAuthzIdentity: type: string @@ -3424,7 +3411,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_account.iam.account_users u, JSON_EACH(u.roles) r - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3436,7 +3422,6 @@ components: r.value->>'value' AS role FROM databricks_account.iam.account_users u, jsonb_array_elements(u.roles::jsonb) AS r - WHERE account_id = '{{ account_id }}' vw_account_group_members: name: vw_account_group_members id: databricks_account.iam.vw_account_group_members @@ -3482,7 +3467,6 @@ components: JSON_EXTRACT(m.value, '$.type') AS member_type FROM databricks_account.iam.account_groups g, JSON_EACH(g.members) m - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3496,7 +3480,6 @@ components: m.value->>'type' AS member_type FROM databricks_account.iam.account_groups g, jsonb_array_elements(g.members::jsonb) AS m - WHERE account_id = '{{ account_id }}' vw_account_group_roles: name: vw_account_group_roles id: databricks_account.iam.vw_account_group_roles @@ -3530,7 +3513,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_account.iam.account_groups g, JSON_EACH(g.roles) r - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3541,7 +3523,6 @@ components: r.value->>'value' AS role FROM databricks_account.iam.account_groups g, jsonb_array_elements(g.roles::jsonb) AS r - WHERE account_id = '{{ account_id }}' vw_account_service_principal_roles: name: vw_account_service_principal_roles id: databricks_account.iam.vw_account_service_principal_roles @@ -3583,7 +3564,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_account.iam.account_service_principals sp, JSON_EACH(sp.roles) r - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3596,7 +3576,6 @@ components: r.value->>'value' AS role FROM databricks_account.iam.account_service_principals sp, jsonb_array_elements(sp.roles::jsonb) AS r - WHERE account_id = '{{ account_id }}' vw_workspace_assignments: name: vw_workspace_assignments id: databricks_account.iam.vw_workspace_assignments @@ -3649,8 +3628,6 @@ components: p.value AS permission FROM databricks_account.iam.workspace_assignment wa, JSON_EACH(wa.permissions) p - WHERE account_id = '{{ account_id }}' - AND workspace_id = '{{ workspace_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3665,8 +3642,6 @@ components: p.value AS permission FROM databricks_account.iam.workspace_assignment wa, jsonb_array_elements(wa.permissions::jsonb) AS p - WHERE account_id = '{{ account_id }}' - AND workspace_id = '{{ workspace_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml b/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml index 1a8d7307..d92605d6 100644 --- a/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml @@ -6,97 +6,103 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.iamv2 servers: - - url: https://accounts.cloud.databricks.com + - url: https://{account_host} + variables: + account_host: + description: >- + The Databricks account console host. Selected by DATABRICKS_CLOUD + (aws, azure or gcp; default aws), or set explicitly with + DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: - /api/2.0/{parent}/account-access-identity-rules: + /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members: post: - operationId: account_iam_v2_create_account_access_identity_rule - summary: >- - Creates a new account access identity rule for a given account. This - allows administrators to + operationId: account_iam_v2_create_direct_group_member + summary: Creates a group membership (assigns a principal to a group). tags: - iamv2 - account_iam_v2 description: >- - Creates a new account access identity rule for a given account. This - allows administrators to + Creates a group membership (assigns a principal to a group). - explicitly allow or deny specific principals from accessing the account. + Authorization: the caller must be an account admin or a manager of the + group (holds the - :param parent: str - Required. The account under which to create the rule. Format: accounts/{account_id} - :param account_access_identity_rule: :class:`AccountAccessIdentityRule` - Required. The rule to create. - :param external_principal_id: str - Required. The external ID of the principal in the customer's IdP. + ``roles/group.manager`` role on it). + + + :param group_id: int + Required. Internal ID of the group in Databricks. + :param direct_group_member: :class:`DirectGroupMember` + Required. The direct group member to be added to the group. - :returns: :class:`AccountAccessIdentityRule` + :returns: :class:`DirectGroupMember` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account under which to create the rule. Format: - accounts/{account_id} - - name: external_principal_id - in: query + - name: group_id + in: path required: true schema: - type: string - description: Required. The external ID of the principal in the customer's IdP. + type: integer + description: Required. Internal ID of the group in Databricks. requestBody: content: application/json: schema: type: object properties: - account_access_identity_rule: - type: object - properties: - action: - type: string - x-enum: - - DENY - description: Currently, only DENY action is supported. - display_name: - type: string - description: Display name of the principal. - external_principal_id: - type: string - description: External ID of the principal in the customer's IdP. - name: - type: string - description: >- - Fully qualified name for the rule. Format: - accounts/{account_id}/account-access-identity-rules/{external_principal_id} - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: >- - The type of the principal (user/service - principal/group). This field is populated by the server - based on the external_principal_id. - required: - - action - description: Required. The rule to create. + principal_id: + type: integer + description: Internal ID of the principal in Databricks. + display_name: + type: string + description: Display name of the principal. + external_id: + type: string + description: The external ID of the principal in the customer's IdP. + group_id: + type: integer + description: The internal ID of the group this member belongs to. + membership_source: + type: string + x-enum: + - IDENTITY_PROVIDER + - INTERNAL + description: >- + The source of group membership (internal or from identity + provider). + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/service principal/group). required: - - account_access_identity_rule + - principal_id responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AccountAccessIdentityRule' + $ref: '#/components/schemas/DirectGroupMember' default: description: Error response content: @@ -110,73 +116,70 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_account_access_identity_rules + operationId: account_iam_v2_list_direct_group_members summary: >- - Lists all account access identity rules for a given account. These rules - control which principals + Lists provisioned direct members of a group with their membership source + (internal or from identity tags: - iamv2 - account_iam_v2 description: >- - Lists all account access identity rules for a given account. These rules - control which principals - - (users, service principals, groups) from the customer's IdP are allowed - or denied access to the + Lists provisioned direct members of a group with their membership source + (internal or from identity - Databricks account. + provider). - :param parent: str - Required. The account for which to list the rules. Format: accounts/{account_id} - :param filter: str (optional) - Optional. Filter to apply to the list. Supports filtering by displayName. + :param group_id: int + Required. Internal ID of the group in Databricks whose direct members are being listed. :param page_size: int (optional) - Optional. The maximum number of rules to return. The service may return fewer than this value. + The maximum number of members to return. The service may return fewer than this value. If not + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) - Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. + A page token, received from a previous ListDirectGroupMembers call. Provide this to retrieve the + subsequent page. - :returns: :class:`ListAccountAccessIdentityRulesResponse` + :returns: Iterator over :class:`DirectGroupMember` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account for which to list the rules. Format: - accounts/{account_id} - - name: filter - in: query - required: false + - name: group_id + in: path + required: true schema: - type: string + type: integer description: >- - Optional. Filter to apply to the list. Supports filtering by - displayName. + Required. Internal ID of the group in Databricks whose direct + members are being listed. - name: page_size in: query required: false schema: type: integer description: >- - Optional. The maximum number of rules to return. The service may - return fewer than this value. + The maximum number of members to return. The service may return + fewer than this value. If not provided, defaults to 1000, which is + also the maximum allowed. Requests for more than the maximum are + clamped to 1000. - name: page_token in: query required: false schema: type: string description: >- - Optional. A page token, received from a previous call. Provide this - to retrieve the subsequent page. + A page token, received from a previous ListDirectGroupMembers call. + Provide this to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListAccountAccessIdentityRulesResponse' + $ref: '#/components/schemas/ListDirectGroupMembersResponse' default: description: Error response content: @@ -189,78 +192,69 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/{parent}/attribute-control-entries: + /api/2.0/identity/accounts/{account_id}/groups: post: - operationId: account_iam_v2_create_attribute_control_entry + operationId: account_iam_v2_create_group summary: >- - Creates (allows) an identity attribute control-list entry for an - account. + Creates a local group in the Databricks account and returns the created + group. A local group is one tags: - iamv2 - account_iam_v2 description: >- - Creates (allows) an identity attribute control-list entry for an - account. + Creates a local group in the Databricks account and returns the created + group. A local group is one + that is not synced from the customer's identity provider, and can be + created whether or not Account - :param parent: str - Required. The account under which to create the entry. Format: accounts/{account_id} - :param attribute_control_entry: :class:`AttributeControlEntry` - Required. The entry to create. - :param attribute_control_entry_id: str (optional) - Optional. The ID to use for the entry, which becomes the last segment of its resource name: the IdP - attribute being governed (e.g. "department"). - - :returns: :class:`AttributeControlEntry` + Identity Management (AIM) is enabled. + + + When AIM is enabled, supplying an external ID returns an error. To + provision the identity from your + + identity provider, resolve it by its external ID with ResolveGroup; to + read an existing external + + identity, use the ExternalGroup resource. + + + :param group: :class:`Group` + Required. Group to be created in Databricks + + :returns: :class:`Group` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account under which to create the entry. Format: - accounts/{account_id} - - name: attribute_control_entry_id - in: query - required: false - schema: - type: string - description: >- - Optional. The ID to use for the entry, which becomes the last - segment of its resource name: the IdP attribute being governed (e.g. - "department"). requestBody: content: application/json: schema: type: object properties: - attribute_control_entry: - type: object - properties: - is_allowed: - type: boolean - description: >- - Whether the attribute is permitted. Always true in the - Identity Attributes PrPr. - name: - type: string - description: >- - The resource name of the entry. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} - where {attribute_name} is the IdP attribute being - governed (e.g. "department"). - description: Required. The entry to create. - required: - - attribute_control_entry + account_id: + type: string + description: The parent account ID for group in Databricks. + external_id: + type: string + description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. + group_name: + type: string + description: Display name of the group. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AttributeControlEntry' + $ref: '#/components/schemas/Group' default: description: Error response content: @@ -274,52 +268,68 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_attribute_control_entries - summary: Lists the identity attribute control-list entries for an account. + operationId: account_iam_v2_list_groups + summary: >- + Lists the groups in the Databricks account, returning one page per call. + Supports filtering by group tags: - iamv2 - account_iam_v2 - description: |- - Lists the identity attribute control-list entries for an account. + description: >- + Lists the groups in the Databricks account, returning one page per call. + Supports filtering by group - :param parent: str - Required. The account for which to list entries. Format: accounts/{account_id} + name or external ID. + + + :param filter: str (optional) + Optional. Allows filtering groups by group name or external id. :param page_size: int (optional) - Optional. The maximum number of entries to return. + The maximum number of groups to return. The service may return fewer than this value. If not + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) - Optional. A page token from a previous call, to retrieve the next page. + A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent + page. - :returns: :class:`ListAttributeControlEntriesResponse` + :returns: Iterator over :class:`Group` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account for which to list entries. Format: - accounts/{account_id} + - name: filter + in: query + required: false + schema: + type: string + description: Optional. Allows filtering groups by group name or external id. - name: page_size in: query required: false schema: type: integer - description: Optional. The maximum number of entries to return. + description: >- + The maximum number of groups to return. The service may return fewer + than this value. If not provided, defaults to 1000, which is also + the maximum allowed. Requests for more than the maximum are clamped + to 1000. - name: page_token in: query required: false schema: type: string description: >- - Optional. A page token from a previous call, to retrieve the next - page. + A page token, received from a previous ListGroups call. Provide this + to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListAttributeControlEntriesResponse' + $ref: '#/components/schemas/ListGroupsResponse' default: description: Error response content: @@ -332,81 +342,137 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members: + /api/2.0/identity/accounts/{account_id}/identity-visibility-filters: post: - operationId: account_iam_v2_create_direct_group_member - summary: Creates a group membership (assigns a principal to a group). + operationId: account_iam_v2_create_identity_visibility_filter + summary: >- + Creates a group visibility filter in the account. Requires account admin + privileges. Set tags: - iamv2 - account_iam_v2 - description: |- - Creates a group membership (assigns a principal to a group). + description: >- + Creates a group visibility filter in the account. Requires account admin + privileges. Set - :param group_id: int - Required. Internal ID of the group in Databricks. - :param direct_group_member: :class:`DirectGroupMember` - Required. The direct group member to be added to the group. + ``principal_type`` to ``GROUP`` and specify exactly one of ``exact`` + (external ID), ``prefix`` - :returns: :class:`DirectGroupMember` + (display-name starts with), or ``regex`` (full RE2 display-name match). + The filter applies across all + + workspaces in the account. A duplicate filter ID or an existing rule + with the same type and match + + value returns ``ALREADY_EXISTS``. Filters are immutable; to change a + rule, delete it and create a new + + one. + + + :param parent: str + Required. The parent account. Format: accounts/{account_id} + :param identity_visibility_filter: :class:`IdentityVisibilityFilter` + Required. The filter to create. Set ``principal_type`` to ``GROUP`` and specify exactly one of + ``exact``, ``prefix``, or ``regex``. The server assigns the resource name; any supplied ``name`` is + ignored. + :param identity_visibility_filter_id: str (optional) + Optional. The ID to use for the filter, which becomes the final component of its resource name. If + not specified or empty, the server generates one. Must not contain ``/``. + + :returns: :class:`IdentityVisibilityFilter` parameters: - name: account_id in: path required: true schema: type: string - - name: group_id - in: path - required: true + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). Required. The parent account. Format: + accounts/{account_id} + - name: identity_visibility_filter_id + in: query + required: false schema: - type: integer - description: Required. Internal ID of the group in Databricks. + type: string + description: >- + Optional. The ID to use for the filter, which becomes the final + component of its resource name. If not specified or empty, the + server generates one. Must not contain ``/``. requestBody: content: application/json: schema: type: object properties: - direct_group_member: + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: >- + The type of principal this rule applies to. Set to ``GROUP`` + when creating a filter. Other principal types are not + supported for creation. + exact: type: object properties: - principal_id: - type: integer - description: Internal ID of the principal in Databricks. - display_name: - type: string - description: Display name of the principal. external_id: type: string - description: The external ID of the principal in Databricks. - membership_source: + description: >- + The identity provider's external ID for the group to + match. This is not the Databricks group ID. The value + must be non-empty and is matched exactly, including + case. + required: + - external_id + description: >- + Exact match on the group's external ID from the identity + provider. + name: + type: string + description: >- + The resource name of the identity-visibility filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} + prefix: + type: object + properties: + display_name_prefix: type: string - x-enum: - - IDENTITY_PROVIDER - - INTERNAL description: >- - The source of group membership (internal or from - identity provider). - principal_type: + The display-name prefix to match. Must contain at least + one non-whitespace character. Leading and trailing + whitespace are preserved, and matching is + case-sensitive. + required: + - display_name_prefix + description: >- + Case-sensitive starts-with match on the group's display + name. + regex: + type: object + properties: + display_name_regex: type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER description: >- - The type of the principal (user/service - principal/group). + The RE2 regular expression matched against the complete + display name. required: - - principal_id - description: Required. The direct group member to be added to the group. + - display_name_regex + description: >- + Full, case-sensitive RE2 match on the identity's display + name. required: - - direct_group_member + - principal_type responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/DirectGroupMember' + $ref: '#/components/schemas/IdentityVisibilityFilter' default: description: Error response content: @@ -420,68 +486,70 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_direct_group_members + operationId: account_iam_v2_list_identity_visibility_filters summary: >- - Lists provisioned direct members of a group with their membership source - (internal or from identity + Lists group visibility filters in the account, returning one page per + call. Requires account admin tags: - iamv2 - account_iam_v2 description: >- - Lists provisioned direct members of a group with their membership source - (internal or from identity + Lists group visibility filters in the account, returning one page per + call. Requires account admin - provider). + privileges. Returns filter rules, not the groups matched by those rules. + To retrieve the next page, + pass the response's ``next_page_token`` as ``page_token`` in the next + request. If ``next_page_token`` - :param group_id: int - Required. Internal ID of the group in Databricks whose direct members are being listed. + is omitted, there are no more pages. + + + :param parent: str + Required. The parent account. Format: accounts/{account_id} :param page_size: int (optional) - The maximum number of members to return. The service may return fewer than this value. If not - provided, defaults to 1000 (also the maximum allowed). + The maximum number of filters to return. The service may return fewer than this value. If omitted or + non-positive, defaults to 100. Values above 1000 are reduced to 1000. :param page_token: str (optional) - A page token, received from a previous ListDirectGroupMembers call. Provide this to retrieve the - subsequent page. + A page token, received from a previous ListIdentityVisibilityFilters call. Provide this to retrieve + the subsequent page. - :returns: :class:`ListDirectGroupMembersResponse` + :returns: Iterator over :class:`IdentityVisibilityFilter` parameters: - name: account_id in: path required: true schema: type: string - - name: group_id - in: path - required: true - schema: - type: integer description: >- - Required. Internal ID of the group in Databricks whose direct - members are being listed. + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). Required. The parent account. Format: + accounts/{account_id} - name: page_size in: query required: false schema: type: integer description: >- - The maximum number of members to return. The service may return - fewer than this value. If not provided, defaults to 1000 (also the - maximum allowed). + The maximum number of filters to return. The service may return + fewer than this value. If omitted or non-positive, defaults to 100. + Values above 1000 are reduced to 1000. - name: page_token in: query required: false schema: type: string description: >- - A page token, received from a previous ListDirectGroupMembers call. - Provide this to retrieve the subsequent page. + A page token, received from a previous ListIdentityVisibilityFilters + call. Provide this to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListDirectGroupMembersResponse' + $ref: '#/components/schemas/ListIdentityVisibilityFiltersResponse' default: description: Error response content: @@ -494,24 +562,38 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/groups: + /api/2.0/identity/accounts/{account_id}/service-principals: post: - operationId: account_iam_v2_create_group + operationId: account_iam_v2_create_service_principal summary: >- - Creates a group in the Databricks account and returns the resulting - Group resource. + Creates a local service principal in the Databricks account and returns + the created service principal. tags: - iamv2 - account_iam_v2 description: >- - Creates a group in the Databricks account and returns the resulting - Group resource. + Creates a local service principal in the Databricks account and returns + the created service principal. + A local service principal is one that is not synced from the customer's + identity provider, and can be - :param group: :class:`Group` - Required. Group to be created in + created whether or not Account Identity Management (AIM) is enabled. - :returns: :class:`Group` + + When AIM is enabled, supplying an external ID returns an error. To + provision the identity from your + + identity provider, resolve it by its external ID with + ResolveServicePrincipal; to read an existing + + external identity, use the ExternalServicePrincipal resource. + + + :param service_principal: :class:`ServicePrincipal` + Required. Service principal to be created in Databricks + + :returns: :class:`ServicePrincipal` parameters: - name: account_id in: path @@ -524,31 +606,46 @@ paths: schema: type: object properties: - group: - type: object - properties: - account_id: - type: string - description: The parent account ID for group in Databricks. - external_id: - type: string - description: ExternalId of the group in the customer's IdP. - group_name: - type: string - description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. - description: Required. Group to be created in + display_name: + type: string + description: Display name of the service principal. + account_sp_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: >- + The activity status of a service principal in a Databricks + account. + account_id: + type: string + description: >- + The parent account ID for the service principal in + Databricks. + application_id: + type: string + description: >- + Application ID of the service principal. Set at creation + time and cannot be changed afterwards; when omitted, the + server generates one. + external_id: + type: string + description: ExternalId of the service principal in the customer's IdP. + service_principal_id: + type: string + description: >- + Internal service principal ID of the service principal in + Databricks. required: - - group + - display_name + - account_sp_status responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Group' + $ref: '#/components/schemas/ServicePrincipal' default: description: Error response content: @@ -562,29 +659,31 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_groups + operationId: account_iam_v2_list_service_principals summary: >- - Lists the groups in the Databricks account, returning one page per call. - Supports filtering by group + Lists the service principals in the Databricks account, returning one + page per call. Supports tags: - iamv2 - account_iam_v2 description: >- - Lists the groups in the Databricks account, returning one page per call. - Supports filtering by group + Lists the service principals in the Databricks account, returning one + page per call. Supports - name or external ID. + filtering by application ID or external ID. :param filter: str (optional) - Optional. Allows filtering groups by group name or external id. + Optional. Allows filtering service principals by application id or external id. :param page_size: int (optional) - The maximum number of groups to return. The service may return fewer than this value. + The maximum number of service principals to return. The service may return fewer than this value. If + not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. :param page_token: str (optional) - A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent - page. + A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the + subsequent page. - :returns: :class:`ListGroupsResponse` + :returns: Iterator over :class:`ServicePrincipal` parameters: - name: account_id in: path @@ -596,30 +695,34 @@ paths: required: false schema: type: string - description: Optional. Allows filtering groups by group name or external id. + description: >- + Optional. Allows filtering service principals by application id or + external id. - name: page_size in: query required: false schema: type: integer description: >- - The maximum number of groups to return. The service may return fewer - than this value. + The maximum number of service principals to return. The service may + return fewer than this value. If not provided, defaults to 1000, + which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. - name: page_token in: query required: false schema: type: string description: >- - A page token, received from a previous ListGroups call. Provide this - to retrieve the subsequent page. + A page token, received from a previous ListServicePrincipals call. + Provide this to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListGroupsResponse' + $ref: '#/components/schemas/ListServicePrincipalsResponse' default: description: Error response content: @@ -632,26 +735,38 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/service-principals: + /api/2.0/identity/accounts/{account_id}/users: post: - operationId: account_iam_v2_create_service_principal + operationId: account_iam_v2_create_user summary: >- - Creates a service principal in the Databricks account and returns the - resulting ServicePrincipal + Creates a local user in the Databricks account and returns the created + user. A local user is one that tags: - iamv2 - account_iam_v2 description: >- - Creates a service principal in the Databricks account and returns the - resulting ServicePrincipal + Creates a local user in the Databricks account and returns the created + user. A local user is one that - resource. + is not synced from the customer's identity provider, and can be created + whether or not Account + Identity Management (AIM) is enabled. - :param service_principal: :class:`ServicePrincipal` - Required. Service principal to be created in - :returns: :class:`ServicePrincipal` + When AIM is enabled, supplying an external ID returns an error. To + provision the identity from your + + identity provider, resolve it by its external ID with ResolveUser; to + read an existing external + + identity, use the ExternalUser resource. + + + :param user: :class:`User` + Required. User to be created in Databricks + + :returns: :class:`User` parameters: - name: account_id in: path @@ -664,48 +779,42 @@ paths: schema: type: object properties: - service_principal: + username: + type: string + description: Username/email of the user. + full_name: type: object properties: - account_id: - type: string - description: >- - The parent account ID for the service principal in - Databricks. - account_sp_status: + family_name: type: string - x-enum: - - ACTIVE - - INACTIVE - description: >- - The activity status of a service principal in a - Databricks account. - application_id: - type: string - description: Application ID of the service principal. - display_name: - type: string - description: Display name of the service principal. - external_id: + given_name: type: string - description: >- - ExternalId of the service principal in the customer's - IdP. - internal_id: - type: string - description: >- - Internal service principal ID of the service principal - in Databricks. - description: Required. Service principal to be created in + account_user_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. + external_id: + type: string + description: ExternalId of the user in the customer's IdP. + user_id: + type: string + description: Internal userId of the user in Databricks. required: - - service_principal + - username + - full_name + - account_user_status responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ServicePrincipal' + $ref: '#/components/schemas/User' default: description: Error response content: @@ -719,29 +828,30 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_service_principals + operationId: account_iam_v2_list_users summary: >- - Lists the service principals in the Databricks account, returning one - page per call. Supports + Lists the users in the Databricks account, returning one page per call. + Supports filtering by username tags: - iamv2 - account_iam_v2 description: >- - Lists the service principals in the Databricks account, returning one - page per call. Supports + Lists the users in the Databricks account, returning one page per call. + Supports filtering by username - filtering by application ID or external ID. + or external ID. :param filter: str (optional) - Optional. Allows filtering service principals by application id or external id. + Optional. Allows filtering users by username or external id. :param page_size: int (optional) - The maximum number of service principals to return. The service may return fewer than this value. + The maximum number of users to return. The service may return fewer than this value. If not + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) - A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the - subsequent page. + A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. - :returns: :class:`ListServicePrincipalsResponse` + :returns: Iterator over :class:`User` parameters: - name: account_id in: path @@ -753,32 +863,32 @@ paths: required: false schema: type: string - description: >- - Optional. Allows filtering service principals by application id or - external id. + description: Optional. Allows filtering users by username or external id. - name: page_size in: query required: false schema: type: integer description: >- - The maximum number of service principals to return. The service may - return fewer than this value. + The maximum number of users to return. The service may return fewer + than this value. If not provided, defaults to 1000, which is also + the maximum allowed. Requests for more than the maximum are clamped + to 1000. - name: page_token in: query required: false schema: type: string description: >- - A page token, received from a previous ListServicePrincipals call. - Provide this to retrieve the subsequent page. + A page token, received from a previous ListUsers call. Provide this + to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListServicePrincipalsResponse' + $ref: '#/components/schemas/ListUsersResponse' default: description: Error response content: @@ -791,84 +901,223 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/users: + /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments: post: - operationId: account_iam_v2_create_user + operationId: account_iam_v2_create_workspace_assignment summary: >- - Creates a user in the Databricks account and returns the resulting User - resource. Behavior depends on + Creates a workspace assignment for a principal. Entitlements are granted + one at a time rather than tags: - iamv2 - account_iam_v2 description: >- - Creates a user in the Databricks account and returns the resulting User - resource. Behavior depends on + Creates a workspace assignment for a principal. Entitlements are granted + one at a time rather than - whether Account Identity Management (AIM) is enabled: + atomically. If the request fails partway through, the principal stays + assigned to the workspace with + only some of the requested entitlements. Get the assignment afterwards + to confirm which entitlements - - When AIM is enabled: the user is provisioned with an internalId. If an - externalId is provided, the - identity provider is treated as the source of truth for user metadata, and customer-supplied field - values may be overridden. - - When AIM is disabled: the user is provisioned with an internalId only, - and customer-supplied - metadata is used as-is. + were granted. - :param user: :class:`User` - Required. User to be created in - :returns: :class:`User` + :param workspace_id: int + Required. The workspace ID for which the workspace assignment is being created. + :param workspace_assignment: :class:`WorkspaceAssignment` + Required. Workspace assignment to be created in Databricks. + + :returns: :class:`WorkspaceAssignment` parameters: - name: account_id in: path required: true schema: type: string + - name: workspace_id + in: path + required: true + schema: + type: integer + description: >- + Required. The workspace ID for which the workspace assignment is + being created. requestBody: content: application/json: schema: type: object properties: - user: - type: object - properties: - account_id: - type: string - description: The accountId parent of the user in Databricks. - account_user_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a user in a Databricks account. - external_id: - type: string - description: ExternalId of the user in the customer's IdP. - full_name: - type: object - properties: - family_name: - type: string - given_name: - type: string - internal_id: - type: string - description: Internal userId of the user in Databricks. - username: - type: string - description: Username/email of the user. - description: Required. User to be created in + principal_id: + type: integer + description: >- + The internal ID of the principal (user/sp/group) in + Databricks. + account_id: + type: string + description: >- + The account ID parent of the workspace where the principal + is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + description: >- + Every entitlement the principal holds in this workspace, + whether granted directly or through group membership. Get + responses populate this field. List responses leave it + empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + description: >- + Entitlements granted directly to the principal on this + workspace. This is the only client-settable field. Create + and update manage exactly this set, including entitlements + the principal also holds through a group. List responses + leave this field empty. Get a single principal to read its + entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: >- + The type of the principal (user/service principal/group) + that is assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - user + - principal_id responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/WorkspaceAssignment' default: description: Error response content: @@ -882,63 +1131,73 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_list_users + operationId: account_iam_v2_list_workspace_assignments summary: >- - Lists the users in the Databricks account, returning one page per call. - Supports filtering by username + Lists workspace assignments for a workspace. The response omits the + per-principal entitlement fields tags: - iamv2 - account_iam_v2 description: >- - Lists the users in the Databricks account, returning one page per call. - Supports filtering by username + Lists workspace assignments for a workspace. The response omits the + per-principal entitlement fields - or external ID. + (``entitlements`` and ``effective_entitlements``). To read the + entitlements for a single principal, + get that principal's assignment. - :param filter: str (optional) - Optional. Allows filtering users by username or external id. + + :param workspace_id: int + Required. The workspace ID for which the workspace assignments are being fetched. :param page_size: int (optional) - The maximum number of users to return. The service may return fewer than this value. + The maximum number of workspace assignments to return. The service may return fewer than this value. + If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. :param page_token: str (optional) - A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. + A page token, received from a previous ListWorkspaceAssignments call. Provide this to retrieve the + subsequent page. - :returns: :class:`ListUsersResponse` + :returns: Iterator over :class:`WorkspaceAssignment` parameters: - name: account_id in: path required: true schema: type: string - - name: filter - in: query - required: false + - name: workspace_id + in: path + required: true schema: - type: string - description: Optional. Allows filtering users by username or external id. + type: integer + description: >- + Required. The workspace ID for which the workspace assignments are + being fetched. - name: page_size in: query required: false schema: type: integer description: >- - The maximum number of users to return. The service may return fewer - than this value. + The maximum number of workspace assignments to return. The service + may return fewer than this value. If not provided, defaults to 1000, + which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. - name: page_token in: query required: false schema: type: string description: >- - A page token, received from a previous ListUsers call. Provide this - to retrieve the subsequent page. + A page token, received from a previous ListWorkspaceAssignments + call. Provide this to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListUsersResponse' + $ref: '#/components/schemas/ListWorkspaceAssignmentsResponse' default: description: Error response content: @@ -954,29 +1213,17 @@ paths: /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-assignment-details: post: operationId: account_iam_v2_create_workspace_assignment_detail - summary: >- - Creates a workspace assignment detail for a principal. Entitlement - grants are applied individually and + summary: Creates a workspace assignment detail for a principal. tags: - iamv2 - account_iam_v2 - description: >- - Creates a workspace assignment detail for a principal. Entitlement - grants are applied individually and - - non-atomically — if a failure occurs partway through, the principal will - be assigned to the - - workspace but with only a subset of the requested entitlements. Use - GetWorkspaceAssignmentDetail to - - confirm which entitlements were successfully granted. - + description: |- + Creates a workspace assignment detail for a principal. :param workspace_id: int Required. The workspace ID for which the workspace assignment detail is being created. :param workspace_assignment_detail: :class:`WorkspaceAssignmentDetail` - Required. Workspace assignment detail to be created in . + Required. Workspace assignment detail to be created in Databricks. :returns: :class:`WorkspaceAssignmentDetail` parameters: @@ -999,175 +1246,166 @@ paths: schema: type: object properties: - workspace_assignment_detail: - type: object - properties: - principal_id: - type: integer - description: >- - The internal ID of the principal (user/sp/group) in - Databricks. - account_id: - type: string - description: >- - The account ID parent of the workspace where the - principal is assigned - effective_entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: >- - Create a collection of name/value pairs. + principal_id: + type: integer + description: >- + The internal ID of the principal (user/sp/group) in + Databricks. + account_id: + type: string + description: >- + The account ID parent of the workspace where the principal + is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members can - have their own + Methods can be added to enumerations, and members can have + their own - attributes -- see the documentation for details. - description: >- - The principal's full effective entitlements granted in - this workspace: every entitlement it holds whether - granted directly or via group membership. Populated on - Get; empty on List. - entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + description: >- + Every entitlement the principal holds in this workspace, + whether granted directly or through group membership. Get + responses populate this field. List responses leave it + empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members can - have their own + Methods can be added to enumerations, and members can have + their own - attributes -- see the documentation for details. - description: >- - Entitlements granted directly to the principal on this - workspace. The only client-settable field: create and - update manage exactly this set (including entitlements - the principal also holds via a group). Not populated by - ListWorkspaceAssignmentDetails (omitted for - scalability); call GetWorkspaceAssignmentDetail to read - the entitlements for a single principal. - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/sp/group). - workspace_id: - type: integer - description: The workspace ID where the principal is assigned - required: - - principal_id + attributes -- see the documentation for details. description: >- - Required. Workspace assignment detail to be created in - . + Entitlements granted directly to the principal on this + workspace. This is the only client-settable field. Create + and update manage exactly this set, including entitlements + the principal also holds through a group. List responses + leave this field empty. Get a single principal to read its + entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/sp/group). + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - workspace_assignment_detail + - principal_id responses: '200': description: Success @@ -1190,32 +1428,32 @@ paths: get: operationId: account_iam_v2_list_workspace_assignment_details summary: >- - Lists workspace assignment details for a workspace. For scalability, the - response omits the + Lists workspace assignment details for a workspace. The response omits + the per-principal entitlement tags: - iamv2 - account_iam_v2 description: >- - Lists workspace assignment details for a workspace. For scalability, the - response omits the + Lists workspace assignment details for a workspace. The response omits + the per-principal entitlement - per-principal entitlement fields (``entitlements`` and - ``effective_entitlements``); call + fields (``entitlements`` and ``effective_entitlements``). To read the + entitlements for a single - GetWorkspaceAssignmentDetail to read entitlements for a single - principal. + principal, get that principal's assignment detail. :param workspace_id: int Required. The workspace ID for which the workspace assignment details are being fetched. :param page_size: int (optional) The maximum number of workspace assignment details to return. The service may return fewer than this - value. + value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than + the maximum are clamped to 1000. :param page_token: str (optional) A page token, received from a previous ListWorkspaceAssignmentDetails call. Provide this to retrieve the subsequent page. - :returns: :class:`ListWorkspaceAssignmentDetailsResponse` + :returns: Iterator over :class:`WorkspaceAssignmentDetail` parameters: - name: account_id in: path @@ -1237,7 +1475,9 @@ paths: type: integer description: >- The maximum number of workspace assignment details to return. The - service may return fewer than this value. + service may return fewer than this value. If not provided, defaults + to 1000, which is also the maximum allowed. Requests for more than + the maximum are clamped to 1000. - name: page_token in: query required: false @@ -1266,37 +1506,47 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/{parent}/account-access-identity-rules/{external_principal_id}: + /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}: delete: - operationId: account_iam_v2_delete_account_access_identity_rule - summary: Deletes an account access identity rule for a given principal. + operationId: account_iam_v2_delete_direct_group_member + summary: Deletes a group membership (unassigns a principal from a group). tags: - iamv2 - account_iam_v2 - description: |- - Deletes an account access identity rule for a given principal. + description: >- + Deletes a group membership (unassigns a principal from a group). - :param parent: str - Required. The account for which to delete the rule. Format: accounts/{account_id} - :param external_principal_id: str - Required. The external ID of the principal whose rule should be deleted. + + Authorization: the caller must be an account admin or a manager of the + group (holds the + + ``roles/group.manager`` role on it). + + + :param group_id: int + Required. Internal ID of the group in Databricks. + :param principal_id: int + Required. Internal ID of the principal to be unassigned from the group. parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account for which to delete the rule. Format: - accounts/{account_id} - - name: external_principal_id + - name: group_id in: path required: true schema: - type: string + type: integer + description: Required. Internal ID of the group in Databricks. + - name: principal_id + in: path + required: true + schema: + type: integer description: >- - Required. The external ID of the principal whose rule should be - deleted. + Required. Internal ID of the principal to be unassigned from the + group. responses: '200': description: Success @@ -1313,44 +1563,47 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_account_access_identity_rule - summary: Gets an account access identity rule for a given principal. + operationId: account_iam_v2_get_direct_group_member + summary: Gets a provisioned direct member of a group. tags: - iamv2 - account_iam_v2 description: |- - Gets an account access identity rule for a given principal. + Gets a provisioned direct member of a group. - :param parent: str - Required. The account for which to get the rule. Format: accounts/{account_id} - :param external_principal_id: str - Required. The external ID of the principal whose rule should be retrieved. + :param group_id: int + Required. Internal ID of the group in Databricks. + :param principal_id: int + Required. Internal ID of the principal belonging to the group in Databricks. - :returns: :class:`AccountAccessIdentityRule` + :returns: :class:`DirectGroupMember` parameters: - - name: parent + - name: account_id in: path required: true schema: type: string - description: >- - Required. The account for which to get the rule. Format: - accounts/{account_id} - - name: external_principal_id + - name: group_id in: path required: true schema: - type: string - description: >- - Required. The external ID of the principal whose rule should be - retrieved. - responses: - '200': - description: Success - content: + type: integer + description: Required. Internal ID of the group in Databricks. + - name: principal_id + in: path + required: true + schema: + type: integer + description: >- + Required. Internal ID of the principal belonging to the group in + Databricks. + responses: + '200': + description: Success + content: application/json: schema: - $ref: '#/components/schemas/AccountAccessIdentityRule' + $ref: '#/components/schemas/DirectGroupMember' default: description: Error response content: @@ -1363,28 +1616,37 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/{name}: + /api/2.0/identity/accounts/{account_id}/groups/{group_id}: delete: - operationId: account_iam_v2_delete_attribute_control_entry - summary: Deletes an identity attribute control-list entry. + operationId: account_iam_v2_delete_group + summary: Deletes a group from the Databricks account by its internal ID. tags: - iamv2 - account_iam_v2 - description: |- - Deletes an identity attribute control-list entry. + description: >- + Deletes a group from the Databricks account by its internal ID. - :param name: str - Required. The resource name of the entry to delete. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} + + Authorization: the caller must be an account admin or a manager of the + group (holds the + + ``roles/group.manager`` role on it). + + + :param group_id: str + Required. Internal ID of the group in Databricks. parameters: - - name: name + - name: account_id in: path required: true schema: type: string - description: >- - Required. The resource name of the entry to delete. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} + - name: group_id + in: path + required: true + schema: + type: string + description: Required. Internal ID of the group in Databricks. responses: '200': description: Success @@ -1401,35 +1663,37 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_attribute_control_entry - summary: Gets an identity attribute control-list entry. + operationId: account_iam_v2_get_group + summary: Fetches a group from the Databricks account by its internal ID. tags: - iamv2 - account_iam_v2 description: |- - Gets an identity attribute control-list entry. + Fetches a group from the Databricks account by its internal ID. - :param name: str - Required. The resource name of the entry to get. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} + :param group_id: str + Required. Internal ID of the group in Databricks. - :returns: :class:`AttributeControlEntry` + :returns: :class:`Group` parameters: - - name: name + - name: account_id in: path required: true schema: type: string - description: >- - Required. The resource name of the entry to get. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} + - name: group_id + in: path + required: true + schema: + type: string + description: Required. Internal ID of the group in Databricks. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AttributeControlEntry' + $ref: '#/components/schemas/Group' default: description: Error response content: @@ -1443,78 +1707,89 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API patch: - operationId: account_iam_v2_update_attribute_control_entry - summary: Updates an identity attribute control-list entry for an account. + operationId: account_iam_v2_update_group + summary: >- + Updates an existing group in the Databricks account. Only the fields + named in the update mask are tags: - iamv2 - account_iam_v2 - description: |- - Updates an identity attribute control-list entry for an account. + description: >- + Updates an existing group in the Databricks account. Only the fields + named in the update mask are - :param name: str - The resource name of the entry. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} where {attribute_name} is the IdP - attribute being governed (e.g. "department"). - :param attribute_control_entry: :class:`AttributeControlEntry` - Required. The entry to update; its ``name`` identifies the existing entry. - :param update_mask: FieldMask - Required. The fields to update. For the PrPr only is_allowed is mutable, so the backend currently - applies the full entry regardless of the mask. + modified. Returns the updated Group resource. + + + When AIM is enabled and the group is an external identity (its + external_id is set), only external_id + + can be updated; its other fields are sourced from your identity + provider. With AIM and group + + visibility filters, a new nonempty external_id must identify a visible + group. Clearing external_id is + + allowed. - :returns: :class:`AttributeControlEntry` + + Authorization: the caller must be an account admin or a manager of the + group (holds the + + ``roles/group.manager`` role on it). + + + :param group_id: str + Required. Internal ID of the group in Databricks. + :param group: :class:`Group` + Required. Group to be updated in Databricks + :param update_mask: str + Required. The list of fields to update. + + :returns: :class:`Group` parameters: - - name: name + - name: account_id in: path required: true schema: type: string - description: >- - The resource name of the entry. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} - where {attribute_name} is the IdP attribute being governed (e.g. - "department"). + - name: group_id + in: path + required: true + schema: + type: string + description: Required. Internal ID of the group in Databricks. - name: update_mask in: query required: true schema: - type: object - description: >- - Required. The fields to update. For the PrPr only is_allowed is - mutable, so the backend currently applies the full entry regardless - of the mask. + type: string + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - attribute_control_entry: - type: object - properties: - is_allowed: - type: boolean - description: >- - Whether the attribute is permitted. Always true in the - Identity Attributes PrPr. - name: - type: string - description: >- - The resource name of the entry. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} - where {attribute_name} is the IdP attribute being - governed (e.g. "department"). - description: >- - Required. The entry to update; its ``name`` identifies the - existing entry. - required: - - attribute_control_entry + account_id: + type: string + description: The parent account ID for group in Databricks. + external_id: + type: string + description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. + group_name: + type: string + description: Display name of the group. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AttributeControlEntry' + $ref: '#/components/schemas/Group' default: description: Error response content: @@ -1527,40 +1802,56 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}: + /api/2.0/identity/accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}: delete: - operationId: account_iam_v2_delete_direct_group_member - summary: Deletes a group membership (unassigns a principal from a group). + operationId: account_iam_v2_delete_identity_visibility_filter + summary: >- + Deletes a group visibility filter by its resource name. Requires account + admin privileges. Deleting a tags: - iamv2 - account_iam_v2 - description: |- - Deletes a group membership (unassigns a principal from a group). + description: >- + Deletes a group visibility filter by its resource name. Requires account + admin privileges. Deleting a - :param group_id: int - Required. Internal ID of the group in Databricks. - :param principal_id: int - Required. Internal ID of the principal to be unassigned from the group. + filter does not delete groups or revoke access. Groups covered only by + this rule stop being + + discoverable unless they or a transitive parent are already provisioned + in the account. If no group + + filters remain, all groups become visible again. Deleting a filter that + does not exist succeeds + + without making any changes. + + + :param name: str + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} parameters: - name: account_id in: path required: true schema: type: string - - name: group_id - in: path - required: true - schema: - type: integer - description: Required. Internal ID of the group in Databricks. - - name: principal_id + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`). + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} + - name: identity_visibility_filter_id in: path required: true schema: - type: integer + type: string description: >- - Required. Internal ID of the principal to be unassigned from the - group. + The `identity_visibility_filter_id` segment of the `name` resource + name + (`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`). + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} responses: '200': description: Success @@ -1577,47 +1868,54 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_direct_group_member - summary: Gets a provisioned direct member of a group. + operationId: account_iam_v2_get_identity_visibility_filter + summary: >- + Gets a group visibility filter by its resource name. Requires account + admin privileges. Returns the tags: - iamv2 - account_iam_v2 - description: |- - Gets a provisioned direct member of a group. + description: >- + Gets a group visibility filter by its resource name. Requires account + admin privileges. Returns the - :param group_id: int - Required. Internal ID of the group in Databricks. - :param principal_id: int - Required. Internal ID of the principal belonging to the group in Databricks. + filter rule, not the groups matched by the rule. - :returns: :class:`DirectGroupMember` + + :param name: str + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} + + :returns: :class:`IdentityVisibilityFilter` parameters: - name: account_id in: path required: true schema: type: string - - name: group_id - in: path - required: true - schema: - type: integer - description: Required. Internal ID of the group in Databricks. - - name: principal_id + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`). + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} + - name: identity_visibility_filter_id in: path required: true schema: - type: integer + type: string description: >- - Required. Internal ID of the principal belonging to the group in - Databricks. + The `identity_visibility_filter_id` segment of the `name` resource + name + (`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`). + Required. The resource name of the filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/DirectGroupMember' + $ref: '#/components/schemas/IdentityVisibilityFilter' default: description: Error response content: @@ -1630,30 +1928,34 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/groups/{internal_id}: + /api/2.0/identity/accounts/{account_id}/service-principals/{service_principal_id}: delete: - operationId: account_iam_v2_delete_group - summary: Deletes a group from the Databricks account by its internal ID. + operationId: account_iam_v2_delete_service_principal + summary: >- + Deletes a service principal from the Databricks account by its internal + ID. tags: - iamv2 - account_iam_v2 - description: |- - Deletes a group from the Databricks account by its internal ID. + description: >- + Deletes a service principal from the Databricks account by its internal + ID. - :param internal_id: str - Required. Internal ID of the group in Databricks. + + :param service_principal_id: str + Required. Internal ID of the service principal in Databricks. parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: service_principal_id in: path required: true schema: type: string - description: Required. Internal ID of the group in Databricks. + description: Required. Internal ID of the service principal in Databricks. responses: '200': description: Success @@ -1670,37 +1972,41 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_group - summary: Fetches a group from the Databricks account by its internal ID. + operationId: account_iam_v2_get_service_principal + summary: >- + Fetches a service principal from the Databricks account by its internal + ID. tags: - iamv2 - account_iam_v2 - description: |- - Fetches a group from the Databricks account by its internal ID. + description: >- + Fetches a service principal from the Databricks account by its internal + ID. - :param internal_id: str - Required. Internal ID of the group in Databricks. - :returns: :class:`Group` + :param service_principal_id: str + Required. Internal ID of the service principal in Databricks. + + :returns: :class:`ServicePrincipal` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: service_principal_id in: path required: true schema: type: string - description: Required. Internal ID of the group in Databricks. + description: Required. Internal ID of the service principal in Databricks. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Group' + $ref: '#/components/schemas/ServicePrincipal' default: description: Error response content: @@ -1714,77 +2020,103 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API patch: - operationId: account_iam_v2_update_group + operationId: account_iam_v2_update_service_principal summary: >- - Updates an existing group in the Databricks account. Only the fields - named in the update mask are + Updates an existing service principal in the Databricks account. Only + the fields named in the update tags: - iamv2 - account_iam_v2 description: >- - Updates an existing group in the Databricks account. Only the fields - named in the update mask are + Updates an existing service principal in the Databricks account. Only + the fields named in the update - modified. Returns the updated Group resource. + mask are modified. Returns the updated ServicePrincipal resource. - :param internal_id: str - Required. Internal ID of the group in Databricks. - :param group: :class:`Group` - Required. Group to be updated in + For locally managed service principals, is_agent must be set to true or + false when updated. + + + When AIM is enabled and the service principal is an external identity + (its external_id is set), only + + external_id can be updated; its other fields are sourced from your + identity provider. + + + :param service_principal_id: str + Required. Internal ID of the service principal in Databricks. + :param service_principal: :class:`ServicePrincipal` + Required. Service Principal to be updated in Databricks :param update_mask: str - Optional. The list of fields to update. + Required. The list of fields to update. - :returns: :class:`Group` + :returns: :class:`ServicePrincipal` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: service_principal_id in: path required: true schema: type: string - description: Required. Internal ID of the group in Databricks. + description: Required. Internal ID of the service principal in Databricks. - name: update_mask in: query required: true schema: type: string - description: Optional. The list of fields to update. + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - group: - type: object - properties: - account_id: - type: string - description: The parent account ID for group in Databricks. - external_id: - type: string - description: ExternalId of the group in the customer's IdP. - group_name: - type: string - description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. - description: Required. Group to be updated in + display_name: + type: string + description: Display name of the service principal. + account_sp_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: >- + The activity status of a service principal in a Databricks + account. + account_id: + type: string + description: >- + The parent account ID for the service principal in + Databricks. + application_id: + type: string + description: >- + Application ID of the service principal. Set at creation + time and cannot be changed afterwards; when omitted, the + server generates one. + external_id: + type: string + description: ExternalId of the service principal in the customer's IdP. + service_principal_id: + type: string + description: >- + Internal service principal ID of the service principal in + Databricks. required: - - group + - display_name + - account_sp_status responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Group' + $ref: '#/components/schemas/ServicePrincipal' default: description: Error response content: @@ -1797,34 +2129,30 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/service-principals/{internal_id}: + /api/2.0/identity/accounts/{account_id}/users/{user_id}: delete: - operationId: account_iam_v2_delete_service_principal - summary: >- - Deletes a service principal from the Databricks account by its internal - ID. + operationId: account_iam_v2_delete_user + summary: Deletes a user from the Databricks account by its internal ID. tags: - iamv2 - account_iam_v2 - description: >- - Deletes a service principal from the Databricks account by its internal - ID. - + description: |- + Deletes a user from the Databricks account by its internal ID. - :param internal_id: str - Required. Internal ID of the service principal in Databricks. + :param user_id: str + Required. Internal ID of the user in Databricks. parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: user_id in: path required: true schema: type: string - description: Required. Internal ID of the service principal in Databricks. + description: Required. Internal ID of the user in Databricks. responses: '200': description: Success @@ -1841,41 +2169,37 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_service_principal - summary: >- - Fetches a service principal from the Databricks account by its internal - ID. + operationId: account_iam_v2_get_user + summary: Fetches a user from the Databricks account by its internal ID. tags: - iamv2 - account_iam_v2 - description: >- - Fetches a service principal from the Databricks account by its internal - ID. - + description: |- + Fetches a user from the Databricks account by its internal ID. - :param internal_id: str - Required. Internal ID of the service principal in Databricks. + :param user_id: str + Required. Internal ID of the user in Databricks. - :returns: :class:`ServicePrincipal` + :returns: :class:`User` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: user_id in: path required: true schema: type: string - description: Required. Internal ID of the service principal in Databricks. + description: Required. Internal ID of the user in Databricks. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ServicePrincipal' + $ref: '#/components/schemas/User' default: description: Error response content: @@ -1889,94 +2213,98 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API patch: - operationId: account_iam_v2_update_service_principal + operationId: account_iam_v2_update_user summary: >- - Updates an existing service principal in the Databricks account. Only - the fields named in the update + Updates an existing user in the Databricks account and returns the + updated user. Only the fields named tags: - iamv2 - account_iam_v2 description: >- - Updates an existing service principal in the Databricks account. Only - the fields named in the update + Updates an existing user in the Databricks account and returns the + updated user. Only the fields named - mask are modified. Returns the updated ServicePrincipal resource. + in the update mask are modified. The updatable fields are + fullName.givenName, fullName.familyName, + status, and externalId. - :param internal_id: str - Required. Internal ID of the service principal in Databricks. - :param service_principal: :class:`ServicePrincipal` - Required. Service Principal to be updated in + + When AIM is enabled and the user is an external identity (its + external_id is set), only external_id + + can be updated; its other fields are sourced from your identity + provider. + + + :param user_id: str + Required. Internal ID of the user in Databricks. + :param user: :class:`User` + Required. User to be updated in Databricks :param update_mask: str - Optional. The list of fields to update. + Required. The list of fields to update. - :returns: :class:`ServicePrincipal` + :returns: :class:`User` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: user_id in: path required: true schema: type: string - description: Required. Internal ID of the service principal in Databricks. + description: Required. Internal ID of the user in Databricks. - name: update_mask in: query required: true schema: type: string - description: Optional. The list of fields to update. + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - service_principal: + username: + type: string + description: Username/email of the user. + full_name: type: object properties: - account_id: + family_name: type: string - description: >- - The parent account ID for the service principal in - Databricks. - account_sp_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: >- - The activity status of a service principal in a - Databricks account. - application_id: + given_name: type: string - description: Application ID of the service principal. - display_name: - type: string - description: Display name of the service principal. - external_id: - type: string - description: >- - ExternalId of the service principal in the customer's - IdP. - internal_id: - type: string - description: >- - Internal service principal ID of the service principal - in Databricks. - description: Required. Service Principal to be updated in + account_user_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. + external_id: + type: string + description: ExternalId of the user in the customer's IdP. + user_id: + type: string + description: Internal userId of the user in Databricks. required: - - service_principal + - username + - full_name + - account_user_status responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ServicePrincipal' + $ref: '#/components/schemas/User' default: description: Error response content: @@ -1989,30 +2317,49 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/users/{internal_id}: + /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}: delete: - operationId: account_iam_v2_delete_user - summary: Deletes a user from the Databricks account by its internal ID. + operationId: account_iam_v2_delete_workspace_assignment + summary: >- + Deletes a workspace assignment for a principal, revoking all of its + entitlements. Entitlements are tags: - iamv2 - account_iam_v2 - description: |- - Deletes a user from the Databricks account by its internal ID. + description: >- + Deletes a workspace assignment for a principal, revoking all of its + entitlements. Entitlements are - :param internal_id: str - Required. Internal ID of the user in Databricks. + revoked one at a time rather than atomically. If the request fails + partway through, the principal + + stays assigned with some of its original entitlements. Retrying is safe. + + + :param workspace_id: int + The workspace ID where the principal has access. + :param principal_id: int + Required. ID of the principal in Databricks to delete workspace assignment for. parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: workspace_id in: path required: true schema: - type: string - description: Required. Internal ID of the user in Databricks. + type: integer + description: The workspace ID where the principal has access. + - name: principal_id + in: path + required: true + schema: + type: integer + description: >- + Required. ID of the principal in Databricks to delete workspace + assignment for. responses: '200': description: Success @@ -2029,37 +2376,50 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API get: - operationId: account_iam_v2_get_user - summary: Fetches a user from the Databricks account by its internal ID. + operationId: account_iam_v2_get_workspace_assignment + summary: Returns the assignment for a principal in a workspace. tags: - iamv2 - account_iam_v2 description: |- - Fetches a user from the Databricks account by its internal ID. + Returns the assignment for a principal in a workspace. - :param internal_id: str - Required. Internal ID of the user in Databricks. + :param workspace_id: int + Required. The workspace ID for which the assignment is being requested. + :param principal_id: int + Required. The internal ID of the principal (user/sp/group) for which the assignment is being + requested. - :returns: :class:`User` + :returns: :class:`WorkspaceAssignment` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: workspace_id in: path required: true schema: - type: string - description: Required. Internal ID of the user in Databricks. + type: integer + description: >- + Required. The workspace ID for which the assignment is being + requested. + - name: principal_id + in: path + required: true + schema: + type: integer + description: >- + Required. The internal ID of the principal (user/sp/group) for which + the assignment is being requested. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/WorkspaceAssignment' default: description: Error response content: @@ -2073,96 +2433,234 @@ paths: type: string x-stackql-sdk-source: AccountIamV2API patch: - operationId: account_iam_v2_update_user + operationId: account_iam_v2_update_workspace_assignment summary: >- - Updates an existing user in the Databricks account, returning the - updated User resource. The behavior + Updates the entitlements of a directly assigned principal in a + workspace. Changes are applied one at a tags: - iamv2 - account_iam_v2 description: >- - Updates an existing user in the Databricks account, returning the - updated User resource. The behavior - - is the same whether or not Account Identity Management (AIM) is enabled. - Only the fields named in the + Updates the entitlements of a directly assigned principal in a + workspace. Changes are applied one at a - update mask are modified; the updatable fields are fullName.givenName, - fullName.familyName, status, + time rather than atomically. If the request fails partway through, only + some of the requested changes - and externalId. + take effect. Get the assignment afterwards to confirm the final state. - :param internal_id: str - Required. Internal ID of the user in Databricks. - :param user: :class:`User` - Required. User to be updated in - :param update_mask: str - Optional. The list of fields to update. + :param workspace_id: int + Required. The workspace ID for which the workspace assignment is being updated. + :param principal_id: int + Required. ID of the principal in Databricks. + :param workspace_assignment: :class:`WorkspaceAssignment` + Required. Workspace assignment to be updated in Databricks. + :param update_mask: FieldMask + Required. The list of fields to update. - :returns: :class:`User` + :returns: :class:`WorkspaceAssignment` parameters: - name: account_id in: path required: true schema: type: string - - name: internal_id + - name: workspace_id in: path required: true schema: - type: string - description: Required. Internal ID of the user in Databricks. + type: integer + description: >- + Required. The workspace ID for which the workspace assignment is + being updated. + - name: principal_id + in: path + required: true + schema: + type: integer + description: Required. ID of the principal in Databricks. - name: update_mask in: query required: true schema: - type: string - description: Optional. The list of fields to update. + type: object + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - user: - type: object - properties: - account_id: - type: string - description: The accountId parent of the user in Databricks. - account_user_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a user in a Databricks account. - external_id: - type: string - description: ExternalId of the user in the customer's IdP. - full_name: - type: object - properties: - family_name: - type: string - given_name: - type: string - internal_id: - type: string - description: Internal userId of the user in Databricks. - username: - type: string - description: Username/email of the user. - description: Required. User to be updated in + principal_id: + type: integer + description: >- + The internal ID of the principal (user/sp/group) in + Databricks. + account_id: + type: string + description: >- + The account ID parent of the workspace where the principal + is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + description: >- + Every entitlement the principal holds in this workspace, + whether granted directly or through group membership. Get + responses populate this field. List responses leave it + empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + description: >- + Entitlements granted directly to the principal on this + workspace. This is the only client-settable field. Create + and update manage exactly this set, including entitlements + the principal also holds through a group. List responses + leave this field empty. Get a single principal to read its + entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: >- + The type of the principal (user/service principal/group) + that is assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - user + - principal_id responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/WorkspaceAssignment' default: description: Error response content: @@ -2179,22 +2677,19 @@ paths: delete: operationId: account_iam_v2_delete_workspace_assignment_detail summary: >- - Deletes a workspace assignment detail for a principal, revoking all - associated entitlements. + Deletes a workspace assignment detail for a principal, revoking all of + its entitlements. Entitlements tags: - iamv2 - account_iam_v2 description: >- - Deletes a workspace assignment detail for a principal, revoking all - associated entitlements. - - Entitlement revocations are applied individually and non-atomically — if - a failure occurs partway + Deletes a workspace assignment detail for a principal, revoking all of + its entitlements. Entitlements - through, the principal remains assigned with a subset of its original - entitlements, and the operation + are revoked one at a time rather than atomically. If the request fails + partway through, the principal - is safe to retry. + stays assigned with some of its original entitlements. Retrying is safe. :param workspace_id: int @@ -2297,19 +2792,19 @@ paths: operationId: account_iam_v2_update_workspace_assignment_detail summary: >- Updates the entitlements of a directly assigned principal in a - workspace. Entitlement changes are + workspace. Changes are applied one at a tags: - iamv2 - account_iam_v2 description: >- Updates the entitlements of a directly assigned principal in a - workspace. Entitlement changes are + workspace. Changes are applied one at a - applied individually and non-atomically — if a failure occurs partway - through, only a subset of the + time rather than atomically. If the request fails partway through, only + some of the requested changes - requested changes may have been applied. Use - GetWorkspaceAssignmentDetail to confirm the final state. + take effect. Get the assignment detail afterwards to confirm the final + state. :param workspace_id: int @@ -2317,7 +2812,7 @@ paths: :param principal_id: int Required. ID of the principal in Databricks. :param workspace_assignment_detail: :class:`WorkspaceAssignmentDetail` - Required. Workspace assignment detail to be updated in . + Required. Workspace assignment detail to be updated in Databricks. :param update_mask: FieldMask Required. The list of fields to update. @@ -2354,175 +2849,166 @@ paths: schema: type: object properties: - workspace_assignment_detail: - type: object - properties: - principal_id: - type: integer - description: >- - The internal ID of the principal (user/sp/group) in - Databricks. - account_id: - type: string - description: >- - The account ID parent of the workspace where the - principal is assigned - effective_entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: >- - Create a collection of name/value pairs. + principal_id: + type: integer + description: >- + The internal ID of the principal (user/sp/group) in + Databricks. + account_id: + type: string + description: >- + The account ID parent of the workspace where the principal + is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members can - have their own + Methods can be added to enumerations, and members can have + their own - attributes -- see the documentation for details. - description: >- - The principal's full effective entitlements granted in - this workspace: every entitlement it holds whether - granted directly or via group membership. Populated on - Get; empty on List. - entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + description: >- + Every entitlement the principal holds in this workspace, + whether granted directly or through group membership. Get + responses populate this field. List responses leave it + empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members can - have their own + Methods can be added to enumerations, and members can have + their own - attributes -- see the documentation for details. - description: >- - Entitlements granted directly to the principal on this - workspace. The only client-settable field: create and - update manage exactly this set (including entitlements - the principal also holds via a group). Not populated by - ListWorkspaceAssignmentDetails (omitted for - scalability); call GetWorkspaceAssignmentDetail to read - the entitlements for a single principal. - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/sp/group). - workspace_id: - type: integer - description: The workspace ID where the principal is assigned - required: - - principal_id + attributes -- see the documentation for details. description: >- - Required. Workspace assignment detail to be updated in - . + Entitlements granted directly to the principal on this + workspace. This is the only client-settable field. Create + and update manage exactly this set, including entitlements + the principal also holds through a group. List responses + leave this field empty. Get a single principal to read its + entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/sp/group). + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - workspace_assignment_detail + - principal_id responses: '200': description: Success @@ -2542,7 +3028,138 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/{name}: + /api/2.0/identity/accounts/{account_id}/external-groups/{external_group_id}: + get: + operationId: account_iam_v2_get_external_group + summary: >- + Retrieves an external group with the given external ID from the + customer's IdP. If the group does not + tags: + - iamv2 + - account_iam_v2 + description: >- + Retrieves an external group with the given external ID from the + customer's IdP. If the group does not + + exist, it will be created in the account. If the customer is not + onboarded onto Automatic Identity + + Management (AIM), this will return an error. + + + :param name: str + Required. The resource name of the external group. Format: + accounts/{account_id}/external-groups/{external_group_id} + + :returns: :class:`ExternalGroup` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/external-groups/{external_group_id}`). + Required. The resource name of the external group. Format: + accounts/{account_id}/external-groups/{external_group_id} + - name: external_group_id + in: path + required: true + schema: + type: string + description: >- + The `external_group_id` segment of the `name` resource name + (`accounts/{account_id}/external-groups/{external_group_id}`). + Required. The resource name of the external group. Format: + accounts/{account_id}/external-groups/{external_group_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalGroup' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AccountIamV2API + /api/2.0/identity/accounts/{account_id}/external-service-principals/{external_service_principal_id}: + get: + operationId: account_iam_v2_get_external_service_principal + summary: >- + Retrieves an external service principal with the given external ID from + the customer's IdP. If the + tags: + - iamv2 + - account_iam_v2 + description: >- + Retrieves an external service principal with the given external ID from + the customer's IdP. If the + + service principal does not exist, it will be created. If the customer is + not onboarded onto Automatic + + Identity Management (AIM), this will return an error. + + + :param name: str + Required. The resource name of the external service principal. Format: + accounts/{account_id}/external-service-principals/{external_service_principal_id} + + :returns: :class:`ExternalServicePrincipal` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/external-service-principals/{external_service_principal_id}`). + Required. The resource name of the external service principal. + Format: + accounts/{account_id}/external-service-principals/{external_service_principal_id} + - name: external_service_principal_id + in: path + required: true + schema: + type: string + description: >- + The `external_service_principal_id` segment of the `name` resource + name + (`accounts/{account_id}/external-service-principals/{external_service_principal_id}`). + Required. The resource name of the external service principal. + Format: + accounts/{account_id}/external-service-principals/{external_service_principal_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalServicePrincipal' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AccountIamV2API + /api/2.0/identity/accounts/{account_id}/external-users/{external_user_id}: get: operationId: account_iam_v2_get_external_user summary: >- @@ -2567,12 +3184,24 @@ paths: :returns: :class:`ExternalUser` parameters: - - name: name + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/external-users/{external_user_id}`). + Required. The resource name of the external user. Format: + accounts/{account_id}/external-users/{external_user_id} + - name: external_user_id in: path required: true schema: type: string description: >- + The `external_user_id` segment of the `name` resource name + (`accounts/{account_id}/external-users/{external_user_id}`). Required. The resource name of the external user. Format: accounts/{account_id}/external-users/{external_user_id} responses: @@ -2687,7 +3316,8 @@ paths: listed. :param page_size: int (optional) The maximum number of parent groups to return. The service may return fewer than this value. If not - provided, defaults to 1000 (also the maximum allowed). + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page. @@ -2714,8 +3344,9 @@ paths: type: integer description: >- The maximum number of parent groups to return. The service may - return fewer than this value. If not provided, defaults to 1000 - (also the maximum allowed). + return fewer than this value. If not provided, defaults to 1000, + which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. - name: page_token in: query required: false @@ -2743,85 +3374,6 @@ paths: message: type: string x-stackql-sdk-source: AccountIamV2API - /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-access-details: - get: - operationId: account_iam_v2_list_workspace_access_details - summary: >- - Lists the access details of every provisioned principal (user, service - principal, or group) with - tags: - - iamv2 - - account_iam_v2 - description: >- - Lists the access details of every provisioned principal (user, service - principal, or group) with - - access to the given workspace, returning one page per call. - - - - Provisioned principal here refers to one that has been synced into - Databricks from the customer's - IdP or added explicitly to Databricks via SCIM/UI. - - :param workspace_id: int - The workspace ID for which the workspace access details are being fetched. - :param page_size: int (optional) - The maximum number of workspace access details to return. The service may return fewer than this - value. - :param page_token: str (optional) - A page token, received from a previous ListWorkspaceAccessDetails call. Provide this to retrieve the - subsequent page. - - :returns: :class:`ListWorkspaceAccessDetailsResponse` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: workspace_id - in: path - required: true - schema: - type: integer - description: >- - The workspace ID for which the workspace access details are being - fetched. - - name: page_size - in: query - required: false - schema: - type: integer - description: >- - The maximum number of workspace access details to return. The - service may return fewer than this value. - - name: page_token - in: query - required: false - schema: - type: string - description: >- - A page token, received from a previous ListWorkspaceAccessDetails - call. Provide this to retrieve the subsequent page. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListWorkspaceAccessDetailsResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AccountIamV2API /api/2.0/identity/accounts/{account_id}/groups/resolve-by-external-id: post: operationId: account_iam_v2_resolve_group @@ -2887,19 +3439,19 @@ paths: post: operationId: account_iam_v2_resolve_service_principal summary: >- - Resolves an SP with the given external ID from the customer's IdP. If - the SP does not exist, it will + Resolves a service principal with the given external ID from the + customer's IdP. If the service tags: - iamv2 - account_iam_v2 description: >- - Resolves an SP with the given external ID from the customer's IdP. If - the SP does not exist, it will + Resolves a service principal with the given external ID from the + customer's IdP. If the service - be created. If the customer is not onboarded onto Automatic Identity - Management (AIM), this will + principal does not exist, it will be created. If the customer is not + onboarded onto Automatic Identity - return an error. + Management (AIM), this will return an error. :param external_id: str @@ -3005,54 +3557,6 @@ paths: x-stackql-sdk-source: AccountIamV2API components: schemas: - AccountAccessIdentityRule: - type: object - properties: - action: - $ref: '#/components/schemas/AccountAccessRuleAction' - description: Currently, only DENY action is supported. - display_name: - type: string - description: Display name of the principal. - external_principal_id: - type: string - description: External ID of the principal in the customer's IdP. - name: - type: string - description: >- - Fully qualified name for the rule. Format: - accounts/{account_id}/account-access-identity-rules/{external_principal_id} - principal_type: - $ref: '#/components/schemas/PrincipalType' - description: >- - The type of the principal (user/service principal/group). This field - is populated by the server based on the external_principal_id. - required: - - action - description: An identity rule that controls which principals can access an account. - AttributeControlEntry: - type: object - properties: - is_allowed: - type: boolean - description: >- - Whether the attribute is permitted. Always true in the Identity - Attributes PrPr. - name: - type: string - description: >- - The resource name of the entry. Format: - accounts/{account_id}/attribute-control-entries/{attribute_name} - where {attribute_name} is the IdP attribute being governed (e.g. - "department"). - description: >- - A single entry in an account's identity attribute control list. The - presence of an entry means - the governed attribute (the last segment of ``name``) is controlled across all write sources - (SCIM, Identity APIs, AIM); is_allowed records whether the attribute is permitted (always true - in the Identity Attributes PrPr). For the Identity Attributes PrPr the control list is an - explicit allowlist: an attribute that is NOT present in the control list is treated as not - allowed. This may change post-PrPr. DirectGroupMember: type: object properties: @@ -3064,7 +3568,10 @@ components: description: Display name of the principal. external_id: type: string - description: The external ID of the principal in Databricks. + description: The external ID of the principal in the customer's IdP. + group_id: + type: integer + description: The internal ID of the group this member belongs to. membership_source: $ref: '#/components/schemas/GroupMembershipSource' description: The source of group membership (internal or from identity provider). @@ -3076,6 +3583,20 @@ components: description: >- Represents a principal that is a direct member of a group, with its source of membership. + ExactMatchRule: + type: object + properties: + external_id: + type: string + description: >- + The identity provider's external ID for the group to match. This is + not the Databricks group ID. The value must be non-empty and is + matched exactly, including case. + required: + - external_id + description: >- + An exact-match rule that matches a group's external ID from the identity + provider. ExternalGroup: type: object properties: @@ -3094,8 +3615,10 @@ components: name: type: string description: >- - The resource name of the external group. Format: - accounts/{account_id}/external-groups/{external_group_id} + The resource name of the external group. The format depends on the + API that returned it: - Account-scoped: + accounts/{account_id}/external-groups/{external_group_id} - + Workspace-scoped: external-groups/{external_group_id} description: >- An external group from the customer's Identity Provider, resolved into Databricks. This is a @@ -3127,8 +3650,11 @@ components: name: type: string description: >- - The resource name of the external service principal. Format: + The resource name of the external service principal. The format + depends on the API that returned it: - Account-scoped: accounts/{account_id}/external-service-principals/{external_service_principal_id} + - Workspace-scoped: + external-service-principals/{external_service_principal_id} description: >- An external service principal from the customer's Identity Provider, resolved into Databricks. @@ -3159,8 +3685,10 @@ components: name: type: string description: >- - The resource name of the external user. Format: - accounts/{account_id}/external-users/{external_user_id} + The resource name of the external user. The format depends on the + API that returned it: - Account-scoped: + accounts/{account_id}/external-users/{external_user_id} - + Workspace-scoped: external-users/{external_user_id} username: type: string description: Username/email of the user, from Databricks. @@ -3190,39 +3718,51 @@ components: external_id: type: string description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. group_name: type: string description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. description: The details of a Group resource. - ListAccountAccessIdentityRulesResponse: + IdentityVisibilityFilter: type: object properties: - account_access_identity_rules: - type: array - items: - $ref: '#/components/schemas/AccountAccessIdentityRule' - next_page_token: - type: string + principal_type: + $ref: '#/components/schemas/PrincipalType' description: >- - A token, which can be sent as page_token to retrieve the next page. - If this field is omitted, there are no subsequent pages. - description: Response message for listing account access identity rules. - ListAttributeControlEntriesResponse: - type: object - properties: - attribute_control_entries: - type: array - items: - $ref: '#/components/schemas/AttributeControlEntry' - next_page_token: + The type of principal this rule applies to. Set to ``GROUP`` when + creating a filter. Other principal types are not supported for + creation. + exact: + $ref: '#/components/schemas/ExactMatchRule' + description: Exact match on the group's external ID from the identity provider. + name: type: string description: >- - A token to retrieve the next page; empty when there are no more - results. - description: Response message for listing identity attribute control-list entries. + The resource name of the identity-visibility filter. Format: + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id} + prefix: + $ref: '#/components/schemas/PrefixMatchRule' + description: Case-sensitive starts-with match on the group's display name. + regex: + $ref: '#/components/schemas/RegexMatchRule' + description: Full, case-sensitive RE2 match on the identity's display name. + required: + - principal_type + description: >- + An account-level rule that controls which identity provider groups are + discoverable in directory + search and group pickers when automatic identity management is enabled. Filters apply across all + workspaces in the account. + + If no group filters are configured, all groups are visible. Otherwise, a group is visible if it + or any of its transitive parent groups matches at least one rule. A group is also visible if it + or any transitive parent group is already provisioned in the account. Local Databricks groups + remain visible regardless of the filters. + + Only group filters can be created. Filters do not change provisioning or sign-in for users and + service principals. Filters are immutable: to change a rule, delete it and create a new one. ListDirectGroupMembersResponse: type: object properties: @@ -3250,6 +3790,24 @@ components: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. description: Response message containing a page of groups in the account. + ListIdentityVisibilityFiltersResponse: + type: object + properties: + identity_visibility_filters: + type: array + items: + $ref: '#/components/schemas/IdentityVisibilityFilter' + description: >- + The filters in this page. These are filter rules, not the groups + matched by the rules. + next_page_token: + type: string + description: >- + A token, which can be sent as page_token to retrieve the next page. + If omitted, there are no subsequent pages. + description: >- + Response message containing a page of identity-visibility filters in the + account. ListServicePrincipalsResponse: type: object properties: @@ -3288,7 +3846,7 @@ components: type: array items: $ref: '#/components/schemas/User' - ListWorkspaceAccessDetailsResponse: + ListWorkspaceAssignmentDetailsResponse: type: object properties: next_page_token: @@ -3296,12 +3854,12 @@ components: description: >- A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - workspace_access_details: + workspace_assignment_details: type: array items: - $ref: '#/components/schemas/WorkspaceAccessDetail' - description: Response message containing a page of workspace access details. - ListWorkspaceAssignmentDetailsResponse: + $ref: '#/components/schemas/WorkspaceAssignmentDetail' + description: Response message for listing workspace assignment details. + ListWorkspaceAssignmentsResponse: type: object properties: next_page_token: @@ -3309,11 +3867,40 @@ components: description: >- A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - workspace_assignment_details: + workspace_assignments: type: array items: - $ref: '#/components/schemas/WorkspaceAssignmentDetail' - description: Response message for listing workspace assignment details. + $ref: '#/components/schemas/WorkspaceAssignment' + description: Response message for listing workspace assignments. + PrefixMatchRule: + type: object + properties: + display_name_prefix: + type: string + description: >- + The display-name prefix to match. Must contain at least one + non-whitespace character. Leading and trailing whitespace are + preserved, and matching is case-sensitive. + required: + - display_name_prefix + description: >- + A starts-with rule that matches groups whose display name begins with a + specified prefix. + Matching is case-sensitive. For example, the prefix ``data-`` matches ``data-platform``. + RegexMatchRule: + type: object + properties: + display_name_regex: + type: string + description: >- + The RE2 regular expression matched against the complete display + name. + required: + - display_name_regex + description: >- + A rule that matches an identity whose complete display name matches an + RE2 regular expression. + Matching is case-sensitive. Use .* explicitly when substring matching is desired. ResolveGroupResponse: type: object properties: @@ -3332,26 +3919,32 @@ components: ServicePrincipal: type: object properties: - account_id: + display_name: type: string - description: The parent account ID for the service principal in Databricks. + description: Display name of the service principal. account_sp_status: $ref: '#/components/schemas/State' description: The activity status of a service principal in a Databricks account. - application_id: + account_id: type: string - description: Application ID of the service principal. - display_name: + description: The parent account ID for the service principal in Databricks. + application_id: type: string - description: Display name of the service principal. + description: >- + Application ID of the service principal. Set at creation time and + cannot be changed afterwards; when omitted, the server generates + one. external_id: type: string description: ExternalId of the service principal in the customer's IdP. - internal_id: + service_principal_id: type: string description: >- Internal service principal ID of the service principal in Databricks. + required: + - display_name + - account_sp_status description: The details of a ServicePrincipal resource. TransitiveParentGroup: type: object @@ -3362,30 +3955,34 @@ components: external_id: type: string description: ExternalId of the group in the customer's IdP. - internal_id: + group_id: type: string description: Internal group ID of the group in Databricks. description: Represents a group that is a transitive parent of a principal. User: type: object properties: - account_id: + username: type: string - description: The accountId parent of the user in Databricks. + description: Username/email of the user. + full_name: + $ref: '#/components/schemas/UserFullName' account_user_status: $ref: '#/components/schemas/State' description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. external_id: type: string description: ExternalId of the user in the customer's IdP. - full_name: - $ref: '#/components/schemas/UserFullName' - internal_id: + user_id: type: string description: Internal userId of the user in Databricks. - username: - type: string - description: Username/email of the user. + required: + - username + - full_name + - account_user_status description: The details of a User resource. UserFullName: type: object @@ -3423,6 +4020,66 @@ components: type: integer description: The workspace ID where the principal has access. description: The details of a principal's access to a workspace. + WorkspaceAssignment: + type: object + properties: + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: >- + The account ID parent of the workspace where the principal is + assigned + effective_entitlements: + type: array + items: + $ref: '#/components/schemas/Entitlement' + description: >- + Every entitlement the principal holds in this workspace, whether + granted directly or through group membership. Get responses populate + this field. List responses leave it empty. + entitlements: + type: array + items: + $ref: '#/components/schemas/Entitlement' + description: >- + Entitlements granted directly to the principal on this workspace. + This is the only client-settable field. Create and update manage + exactly this set, including entitlements the principal also holds + through a group. List responses leave this field empty. Get a single + principal to read its entitlements. + principal_type: + $ref: '#/components/schemas/PrincipalType' + description: >- + The type of the principal (user/service principal/group) that is + assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. + required: + - principal_id + description: >- + The direct assignment of a provisioned account-level principal (user, + service principal, or + group) to a workspace, together with the entitlements that assignment grants in the workspace. + + This resource covers only principals assigned directly to the workspace. Principals that inherit + workspace access through a group are not represented here. See WorkspaceAccessDetail and + WorkspaceIdentityDetail for the effective, direct-or-indirect view. Creating the resource + assigns the principal to the workspace, and deleting it removes the assignment. + + ``entitlements`` is the only client-settable field. It holds the entitlements granted directly + on this assignment, including any the principal also holds through a group. + ``effective_entitlements`` is the read-only union of those and any granted through group + membership. + + A direct assignment always carries at least one directly-assigned entitlement, because the + assignment is what grants it. Create and update both reject an empty ``entitlements`` set. To + remove a principal's assignment entirely, delete the resource. + + This resource replaces workspace assignment previously managed through the workspace SCIM and + permission-assignment APIs, and is intended for account and workspace admins. WorkspaceAssignmentDetail: type: object properties: @@ -3439,25 +4096,24 @@ components: items: $ref: '#/components/schemas/Entitlement' description: >- - The principal's full effective entitlements granted in this - workspace: every entitlement it holds whether granted directly or - via group membership. Populated on Get; empty on List. + Every entitlement the principal holds in this workspace, whether + granted directly or through group membership. Get responses populate + this field. List responses leave it empty. entitlements: type: array items: $ref: '#/components/schemas/Entitlement' description: >- Entitlements granted directly to the principal on this workspace. - The only client-settable field: create and update manage exactly - this set (including entitlements the principal also holds via a - group). Not populated by ListWorkspaceAssignmentDetails (omitted for - scalability); call GetWorkspaceAssignmentDetail to read the - entitlements for a single principal. + This is the only client-settable field. Create and update manage + exactly this set, including entitlements the principal also holds + through a group. List responses leave this field empty. Get a single + principal to read its entitlements. principal_type: $ref: '#/components/schemas/PrincipalType' workspace_id: type: integer - description: The workspace ID where the principal is assigned + description: The workspace ID where the principal is assigned. required: - principal_id description: >- @@ -3465,18 +4121,19 @@ components: service principal, or group) to a workspace, together with the entitlements that assignment grants in the workspace. - A WorkspaceAssignmentDetail exists only for principals that are directly assigned to the - workspace; principals that merely inherit workspace access through a group are not represented - here (see WorkspaceAccessDetail / WorkspaceIdentityDetail for the effective, direct-or-indirect - view). Creating the resource assigns the principal to the workspace; deleting it removes the - assignment. The ``entitlements`` field is the only client-settable field and defines the - entitlements granted directly on this assignment; ``effective_entitlements`` is the read-only - union of those plus any granted via group membership. + This resource covers only principals assigned directly to the workspace. Principals that inherit + workspace access through a group are not represented here. See WorkspaceAccessDetail and + WorkspaceIdentityDetail for the effective, direct-or-indirect view. Creating the resource + assigns the principal to the workspace, and deleting it removes the assignment. + + ``entitlements`` is the only client-settable field. It holds the entitlements granted directly + on this assignment, including any the principal also holds through a group. + ``effective_entitlements`` is the read-only union of those and any granted through group + membership. - A direct assignment always carries at least one directly-assigned entitlement: the assignment is - what grants the entitlement, so a WorkspaceAssignmentDetail with an empty ``entitlements`` set - is not a valid state. Both create and update require a non-empty ``entitlements`` set (an empty - set is rejected); to remove a principal's assignment entirely, delete the resource. + A direct assignment always carries at least one directly-assigned entitlement, because the + assignment is what grants it. Create and update both reject an empty ``entitlements`` set. To + remove a principal's assignment entirely, delete the resource. This resource replaces workspace assignment previously managed through the workspace SCIM and permission-assignment APIs, and is intended for account and workspace admins. @@ -3500,13 +4157,6 @@ components: description: >- The details of a directly or indirectly assigned principal's details in a workspace. - AccountAccessRuleAction: - type: string - x-enum: - - DENY - description: >- - The action type for an account access identity rule (currently DENY - only). Entitlement: type: string x-enum: @@ -3601,85 +4251,87 @@ components: - USER_PERMISSION description: The type of permission a principal has to a workspace (admin/user). x-stackQL-resources: - account_access_identity_rules: - id: databricks_account.iamv2.account_access_identity_rules - name: account_access_identity_rules - title: Account Access Identity Rules + direct_group_members: + id: databricks_account.iamv2.direct_group_members + name: direct_group_members + title: Direct Group Members methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1{parent}~1account-access-identity-rules/post' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1{parent}~1account-access-identity-rules/get' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.account_access_identity_rules + objectKey: $.direct_group_members delete: operation: $ref: >- - #/paths/~1api~12.0~1{parent}~1account-access-identity-rules~1{external_principal_id}/delete + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members~1{principal_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1api~12.0~1{parent}~1account-access-identity-rules~1{external_principal_id}/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members~1{principal_id}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/account_access_identity_rules/methods/get - - $ref: >- - #/components/x-stackQL-resources/account_access_identity_rules/methods/list + - $ref: '#/components/x-stackQL-resources/direct_group_members/methods/get' + - $ref: '#/components/x-stackQL-resources/direct_group_members/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/account_access_identity_rules/methods/create + #/components/x-stackQL-resources/direct_group_members/methods/create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/account_access_identity_rules/methods/delete + #/components/x-stackQL-resources/direct_group_members/methods/delete replace: [] - attribute_control_entries: - id: databricks_account.iamv2.attribute_control_entries - name: attribute_control_entries - title: Attribute Control Entries + groups: + id: databricks_account.iamv2.groups + name: groups + title: Groups methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1{parent}~1attribute-control-entries/post' + $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1{parent}~1attribute-control-entries/get' + $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.attribute_control_entries + objectKey: $.groups delete: operation: - $ref: '#/paths/~1api~12.0~1{name}/delete' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1{name}/get' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -3688,30 +4340,36 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1{name}/patch' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + resolve: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1resolve-by-external-id/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/attribute_control_entries/methods/list - - $ref: >- - #/components/x-stackQL-resources/attribute_control_entries/methods/get + - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/attribute_control_entries/methods/create + - $ref: '#/components/x-stackQL-resources/groups/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/attribute_control_entries/methods/update + - $ref: '#/components/x-stackQL-resources/groups/methods/update' delete: - - $ref: >- - #/components/x-stackQL-resources/attribute_control_entries/methods/delete + - $ref: '#/components/x-stackQL-resources/groups/methods/delete' replace: [] - direct_group_members: - id: databricks_account.iamv2.direct_group_members - name: direct_group_members - title: Direct Group Members + identity_visibility_filters: + id: databricks_account.iamv2.identity_visibility_filters + name: identity_visibility_filters + title: Identity Visibility Filters methods: create: config: @@ -3719,76 +4377,80 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members/post + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1identity-visibility-filters/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1identity-visibility-filters/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.direct_group_members + objectKey: $.identity_visibility_filters delete: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members~1{principal_id}/delete + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1identity-visibility-filters~1{identity_visibility_filter_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{group_id}~1direct-members~1{principal_id}/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1identity-visibility-filters~1{identity_visibility_filter_id}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/direct_group_members/methods/get' - - $ref: '#/components/x-stackQL-resources/direct_group_members/methods/list' + - $ref: >- + #/components/x-stackQL-resources/identity_visibility_filters/methods/get + - $ref: >- + #/components/x-stackQL-resources/identity_visibility_filters/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/direct_group_members/methods/create + #/components/x-stackQL-resources/identity_visibility_filters/methods/create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/direct_group_members/methods/delete + #/components/x-stackQL-resources/identity_visibility_filters/methods/delete replace: [] - groups: - id: databricks_account.iamv2.groups - name: groups - title: Groups + service_principals: + id: databricks_account.iamv2.service_principals + name: service_principals + title: Service Principals methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups/post' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups/get' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.groups + objectKey: $.service_principals delete: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{internal_id}/delete + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{service_principal_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{internal_id}/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{service_principal_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -3798,7 +4460,7 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1{internal_id}/patch + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{service_principal_id}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -3808,55 +4470,53 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1groups~1resolve-by-external-id/post + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1resolve-by-external-id/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/groups/methods/get' - - $ref: '#/components/x-stackQL-resources/groups/methods/list' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' update: - - $ref: '#/components/x-stackQL-resources/groups/methods/update' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete' + - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' replace: [] - service_principals: - id: databricks_account.iamv2.service_principals - name: service_principals - title: Service Principals + users: + id: databricks_account.iamv2.users + name: users + title: Users methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals/post + $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals/get + $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.service_principals + objectKey: $.users delete: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{internal_id}/delete + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{user_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{internal_id}/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{user_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -3866,7 +4526,7 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1{internal_id}/patch + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{user_id}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -3876,53 +4536,55 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1service-principals~1resolve-by-external-id/post + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1resolve-by-external-id/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_principals/methods/get' - - $ref: '#/components/x-stackQL-resources/service_principals/methods/list' + - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/service_principals/methods/create' + - $ref: '#/components/x-stackQL-resources/users/methods/create' update: - - $ref: '#/components/x-stackQL-resources/service_principals/methods/update' + - $ref: '#/components/x-stackQL-resources/users/methods/update' delete: - - $ref: '#/components/x-stackQL-resources/service_principals/methods/delete' + - $ref: '#/components/x-stackQL-resources/users/methods/delete' replace: [] - users: - id: databricks_account.iamv2.users - name: users - title: Users + workspace_assignments: + id: databricks_account.iamv2.workspace_assignments + name: workspace_assignments + title: Workspace Assignments methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users/post' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-assignments/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users/get' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-assignments/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.users + objectKey: $.workspace_assignments delete: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{internal_id}/delete + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-assignments~1{principal_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{internal_id}/get + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-assignments~1{principal_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -3932,30 +4594,24 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1{internal_id}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - resolve: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1users~1resolve-by-external-id/post + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-assignments~1{principal_id}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/users/methods/get' - - $ref: '#/components/x-stackQL-resources/users/methods/list' + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/get' + - $ref: >- + #/components/x-stackQL-resources/workspace_assignments/methods/list insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create' + - $ref: >- + #/components/x-stackQL-resources/workspace_assignments/methods/create update: - - $ref: '#/components/x-stackQL-resources/users/methods/update' + - $ref: >- + #/components/x-stackQL-resources/workspace_assignments/methods/update delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/workspace_assignments/methods/delete replace: [] workspace_assignment_details: id: databricks_account.iamv2.workspace_assignment_details @@ -4020,6 +4676,45 @@ components: - $ref: >- #/components/x-stackQL-resources/workspace_assignment_details/methods/delete replace: [] + external_groups: + id: databricks_account.iamv2.external_groups + name: external_groups + title: External Groups + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1external-groups~1{external_group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + external_service_principals: + id: databricks_account.iamv2.external_service_principals + name: external_service_principals + title: External Service Principals + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1external-service-principals~1{external_service_principal_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/external_service_principals/methods/get + insert: [] + update: [] + delete: [] + replace: [] external_users: id: databricks_account.iamv2.external_users name: external_users @@ -4027,7 +4722,8 @@ components: methods: get: operation: - $ref: '#/paths/~1api~12.0~1identity~1{name}/get' + $ref: >- + #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1external-users~1{external_user_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -4050,20 +4746,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1api~12.0~1identity~1accounts~1{account_id}~1workspaces~1{workspace_id}~1workspace-access-details/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.workspace_access_details sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/workspace_access_details/methods/get - - $ref: >- - #/components/x-stackQL-resources/workspace_access_details/methods/list insert: [] update: [] delete: [] diff --git a/providers/src/databricks_account/v00.00.00000/services/networking.yaml b/providers/src/databricks_account/v00.00.00000/services/networking.yaml new file mode 100644 index 00000000..9c36d34c --- /dev/null +++ b/providers/src/databricks_account/v00.00.00000/services/networking.yaml @@ -0,0 +1,1725 @@ +openapi: 3.0.0 +info: + title: Databricks Networking API (account) + description: >- + OpenAPI specification for the Databricks networking service (account-level + APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.networking +servers: + - url: https://{account_host} + variables: + account_host: + description: >- + The Databricks account console host. Selected by DATABRICKS_CLOUD + (aws, azure or gcp; default aws), or set explicitly with + DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com +paths: + /api/networking/v1/accounts/{account_id}/endpoints: + post: + operationId: endpoints_create_endpoint + summary: >- + Creates a new network connectivity endpoint that enables private + connectivity between your network + tags: + - networking + - endpoints + description: >- + Creates a new network connectivity endpoint that enables private + connectivity between your network + + resources and Databricks services. + + + After creation, the endpoint is initially in the PENDING state. The + Databricks endpoint service + + automatically reviews and approves the endpoint within a few minutes. + Use the GET method to retrieve + + the latest endpoint state. + + + An endpoint can be used only after it reaches the APPROVED state. + + + :param parent: str + The parent resource name of the account under which the endpoint is created. Format: + ``accounts/{account_id}``. + :param endpoint: :class:`Endpoint` + + + :returns: :class:`Endpoint` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource name of the account + under which the endpoint is created. Format: + ``accounts/{account_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + The human-readable display name of this endpoint. The input + should conform to RFC-1034, which restricts to letters, + numbers, and hyphens, with the first character a letter, the + last a letter or a number, and a 63 character maximum. + region: + type: string + description: The cloud provider region where this endpoint is located. + account_id: + type: string + description: The Databricks Account in which the endpoint object exists. + aws_vpc_endpoint_info: + type: object + properties: + aws_vpc_endpoint_id: + type: string + aws_account_id: + type: string + description: The AWS account ID in which this VPC endpoint lives. + aws_endpoint_service_id: + type: string + description: >- + The ID of the Databricks VPC endpoint service that this + endpoint connects to. + required: + - aws_vpc_endpoint_id + description: Info for an AWS VPC endpoint. + azure_private_endpoint_info: + type: object + properties: + private_endpoint_name: + type: string + private_endpoint_resource_guid: + type: string + description: >- + The GUID of the Private Endpoint resource in the Azure + subscription. This is assigned by Azure when the user + sets up the Private Endpoint. + private_endpoint_resource_id: + type: string + description: The full resource ID of the Private Endpoint. + private_link_service_id: + type: string + description: >- + The resource ID of the Databricks Private Link Service + that this Private Endpoint connects to. + required: + - private_endpoint_name + - private_endpoint_resource_guid + description: Info for an Azure private endpoint. + create_time: + type: string + format: date-time + description: >- + The timestamp when the endpoint was created. The timestamp + is in RFC 3339 format in UTC timezone. + endpoint_id: + type: string + description: >- + The unique identifier for this endpoint under the account. + This field is a UUID generated by Databricks. + gcp_psc_endpoint_info: + type: object + properties: + project_id: + type: string + psc_endpoint: + type: string + description: >- + The name of this PSC connection in the GCP consumer + project. Provided by the customer when registering an + existing PSC endpoint. + endpoint_region: + type: string + description: >- + The GCP region of the PSC connection endpoint. Provided + by the customer when registering an existing PSC + endpoint. GCP supports only same-region PSC, so this + must match the workspace region. + psc_connection_id: + type: string + description: >- + The ID of the underlying Private Service Connect + connection in the GCP consumer project, assigned by GCP + when the PSC connection is created. + service_attachment_id: + type: string + description: >- + The ID of the Databricks service attachment this PSC + endpoint connects to. + required: + - project_id + - psc_endpoint + - endpoint_region + description: Info for a GCP Private Service Connect endpoint. + name: + type: string + description: >- + The resource name of the endpoint, which uniquely identifies + the endpoint. + state: + type: string + x-enum: + - APPROVED + - DISCONNECTED + - FAILED + - PENDING + description: >- + The state of the endpoint. The endpoint can only be used if + the state is ``APPROVED``. + use_case: + type: string + x-enum: + - SERVICE_DIRECT + description: >- + The use case that determines the type of network + connectivity this endpoint provides. This field is + automatically determined based on the endpoint configuration + and cloud-specific settings. + required: + - display_name + - region + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Endpoint' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EndpointsAPI + get: + operationId: endpoints_list_endpoints + summary: Lists all network connectivity endpoints for the account. + tags: + - networking + - endpoints + description: |- + Lists all network connectivity endpoints for the account. + + :param parent: str + The parent resource name of the account to list endpoints for. Format: ``accounts/{account_id}``. + :param page_size: int (optional) + :param page_token: str (optional) + + :returns: Iterator over :class:`Endpoint` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}`). The parent resource name of the account + to list endpoints for. Format: ``accounts/{account_id}``. + - name: page_size + in: query + required: false + schema: + type: integer + - name: page_token + in: query + required: false + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListEndpointsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EndpointsAPI + /api/networking/v1/accounts/{account_id}/endpoints/{endpoint_id}: + delete: + operationId: endpoints_delete_endpoint + summary: >- + Deletes a network endpoint. This will remove the endpoint configuration + from Databricks. Depending on + tags: + - networking + - endpoints + description: >- + Deletes a network endpoint. This will remove the endpoint configuration + from Databricks. Depending on + + the endpoint type and use case, you may also need to delete + corresponding network resources in your + + cloud provider account. + + + :param name: str + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/endpoints/{endpoint_id}`). + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`accounts/{account_id}/endpoints/{endpoint_id}`). + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EndpointsAPI + get: + operationId: endpoints_get_endpoint + summary: Gets details of a specific network endpoint. + tags: + - networking + - endpoints + description: |- + Gets details of a specific network endpoint. + + :param name: str + + :returns: :class:`Endpoint` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/endpoints/{endpoint_id}`). + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`accounts/{account_id}/endpoints/{endpoint_id}`). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Endpoint' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EndpointsAPI + /api/networking/v1/accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways: + post: + operationId: private_network_gateways_create_private_network_gateway + summary: Creates a private network gateway. + tags: + - networking + - private_network_gateways + description: |- + Creates a private network gateway. + + :param parent: str + The network connectivity configuration that will contain the gateway. + :param private_network_gateway: :class:`PrivateNetworkGateway` + The gateway to create. + :param request_id: str (optional) + A unique identifier for this request. The request is idempotent when this is provided. + + :returns: :class:`Operation` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}`). The + network connectivity configuration that will contain the gateway. + - name: ncc_id + in: path + required: true + schema: + type: string + description: >- + The `ncc_id` segment of the `parent` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}`). The + network connectivity configuration that will contain the gateway. + - name: request_id + in: query + required: false + schema: + type: string + description: >- + A unique identifier for this request. The request is idempotent when + this is provided. + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: The human-readable name of the gateway. + traffic_mode: + type: string + x-enum: + - ALL_TRAFFIC + - SPECIFIC_DESTINATIONS + description: The traffic routed through this gateway. + aws_cloud_connection: + type: object + properties: + gateway_subnets: + type: array + items: + type: object + properties: + subnet_id: + type: string + description: The AWS subnet ID. + required: + - subnet_id + description: An AWS subnet used by the gateway. + description: The subnets where the gateway establishes connectivity. + cross_account_role: + type: object + properties: + role_arn: + type: string + description: The ARN of the IAM role. + required: + - role_arn + description: >- + The IAM role that Databricks assumes to manage gateway + resources. + security_group_ids: + type: array + items: + type: string + description: >- + The security groups attached to the gateway network + interface. + required: + - gateway_subnets + - cross_account_role + - security_group_ids + description: The AWS connection used by the gateway. + azure_cloud_connection: + type: object + properties: + gateway_subnet: + type: object + properties: + resource_id: + type: string + description: The full Azure resource ID of the subnet. + required: + - resource_id + description: The subnet where the gateway establishes connectivity. + required: + - gateway_subnet + description: The Azure connection used by the gateway. + bandwidth_tier_gigabits_per_second: + type: integer + description: >- + The provisioned bandwidth tier for an Azure gateway, in + gigabits per second. Required when creating an Azure + gateway. + create_time: + type: string + format: date-time + description: The time when the gateway was created. + destinations: + type: array + items: + type: object + properties: + destination_type: + type: string + x-enum: + - DNS_NAME + description: The destination type. + value: + type: string + description: The destination value. + required: + - destination_type + - value + description: A destination routed through the gateway. + description: The destinations routed through this gateway. + error_message: + type: string + description: The failure reason when the gateway is in the FAILED state. + name: + type: string + description: >- + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + private_dns_resolvers: + type: array + items: + type: object + properties: + resolver_type: + type: string + x-enum: + - IP_ADDRESS + description: The resolver type. + value: + type: string + description: The resolver value. + required: + - resolver_type + - value + description: A private DNS resolver used by the gateway. + description: The DNS resolvers used for private name resolution. + state: + type: string + x-enum: + - CREATING + - DELETING + - ESTABLISHED + - FAILED + description: The current lifecycle state of the gateway. + update_time: + type: string + format: date-time + description: The time when the gateway was last updated. + required: + - display_name + - traffic_mode + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI + get: + operationId: private_network_gateways_list_private_network_gateways + summary: >- + Lists private network gateways under a network connectivity + configuration. + tags: + - networking + - private_network_gateways + description: >- + Lists private network gateways under a network connectivity + configuration. + + + :param parent: str + The network connectivity configuration containing the gateways. + :param page_token: str (optional) + An opaque token returned by a previous list request. + + :returns: Iterator over :class:`PrivateNetworkGateway` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `parent` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}`). The + network connectivity configuration containing the gateways. + - name: ncc_id + in: path + required: true + schema: + type: string + description: >- + The `ncc_id` segment of the `parent` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}`). The + network connectivity configuration containing the gateways. + - name: page_token + in: query + required: false + schema: + type: string + description: An opaque token returned by a previous list request. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListPrivateNetworkGatewaysResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI + /api/networking/v1/accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}: + delete: + operationId: private_network_gateways_delete_private_network_gateway + summary: Permanently deletes a private network gateway. + tags: + - networking + - private_network_gateways + description: |- + Permanently deletes a private network gateway. + + :param name: str + The canonical resource name of the gateway. + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + - name: ncc_id + in: path + required: true + schema: + type: string + description: >- + The `ncc_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + - name: gateway_id + in: path + required: true + schema: + type: string + description: >- + The `gateway_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI + get: + operationId: private_network_gateways_get_private_network_gateway + summary: Gets a private network gateway. + tags: + - networking + - private_network_gateways + description: |- + Gets a private network gateway. + + :param name: str + The canonical resource name of the gateway. + + :returns: :class:`PrivateNetworkGateway` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + - name: ncc_id + in: path + required: true + schema: + type: string + description: >- + The `ncc_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + - name: gateway_id + in: path + required: true + schema: + type: string + description: >- + The `gateway_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateNetworkGateway' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI + patch: + operationId: private_network_gateways_update_private_network_gateway + summary: Updates a private network gateway. + tags: + - networking + - private_network_gateways + description: |- + Updates a private network gateway. + + :param name: str + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + :param private_network_gateway: :class:`PrivateNetworkGateway` + The gateway containing the desired mutable field values. + :param update_mask: FieldMask + The fields to update. + + :returns: :class:`PrivateNetworkGateway` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + description: >- + The `account_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + - name: ncc_id + in: path + required: true + schema: + type: string + description: >- + The `ncc_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + - name: gateway_id + in: path + required: true + schema: + type: string + description: >- + The `gateway_id` segment of the `name` resource name + (`accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`). + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + - name: update_mask + in: query + required: true + schema: + type: object + description: The fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: The human-readable name of the gateway. + traffic_mode: + type: string + x-enum: + - ALL_TRAFFIC + - SPECIFIC_DESTINATIONS + description: The traffic routed through this gateway. + aws_cloud_connection: + type: object + properties: + gateway_subnets: + type: array + items: + type: object + properties: + subnet_id: + type: string + description: The AWS subnet ID. + required: + - subnet_id + description: An AWS subnet used by the gateway. + description: The subnets where the gateway establishes connectivity. + cross_account_role: + type: object + properties: + role_arn: + type: string + description: The ARN of the IAM role. + required: + - role_arn + description: >- + The IAM role that Databricks assumes to manage gateway + resources. + security_group_ids: + type: array + items: + type: string + description: >- + The security groups attached to the gateway network + interface. + required: + - gateway_subnets + - cross_account_role + - security_group_ids + description: The AWS connection used by the gateway. + azure_cloud_connection: + type: object + properties: + gateway_subnet: + type: object + properties: + resource_id: + type: string + description: The full Azure resource ID of the subnet. + required: + - resource_id + description: The subnet where the gateway establishes connectivity. + required: + - gateway_subnet + description: The Azure connection used by the gateway. + bandwidth_tier_gigabits_per_second: + type: integer + description: >- + The provisioned bandwidth tier for an Azure gateway, in + gigabits per second. Required when creating an Azure + gateway. + create_time: + type: string + format: date-time + description: The time when the gateway was created. + destinations: + type: array + items: + type: object + properties: + destination_type: + type: string + x-enum: + - DNS_NAME + description: The destination type. + value: + type: string + description: The destination value. + required: + - destination_type + - value + description: A destination routed through the gateway. + description: The destinations routed through this gateway. + error_message: + type: string + description: The failure reason when the gateway is in the FAILED state. + name: + type: string + description: >- + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + private_dns_resolvers: + type: array + items: + type: object + properties: + resolver_type: + type: string + x-enum: + - IP_ADDRESS + description: The resolver type. + value: + type: string + description: The resolver value. + required: + - resolver_type + - value + description: A private DNS resolver used by the gateway. + description: The DNS resolvers used for private name resolution. + state: + type: string + x-enum: + - CREATING + - DELETING + - ESTABLISHED + - FAILED + description: The current lifecycle state of the gateway. + update_time: + type: string + format: date-time + description: The time when the gateway was last updated. + required: + - display_name + - traffic_mode + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PrivateNetworkGateway' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI + /api/networking/v1/{name}: + get: + operationId: private_network_gateways_get_private_network_gateway_operation + summary: Gets the status of a private network gateway create operation. + tags: + - networking + - private_network_gateways + description: |- + Gets the status of a private network gateway create operation. + + :param name: str + The name of the operation resource. + + :returns: :class:`Operation` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the operation resource. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PrivateNetworkGatewaysAPI +components: + schemas: + AwsVpcEndpointInfo: + type: object + properties: + aws_vpc_endpoint_id: + type: string + aws_account_id: + type: string + description: The AWS account ID in which this VPC endpoint lives. + aws_endpoint_service_id: + type: string + description: >- + The ID of the Databricks VPC endpoint service that this endpoint + connects to. + required: + - aws_vpc_endpoint_id + AzurePrivateEndpointInfo: + type: object + properties: + private_endpoint_name: + type: string + private_endpoint_resource_guid: + type: string + description: >- + The GUID of the Private Endpoint resource in the Azure subscription. + This is assigned by Azure when the user sets up the Private + Endpoint. + private_endpoint_resource_id: + type: string + description: The full resource ID of the Private Endpoint. + private_link_service_id: + type: string + description: >- + The resource ID of the Databricks Private Link Service that this + Private Endpoint connects to. + required: + - private_endpoint_name + - private_endpoint_resource_guid + DatabricksServiceExceptionWithDetailsProto: + type: object + properties: + details: + type: array + items: + type: object + error_code: + $ref: '#/components/schemas/ErrorCode' + message: + type: string + stack_trace: + type: string + description: Databricks Error that is returned by all Databricks APIs. + Endpoint: + type: object + properties: + display_name: + type: string + description: >- + The human-readable display name of this endpoint. The input should + conform to RFC-1034, which restricts to letters, numbers, and + hyphens, with the first character a letter, the last a letter or a + number, and a 63 character maximum. + region: + type: string + description: The cloud provider region where this endpoint is located. + account_id: + type: string + description: The Databricks Account in which the endpoint object exists. + aws_vpc_endpoint_info: + $ref: '#/components/schemas/AwsVpcEndpointInfo' + description: Info for an AWS VPC endpoint. + azure_private_endpoint_info: + $ref: '#/components/schemas/AzurePrivateEndpointInfo' + description: Info for an Azure private endpoint. + create_time: + type: string + format: date-time + description: >- + The timestamp when the endpoint was created. The timestamp is in RFC + 3339 format in UTC timezone. + endpoint_id: + type: string + description: >- + The unique identifier for this endpoint under the account. This + field is a UUID generated by Databricks. + gcp_psc_endpoint_info: + $ref: '#/components/schemas/GcpPscEndpointInfo' + description: Info for a GCP Private Service Connect endpoint. + name: + type: string + description: >- + The resource name of the endpoint, which uniquely identifies the + endpoint. + state: + $ref: '#/components/schemas/EndpointState' + description: >- + The state of the endpoint. The endpoint can only be used if the + state is ``APPROVED``. + use_case: + $ref: '#/components/schemas/EndpointUseCase' + description: >- + The use case that determines the type of network connectivity this + endpoint provides. This field is automatically determined based on + the endpoint configuration and cloud-specific settings. + required: + - display_name + - region + description: >- + Endpoint represents a cloud networking resource in a user's cloud + account and binds it to the + Databricks account. + GcpPscEndpointInfo: + type: object + properties: + project_id: + type: string + psc_endpoint: + type: string + description: >- + The name of this PSC connection in the GCP consumer project. + Provided by the customer when registering an existing PSC endpoint. + endpoint_region: + type: string + description: >- + The GCP region of the PSC connection endpoint. Provided by the + customer when registering an existing PSC endpoint. GCP supports + only same-region PSC, so this must match the workspace region. + psc_connection_id: + type: string + description: >- + The ID of the underlying Private Service Connect connection in the + GCP consumer project, assigned by GCP when the PSC connection is + created. + service_attachment_id: + type: string + description: >- + The ID of the Databricks service attachment this PSC endpoint + connects to. + required: + - project_id + - psc_endpoint + - endpoint_region + ListEndpointsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Endpoint' + next_page_token: + type: string + ListPrivateNetworkGatewaysResponse: + type: object + properties: + next_page_token: + type: string + private_network_gateways: + type: array + items: + $ref: '#/components/schemas/PrivateNetworkGateway' + Operation: + type: object + properties: + done: + type: boolean + description: >- + If the value is ``false``, it means the operation is still in + progress. If ``true``, the operation is completed, and either + ``error`` or ``response`` is available. + error: + $ref: '#/components/schemas/DatabricksServiceExceptionWithDetailsProto' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the ``name`` should be a resource name ending with + ``operations/{unique_id}``. + response: + type: object + description: The normal, successful response of the operation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + PrivateNetworkGateway: + type: object + properties: + display_name: + type: string + description: The human-readable name of the gateway. + traffic_mode: + $ref: '#/components/schemas/PrivateNetworkGatewayTrafficMode' + description: The traffic routed through this gateway. + aws_cloud_connection: + $ref: '#/components/schemas/PrivateNetworkGatewayAwsCloudConnection' + description: The AWS connection used by the gateway. + azure_cloud_connection: + $ref: '#/components/schemas/PrivateNetworkGatewayAzureCloudConnection' + description: The Azure connection used by the gateway. + bandwidth_tier_gigabits_per_second: + type: integer + description: >- + The provisioned bandwidth tier for an Azure gateway, in gigabits per + second. Required when creating an Azure gateway. + create_time: + type: string + format: date-time + description: The time when the gateway was created. + destinations: + type: array + items: + $ref: '#/components/schemas/PrivateNetworkGatewayDestination' + description: The destinations routed through this gateway. + error_message: + type: string + description: The failure reason when the gateway is in the FAILED state. + name: + type: string + description: >- + The canonical resource name of the gateway, in the form + ``accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}``. + private_dns_resolvers: + type: array + items: + $ref: '#/components/schemas/PrivateNetworkGatewayPrivateDnsResolver' + description: The DNS resolvers used for private name resolution. + state: + $ref: '#/components/schemas/PrivateNetworkGatewayGatewayState' + description: The current lifecycle state of the gateway. + update_time: + type: string + format: date-time + description: The time when the gateway was last updated. + required: + - display_name + - traffic_mode + description: >- + A private network gateway connects serverless compute to destinations in + a customer-managed VPC + or VNet. + PrivateNetworkGatewayAwsCloudConnection: + type: object + properties: + gateway_subnets: + type: array + items: + $ref: >- + #/components/schemas/PrivateNetworkGatewayAwsCloudConnectionAwsGatewaySubnet + description: The subnets where the gateway establishes connectivity. + cross_account_role: + $ref: >- + #/components/schemas/PrivateNetworkGatewayAwsCloudConnectionCrossAccountRole + description: The IAM role that Databricks assumes to manage gateway resources. + security_group_ids: + type: array + items: + type: string + description: The security groups attached to the gateway network interface. + required: + - gateway_subnets + - cross_account_role + - security_group_ids + description: AWS connection configuration. + PrivateNetworkGatewayAwsCloudConnectionAwsGatewaySubnet: + type: object + properties: + subnet_id: + type: string + description: The AWS subnet ID. + required: + - subnet_id + description: An AWS subnet used by the gateway. + PrivateNetworkGatewayAwsCloudConnectionCrossAccountRole: + type: object + properties: + role_arn: + type: string + description: The ARN of the IAM role. + required: + - role_arn + description: A cross-account IAM role used to manage gateway resources. + PrivateNetworkGatewayAzureCloudConnection: + type: object + properties: + gateway_subnet: + $ref: >- + #/components/schemas/PrivateNetworkGatewayAzureCloudConnectionAzureGatewaySubnet + description: The subnet where the gateway establishes connectivity. + required: + - gateway_subnet + description: Azure connection configuration. + PrivateNetworkGatewayAzureCloudConnectionAzureGatewaySubnet: + type: object + properties: + resource_id: + type: string + description: The full Azure resource ID of the subnet. + required: + - resource_id + description: An Azure subnet used by the gateway. + PrivateNetworkGatewayDestination: + type: object + properties: + destination_type: + $ref: '#/components/schemas/PrivateNetworkGatewayDestinationDestinationType' + description: The destination type. + value: + type: string + description: The destination value. + required: + - destination_type + - value + description: A destination routed through the gateway. + PrivateNetworkGatewayOperationMetadata: + type: object + properties: + operation_type: + $ref: >- + #/components/schemas/PrivateNetworkGatewayOperationMetadataOperationType + PrivateNetworkGatewayPrivateDnsResolver: + type: object + properties: + resolver_type: + $ref: >- + #/components/schemas/PrivateNetworkGatewayPrivateDnsResolverResolverType + description: The resolver type. + value: + type: string + description: The resolver value. + required: + - resolver_type + - value + description: A private DNS resolver used by the gateway. + EndpointState: + type: string + x-enum: + - APPROVED + - DISCONNECTED + - FAILED + - PENDING + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + EndpointUseCase: + type: string + x-enum: + - SERVICE_DIRECT + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + ErrorCode: + type: string + x-enum: + - ABORTED + - ALREADY_EXISTS + - BAD_REQUEST + - CANCELLED + - CATALOG_ALREADY_EXISTS + - CATALOG_DOES_NOT_EXIST + - CATALOG_NOT_EMPTY + - COULD_NOT_ACQUIRE_LOCK + - CUSTOMER_UNAUTHORIZED + - DAC_ALREADY_EXISTS + - DAC_DOES_NOT_EXIST + - DATA_LOSS + - DEADLINE_EXCEEDED + - DEPLOYMENT_TIMEOUT + - DIRECTORY_NOT_EMPTY + - DIRECTORY_PROTECTED + - DRY_RUN_FAILED + - ENDPOINT_NOT_FOUND + - EXTERNAL_LOCATION_ALREADY_EXISTS + - EXTERNAL_LOCATION_DOES_NOT_EXIST + - FEATURE_DISABLED + - GIT_CONFLICT + - GIT_REMOTE_ERROR + - GIT_SENSITIVE_TOKEN_DETECTED + - GIT_UNKNOWN_REF + - GIT_URL_NOT_ON_ALLOW_LIST + - INSECURE_PARTNER_RESPONSE + - INTERNAL_ERROR + - INVALID_PARAMETER_VALUE + - INVALID_STATE + - INVALID_STATE_TRANSITION + - IO_ERROR + - IPYNB_FILE_IN_REPO + - MALFORMED_PARTNER_RESPONSE + - MALFORMED_REQUEST + - MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST + - MAX_BLOCK_SIZE_EXCEEDED + - MAX_CHILD_NODE_SIZE_EXCEEDED + - MAX_LIST_SIZE_EXCEEDED + - MAX_NOTEBOOK_SIZE_EXCEEDED + - MAX_READ_SIZE_EXCEEDED + - METASTORE_ALREADY_EXISTS + - METASTORE_DOES_NOT_EXIST + - METASTORE_NOT_EMPTY + - NOT_FOUND + - NOT_IMPLEMENTED + - PARTIAL_DELETE + - PERMISSION_DENIED + - PERMISSION_NOT_PROPAGATED + - PRINCIPAL_DOES_NOT_EXIST + - PROJECTS_OPERATION_TIMEOUT + - PROVIDER_ALREADY_EXISTS + - PROVIDER_DOES_NOT_EXIST + - PROVIDER_SHARE_NOT_ACCESSIBLE + - QUOTA_EXCEEDED + - RECIPIENT_ALREADY_EXISTS + - RECIPIENT_DOES_NOT_EXIST + - REQUEST_LIMIT_EXCEEDED + - RESOURCE_ALREADY_EXISTS + - RESOURCE_CONFLICT + - RESOURCE_DOES_NOT_EXIST + - RESOURCE_EXHAUSTED + - RESOURCE_LIMIT_EXCEEDED + - SCHEMA_ALREADY_EXISTS + - SCHEMA_DOES_NOT_EXIST + - SCHEMA_NOT_EMPTY + - SEARCH_QUERY_TOO_LONG + - SEARCH_QUERY_TOO_SHORT + - SERVICE_UNDER_MAINTENANCE + - SHARE_ALREADY_EXISTS + - SHARE_DOES_NOT_EXIST + - STORAGE_CREDENTIAL_ALREADY_EXISTS + - STORAGE_CREDENTIAL_DOES_NOT_EXIST + - TABLE_ALREADY_EXISTS + - TABLE_DOES_NOT_EXIST + - TEMPORARILY_UNAVAILABLE + - UNAUTHENTICATED + - UNAVAILABLE + - UNKNOWN + - UNPARSEABLE_HTTP_ERROR + - WORKSPACE_TEMPORARILY_UNAVAILABLE + description: >- + Error codes returned by Databricks APIs to indicate specific failure + conditions. + PrivateNetworkGatewayDestinationDestinationType: + type: string + x-enum: + - DNS_NAME + description: The supported destination types. + PrivateNetworkGatewayGatewayState: + type: string + x-enum: + - CREATING + - DELETING + - ESTABLISHED + - FAILED + description: The lifecycle state of the gateway. + PrivateNetworkGatewayOperationMetadataOperationType: + type: string + x-enum: + - CREATE + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + PrivateNetworkGatewayPrivateDnsResolverResolverType: + type: string + x-enum: + - IP_ADDRESS + description: The supported resolver types. + PrivateNetworkGatewayTrafficMode: + type: string + x-enum: + - ALL_TRAFFIC + - SPECIFIC_DESTINATIONS + description: The traffic routed through the gateway. + x-stackQL-resources: + endpoints: + id: databricks_account.networking.endpoints + name: endpoints + title: Endpoints + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1endpoints/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1endpoints/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + delete: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1endpoints~1{endpoint_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1endpoints~1{endpoint_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' + replace: [] + private_network_gateways: + id: databricks_account.networking.private_network_gateways + name: private_network_gateways + title: Private Network Gateways + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1network-connectivity-configs~1{ncc_id}~1private-network-gateways/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1network-connectivity-configs~1{ncc_id}~1private-network-gateways/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.private_network_gateways + delete: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1network-connectivity-configs~1{ncc_id}~1private-network-gateways~1{gateway_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1network-connectivity-configs~1{ncc_id}~1private-network-gateways~1{gateway_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1networking~1v1~1accounts~1{account_id}~1network-connectivity-configs~1{ncc_id}~1private-network-gateways~1{gateway_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_network_gateways/methods/get + - $ref: >- + #/components/x-stackQL-resources/private_network_gateways/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/private_network_gateways/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/private_network_gateways/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/private_network_gateways/methods/delete + replace: [] + private_network_gateway_operations: + id: databricks_account.networking.private_network_gateway_operations + name: private_network_gateway_operations + title: Private Network Gateway Operations + methods: + get: + operation: + $ref: '#/paths/~1api~1networking~1v1~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_network_gateway_operations/methods/get + insert: [] + update: [] + delete: [] + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml b/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml index 418c3921..267378e4 100644 --- a/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml @@ -5,10 +5,23 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.oauth2 servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/accounts/{account_id}/federationPolicies: post: @@ -45,75 +58,68 @@ paths: schema: type: object properties: - policy: + create_time: + type: string + description: + type: string + description: Description of the federation policy. + name: + type: string + description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` + for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` + for Service Principal Federation Policies. Typically an output parameter, which does not need to be specified + in create or update requests. If specified in a request, must match the value in the request URL. + oidc_policy: type: object properties: - create_time: - type: string - description: + audiences: + type: array + items: + type: string + description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The audience + identifier is intended to represent the recipient of the token. Can be any non-empty string value. + As long as the audience in the token matches at least one audience in the policy, the token is considered + a match. If audiences is unspecified, defaults to your Databricks account id. + issuer: type: string - description: Description of the federation policy. - name: + description: The required token issuer, as specified in the 'iss' claim of federated tokens. + jwks_json: type: string - description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` - for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` - for Service Principal Federation Policies. Typically an output parameter, which does not need to be - specified in create or update requests. If specified in a request, must match the value in the request - URL. - oidc_policy: - type: object - properties: - audiences: - type: array - items: - type: string - description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The - audience identifier is intended to represent the recipient of the token. Can be any non-empty - string value. As long as the audience in the token matches at least one audience in the policy, - the token is considered a match. If audiences is unspecified, defaults to your Databricks account - id. - issuer: - type: string - description: The required token issuer, as specified in the 'iss' claim of federated tokens. - jwks_json: - type: string - description: The public keys used to validate the signature of federated tokens, in JWKS format. - Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified - (recommended), Databricks automatically fetches the public keys from your issuer’s well known - endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering - public keys. - jwks_uri: - type: string - description: URL of the public keys used to validate the signature of federated tokens, in JWKS - format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both - unspecified (recommended), Databricks automatically fetches the public keys from your issuer’s - well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint - for discovering public keys. - subject: - type: string - description: The required token subject, as specified in the subject claim of federated tokens. - Must be specified for service principal federation policies. Must not be specified for account - federation policies. - subject_claim: - type: string - description: The claim that contains the subject of the token. If unspecified, the default value - is 'sub'. - description: Specifies the policy to use for validating OIDC claims in your federated tokens. - policy_id: + description: The public keys used to validate the signature of federated tokens, in JWKS format. Most + use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), + Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks + strongly recommends relying on your issuer’s well known endpoint for discovering public keys. + jwks_uri: type: string - description: The ID of the federation policy. Output only. - service_principal_id: - type: integer - description: The service principal ID that this federation policy applies to. Output only. Only set - for service principal federation policies. - uid: + description: URL of the public keys used to validate the signature of federated tokens, in JWKS format. + Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified + (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. + Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public + keys. + subject: type: string - description: Unique, immutable id of the federation policy. - update_time: + description: The required token subject, as specified in the subject claim of federated tokens. Must + be specified for service principal federation policies. Must not be specified for account federation + policies. + subject_claim: type: string - description: Last update time of the federation policy. - required: - - policy + description: The claim that contains the subject of the token. If unspecified, the default value is + 'sub'. + description: audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy + configuration is captured in create/update audit logs (see go/auditlogs). + policy_id: + type: string + description: The ID of the federation policy. Output only. + service_principal_id: + type: integer + description: The service principal ID that this federation policy applies to. Output only. Only set for + service principal federation policies. + uid: + type: string + description: Unique, immutable id of the federation policy. + update_time: + type: string + description: Last update time of the federation policy. responses: '200': description: Success @@ -311,75 +317,68 @@ paths: schema: type: object properties: - policy: + create_time: + type: string + description: + type: string + description: Description of the federation policy. + name: + type: string + description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` + for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` + for Service Principal Federation Policies. Typically an output parameter, which does not need to be specified + in create or update requests. If specified in a request, must match the value in the request URL. + oidc_policy: type: object properties: - create_time: - type: string - description: + audiences: + type: array + items: + type: string + description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The audience + identifier is intended to represent the recipient of the token. Can be any non-empty string value. + As long as the audience in the token matches at least one audience in the policy, the token is considered + a match. If audiences is unspecified, defaults to your Databricks account id. + issuer: type: string - description: Description of the federation policy. - name: + description: The required token issuer, as specified in the 'iss' claim of federated tokens. + jwks_json: type: string - description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` - for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` - for Service Principal Federation Policies. Typically an output parameter, which does not need to be - specified in create or update requests. If specified in a request, must match the value in the request - URL. - oidc_policy: - type: object - properties: - audiences: - type: array - items: - type: string - description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The - audience identifier is intended to represent the recipient of the token. Can be any non-empty - string value. As long as the audience in the token matches at least one audience in the policy, - the token is considered a match. If audiences is unspecified, defaults to your Databricks account - id. - issuer: - type: string - description: The required token issuer, as specified in the 'iss' claim of federated tokens. - jwks_json: - type: string - description: The public keys used to validate the signature of federated tokens, in JWKS format. - Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified - (recommended), Databricks automatically fetches the public keys from your issuer’s well known - endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering - public keys. - jwks_uri: - type: string - description: URL of the public keys used to validate the signature of federated tokens, in JWKS - format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both - unspecified (recommended), Databricks automatically fetches the public keys from your issuer’s - well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint - for discovering public keys. - subject: - type: string - description: The required token subject, as specified in the subject claim of federated tokens. - Must be specified for service principal federation policies. Must not be specified for account - federation policies. - subject_claim: - type: string - description: The claim that contains the subject of the token. If unspecified, the default value - is 'sub'. - description: Specifies the policy to use for validating OIDC claims in your federated tokens. - policy_id: + description: The public keys used to validate the signature of federated tokens, in JWKS format. Most + use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), + Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks + strongly recommends relying on your issuer’s well known endpoint for discovering public keys. + jwks_uri: type: string - description: The ID of the federation policy. Output only. - service_principal_id: - type: integer - description: The service principal ID that this federation policy applies to. Output only. Only set - for service principal federation policies. - uid: + description: URL of the public keys used to validate the signature of federated tokens, in JWKS format. + Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified + (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. + Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public + keys. + subject: type: string - description: Unique, immutable id of the federation policy. - update_time: + description: The required token subject, as specified in the subject claim of federated tokens. Must + be specified for service principal federation policies. Must not be specified for account federation + policies. + subject_claim: type: string - description: Last update time of the federation policy. - required: - - policy + description: The claim that contains the subject of the token. If unspecified, the default value is + 'sub'. + description: audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy + configuration is captured in create/update audit logs (see go/auditlogs). + policy_id: + type: string + description: The ID of the federation policy. Output only. + service_principal_id: + type: integer + description: The service principal ID that this federation policy applies to. Output only. Only set for + service principal federation policies. + uid: + type: string + description: Unique, immutable id of the federation policy. + update_time: + type: string + description: Last update time of the federation policy. responses: '200': description: Success @@ -414,10 +413,6 @@ paths: :param confidential: bool (optional) This field indicates whether an OAuth client secret is required to authenticate this client. - :param is_agent: bool (optional) - When true, the custom OAuth app integration is backed by an agent service principal instead of a - standard application service principal. The public surface stays a simple boolean; the server maps - it to the internal OAuthClientApp.agent message. :param name: str (optional) Name of the custom OAuth app :param redirect_urls: List[str] (optional) @@ -447,11 +442,6 @@ paths: confidential: type: boolean description: This field indicates whether an OAuth client secret is required to authenticate this client. - is_agent: - type: boolean - description: When true, the custom OAuth app integration is backed by an agent service principal instead - of a standard application service principal. The public surface stays a simple boolean; the server maps - it to the internal OAuthClientApp.agent message. name: type: string description: Name of the custom OAuth app @@ -523,10 +513,6 @@ paths: :param include_creator_username: bool (optional) :param page_size: int (optional) :param page_token: str (optional) - :param search_keyword: str (optional) - Search term to filter app integrations (case-insensitive substring match). Matches if the display - name, the OAuth client_id (a UUID for custom apps or a stable string like "databricks-cli" for - published apps), or the integration id contains the term. :returns: Iterator over :class:`GetCustomAppIntegrationOutput` parameters: @@ -550,14 +536,6 @@ paths: required: false schema: type: string - - name: search_keyword - in: query - required: false - schema: - type: string - description: Search term to filter app integrations (case-insensitive substring match). Matches if the display name, - the OAuth client_id (a UUID for custom apps or a stable string like "databricks-cli" for published apps), or the - integration id contains the term. responses: '200': description: Success @@ -886,9 +864,6 @@ paths: :param page_size: int (optional) :param page_token: str (optional) - :param search_keyword: str (optional) - Search term to filter app integrations (case-insensitive substring match). Matches if the display - name, the OAuth client_id, or the integration id contains the term. :returns: Iterator over :class:`GetPublishedAppIntegrationOutput` parameters: @@ -907,13 +882,6 @@ paths: required: false schema: type: string - - name: search_keyword - in: query - required: false - schema: - type: string - description: Search term to filter app integrations (case-insensitive substring match). Matches if the display name, - the OAuth client_id, or the integration id contains the term. responses: '200': description: Success @@ -1123,75 +1091,68 @@ paths: schema: type: object properties: - policy: + create_time: + type: string + description: + type: string + description: Description of the federation policy. + name: + type: string + description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` + for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` + for Service Principal Federation Policies. Typically an output parameter, which does not need to be specified + in create or update requests. If specified in a request, must match the value in the request URL. + oidc_policy: type: object properties: - create_time: - type: string - description: + audiences: + type: array + items: + type: string + description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The audience + identifier is intended to represent the recipient of the token. Can be any non-empty string value. + As long as the audience in the token matches at least one audience in the policy, the token is considered + a match. If audiences is unspecified, defaults to your Databricks account id. + issuer: type: string - description: Description of the federation policy. - name: + description: The required token issuer, as specified in the 'iss' claim of federated tokens. + jwks_json: type: string - description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` - for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` - for Service Principal Federation Policies. Typically an output parameter, which does not need to be - specified in create or update requests. If specified in a request, must match the value in the request - URL. - oidc_policy: - type: object - properties: - audiences: - type: array - items: - type: string - description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The - audience identifier is intended to represent the recipient of the token. Can be any non-empty - string value. As long as the audience in the token matches at least one audience in the policy, - the token is considered a match. If audiences is unspecified, defaults to your Databricks account - id. - issuer: - type: string - description: The required token issuer, as specified in the 'iss' claim of federated tokens. - jwks_json: - type: string - description: The public keys used to validate the signature of federated tokens, in JWKS format. - Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified - (recommended), Databricks automatically fetches the public keys from your issuer’s well known - endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering - public keys. - jwks_uri: - type: string - description: URL of the public keys used to validate the signature of federated tokens, in JWKS - format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both - unspecified (recommended), Databricks automatically fetches the public keys from your issuer’s - well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint - for discovering public keys. - subject: - type: string - description: The required token subject, as specified in the subject claim of federated tokens. - Must be specified for service principal federation policies. Must not be specified for account - federation policies. - subject_claim: - type: string - description: The claim that contains the subject of the token. If unspecified, the default value - is 'sub'. - description: Specifies the policy to use for validating OIDC claims in your federated tokens. - policy_id: + description: The public keys used to validate the signature of federated tokens, in JWKS format. Most + use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), + Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks + strongly recommends relying on your issuer’s well known endpoint for discovering public keys. + jwks_uri: type: string - description: The ID of the federation policy. Output only. - service_principal_id: - type: integer - description: The service principal ID that this federation policy applies to. Output only. Only set - for service principal federation policies. - uid: + description: URL of the public keys used to validate the signature of federated tokens, in JWKS format. + Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified + (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. + Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public + keys. + subject: type: string - description: Unique, immutable id of the federation policy. - update_time: + description: The required token subject, as specified in the subject claim of federated tokens. Must + be specified for service principal federation policies. Must not be specified for account federation + policies. + subject_claim: type: string - description: Last update time of the federation policy. - required: - - policy + description: The claim that contains the subject of the token. If unspecified, the default value is + 'sub'. + description: audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy + configuration is captured in create/update audit logs (see go/auditlogs). + policy_id: + type: string + description: The ID of the federation policy. Output only. + service_principal_id: + type: integer + description: The service principal ID that this federation policy applies to. Output only. Only set for + service principal federation policies. + uid: + type: string + description: Unique, immutable id of the federation policy. + update_time: + type: string + description: Last update time of the federation policy. responses: '200': description: Success @@ -1421,75 +1382,68 @@ paths: schema: type: object properties: - policy: + create_time: + type: string + description: + type: string + description: Description of the federation policy. + name: + type: string + description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` + for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` + for Service Principal Federation Policies. Typically an output parameter, which does not need to be specified + in create or update requests. If specified in a request, must match the value in the request URL. + oidc_policy: type: object properties: - create_time: - type: string - description: + audiences: + type: array + items: + type: string + description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The audience + identifier is intended to represent the recipient of the token. Can be any non-empty string value. + As long as the audience in the token matches at least one audience in the policy, the token is considered + a match. If audiences is unspecified, defaults to your Databricks account id. + issuer: type: string - description: Description of the federation policy. - name: + description: The required token issuer, as specified in the 'iss' claim of federated tokens. + jwks_json: type: string - description: Resource name for the federation policy. Example values include ``accounts//federationPolicies/my-federation-policy`` - for Account Federation Policies, and ``accounts//servicePrincipals//federationPolicies/my-federation-policy`` - for Service Principal Federation Policies. Typically an output parameter, which does not need to be - specified in create or update requests. If specified in a request, must match the value in the request - URL. - oidc_policy: - type: object - properties: - audiences: - type: array - items: - type: string - description: The allowed token audiences, as specified in the 'aud' claim of federated tokens. The - audience identifier is intended to represent the recipient of the token. Can be any non-empty - string value. As long as the audience in the token matches at least one audience in the policy, - the token is considered a match. If audiences is unspecified, defaults to your Databricks account - id. - issuer: - type: string - description: The required token issuer, as specified in the 'iss' claim of federated tokens. - jwks_json: - type: string - description: The public keys used to validate the signature of federated tokens, in JWKS format. - Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified - (recommended), Databricks automatically fetches the public keys from your issuer’s well known - endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering - public keys. - jwks_uri: - type: string - description: URL of the public keys used to validate the signature of federated tokens, in JWKS - format. Most use cases should not need to specify this field. If jwks_uri and jwks_json are both - unspecified (recommended), Databricks automatically fetches the public keys from your issuer’s - well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint - for discovering public keys. - subject: - type: string - description: The required token subject, as specified in the subject claim of federated tokens. - Must be specified for service principal federation policies. Must not be specified for account - federation policies. - subject_claim: - type: string - description: The claim that contains the subject of the token. If unspecified, the default value - is 'sub'. - description: Specifies the policy to use for validating OIDC claims in your federated tokens. - policy_id: + description: The public keys used to validate the signature of federated tokens, in JWKS format. Most + use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified (recommended), + Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks + strongly recommends relying on your issuer’s well known endpoint for discovering public keys. + jwks_uri: type: string - description: The ID of the federation policy. Output only. - service_principal_id: - type: integer - description: The service principal ID that this federation policy applies to. Output only. Only set - for service principal federation policies. - uid: + description: URL of the public keys used to validate the signature of federated tokens, in JWKS format. + Most use cases should not need to specify this field. If jwks_uri and jwks_json are both unspecified + (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. + Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public + keys. + subject: type: string - description: Unique, immutable id of the federation policy. - update_time: + description: The required token subject, as specified in the subject claim of federated tokens. Must + be specified for service principal federation policies. Must not be specified for account federation + policies. + subject_claim: type: string - description: Last update time of the federation policy. - required: - - policy + description: The claim that contains the subject of the token. If unspecified, the default value is + 'sub'. + description: audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy + configuration is captured in create/update audit logs (see go/auditlogs). + policy_id: + type: string + description: The ID of the federation policy. Output only. + service_principal_id: + type: integer + description: The service principal ID that this federation policy applies to. Output only. Only set for + service principal federation policies. + uid: + type: string + description: Unique, immutable id of the federation policy. + update_time: + type: string + description: Last update time of the federation policy. responses: '200': description: Success @@ -1703,16 +1657,9 @@ components: type: string description: OAuth client-secret generated by the Databricks. If this is a confidential OAuth app client-secret will be generated. - client_secret_expire_time: - type: string - format: date-time - description: The expiration time of the client secret. If not present, the secret does not expire. integration_id: type: string description: Unique integration id for the custom OAuth app - principal_id: - type: integer - description: The principal id of the service principal associated with this OAuth app. CreatePublishedAppIntegrationOutput: type: object properties: @@ -1768,6 +1715,8 @@ components: in create or update requests. If specified in a request, must match the value in the request URL. oidc_policy: $ref: '#/components/schemas/OidcFederationPolicy' + description: audit_mode INCLUDE is required on both this message field and its leaf fields so the OIDC policy configuration + is captured in create/update audit logs (see go/auditlogs). policy_id: type: string description: The ID of the federation policy. Output only. @@ -1801,9 +1750,6 @@ components: name: type: string description: The display name of the custom OAuth app - principal_id: - type: integer - description: The principal id of the service principal associated with this OAuth app. redirect_urls: type: array items: @@ -2339,7 +2285,6 @@ components: JSON_EXTRACT(fp.oidc_policy, '$.jwks_uri') AS oidc_jwks_uri, JSON_EXTRACT(fp.oidc_policy, '$.jwks_json') AS oidc_jwks_json FROM databricks_account.oauth2.account_federation_policy fp - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -2359,7 +2304,6 @@ components: fp.oidc_policy->>'jwks_uri' AS oidc_jwks_uri, fp.oidc_policy->>'jwks_json' AS oidc_jwks_json FROM databricks_account.oauth2.account_federation_policy fp - WHERE account_id = '{{ account_id }}' vw_custom_app_integrations: name: vw_custom_app_integrations id: databricks_account.oauth2.vw_custom_app_integrations @@ -2436,7 +2380,6 @@ components: JSON_EXTRACT(c.token_access_policy, '$.absolute_session_lifetime_in_minutes') AS session_lifetime_minutes, JSON_EXTRACT(c.token_access_policy, '$.enable_single_use_refresh_tokens') AS single_use_refresh_tokens FROM databricks_account.oauth2.custom_app_integration c - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -2457,7 +2400,6 @@ components: (c.token_access_policy->>'absolute_session_lifetime_in_minutes')::integer AS session_lifetime_minutes, (c.token_access_policy->>'enable_single_use_refresh_tokens')::boolean AS single_use_refresh_tokens FROM databricks_account.oauth2.custom_app_integration c - WHERE account_id = '{{ account_id }}' vw_published_app_integrations: name: vw_published_app_integrations id: databricks_account.oauth2.vw_published_app_integrations @@ -2514,7 +2456,6 @@ components: JSON_EXTRACT(p.token_access_policy, '$.absolute_session_lifetime_in_minutes') AS session_lifetime_minutes, JSON_EXTRACT(p.token_access_policy, '$.enable_single_use_refresh_tokens') AS single_use_refresh_tokens FROM databricks_account.oauth2.published_app_integration p - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -2530,7 +2471,6 @@ components: (p.token_access_policy->>'absolute_session_lifetime_in_minutes')::integer AS session_lifetime_minutes, (p.token_access_policy->>'enable_single_use_refresh_tokens')::boolean AS single_use_refresh_tokens FROM databricks_account.oauth2.published_app_integration p - WHERE account_id = '{{ account_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml index d5d62e91..f5d10431 100644 --- a/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml @@ -5,10 +5,23 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.provisioning servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/accounts/{account_id}/credentials: post: @@ -334,9 +347,6 @@ paths: key_vault_uri: type: string description: The base URI of the KeyVault. - subscription_id: - type: string - description: The Azure subscription ID to use for Key Vault access validation during CMK creation. tenant_id: type: string description: The tenant id where the KeyVault lives. @@ -1023,50 +1033,42 @@ paths: schema: type: object properties: - customer_facing_private_access_settings: - type: object - properties: - account_id: - type: string - description: The Databricks account ID that hosts the private access settings. - allowed_vpc_endpoint_ids: - type: array - items: - type: string - description: An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when - registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC - endpoint in AWS. Only used when private_access_level is set to ENDPOINT. This is an allow list of - VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink. If hybrid - access to your workspace is enabled by setting public_access_enabled to true, this control only works - for PrivateLink connections. To control how your workspace is accessed via public internet, see IP - access lists. - private_access_level: - type: string - x-enum: - - ACCOUNT - - ENDPOINT - description: The private access level controls which VPC endpoints can connect to the UI or API of any - workspace that attaches this private access settings object. ``ACCOUNT`` level access (the default) - allows only VPC endpoints that are registered in your Databricks account connect to your workspace. - ``ENDPOINT`` level access allows only specified VPC endpoints connect to your workspace. For details, - see allowed_vpc_endpoint_ids. - private_access_settings_id: - type: string - description: Databricks private access settings ID. - private_access_settings_name: - type: string - description: The human-readable name of the private access settings object. - public_access_enabled: - type: boolean - description: Determines if the workspace can be accessed over public internet. For fully private workspaces, - you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink - connections. Otherwise, specify true, which means that public access is enabled. - region: - type: string - description: The AWS region for workspaces attached to this private access settings object. - description: Properties of the new private access settings object. - required: - - customer_facing_private_access_settings + account_id: + type: string + description: The Databricks account ID that hosts the private access settings. + allowed_vpc_endpoint_ids: + type: array + items: + type: string + description: An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering + the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS. + Only used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints that in + your account that can connect to your workspace over AWS PrivateLink. If hybrid access to your workspace + is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. + To control how your workspace is accessed via public internet, see IP access lists. + private_access_level: + type: string + x-enum: + - ACCOUNT + - ENDPOINT + description: The private access level controls which VPC endpoints can connect to the UI or API of any workspace + that attaches this private access settings object. ``ACCOUNT`` level access (the default) allows only + VPC endpoints that are registered in your Databricks account connect to your workspace. ``ENDPOINT`` level + access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids. + private_access_settings_id: + type: string + description: Databricks private access settings ID. + private_access_settings_name: + type: string + description: The human-readable name of the private access settings object. + public_access_enabled: + type: boolean + description: Determines if the workspace can be accessed over public internet. For fully private workspaces, + you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink + connections. Otherwise, specify true, which means that public access is enabled. + region: + type: string + description: The AWS region for workspaces attached to this private access settings object. responses: '200': description: Success @@ -1530,7 +1532,6 @@ paths: custom plan that allows multiple workspaces per account. :param aws_region: str (optional) - :param azure_workspace_info: :class:`AzureWorkspaceInfo` (optional) :param cloud: str (optional) DEPRECATED: This field is being ignored by the server and will be removed in the future. The cloud name. This field always has the value ``gcp``. @@ -1612,14 +1613,6 @@ paths: properties: aws_region: type: string - azure_workspace_info: - type: object - properties: - resource_group: - type: string - subscription_id: - type: string - description: Azure Subscription ID cloud: type: string description: 'DEPRECATED: This field is being ignored by the server and will be removed in the future. The @@ -1972,62 +1965,111 @@ paths: schema: type: object properties: - customer_facing_workspace: + account_id: + type: string + aws_region: + type: string + azure_workspace_info: type: object properties: - account_id: + resource_group: type: string - aws_region: + subscription_id: type: string - azure_workspace_info: + description: Azure Subscription ID + cloud: + type: string + description: The cloud name. This field can have values like ``azure``, ``gcp``. + cloud_resource_container: + type: object + properties: + gcp: type: object properties: - resource_group: - type: string - subscription_id: + project_id: type: string - description: Azure Subscription ID - cloud: - type: string - description: The cloud name. This field can have values like ``azure``, ``gcp``. - cloud_resource_container: - type: object - properties: - gcp: - type: object - properties: - project_id: - type: string - compute_mode: + compute_mode: + type: string + x-enum: + - HYBRID + - SERVERLESS + description: The compute mode of the workspace. + creation_time: + type: integer + description: Time in epoch milliseconds when the workspace was created. + credentials_id: + type: string + description: ID of the workspace's credential configuration object. + custom_tags: + type: object + description: The custom tags key-value pairing that is attached to this workspace. The key-value pair is + a string of utf-8 characters. The value can be an empty string, with maximum length of 255 characters. + The key can be of maximum length of 127 characters, and cannot be empty. + deployment_name: + type: string + expected_workspace_status: + type: string + x-enum: + - BANNED + - CANCELLING + - FAILED + - NOT_PROVISIONED + - PROVISIONING + - RUNNING + description: A client owned field used to indicate the workspace status that the client expects to be in. + For now this is only used to unblock Temporal workflow for GCP least privileged workspace. + gcp_managed_network_config: + type: object + properties: + gke_cluster_pod_ip_range: type: string - x-enum: - - HYBRID - - SERVERLESS - description: The compute mode of the workspace. - creation_time: - type: integer - description: Time in epoch milliseconds when the workspace was created. - credentials_id: + description: The IP range that will be used to allocate GKE cluster Pods from. + gke_cluster_service_ip_range: type: string - description: ID of the workspace's credential configuration object. - custom_tags: - type: object - description: The custom tags key-value pairing that is attached to this workspace. The key-value pair - is a string of utf-8 characters. The value can be an empty string, with maximum length of 255 characters. - The key can be of maximum length of 127 characters, and cannot be empty. - deployment_name: + description: The IP range that will be used to allocate GKE cluster Services from. + subnet_cidr: type: string - expected_workspace_status: + description: 'The IP range which will be used to allocate GKE cluster nodes from. Note: Pods, services + and master IP range must be mutually exclusive.' + description: The network configuration for the workspace. + gke_config: + type: object + properties: + connectivity_type: type: string x-enum: - - BANNED - - CANCELLING - - FAILED - - NOT_PROVISIONED - - PROVISIONING - - RUNNING - description: A client owned field used to indicate the workspace status that the client expects to be - in. For now this is only used to unblock Temporal workflow for GCP least privileged workspace. + - PRIVATE_NODE_PUBLIC_MASTER + - PUBLIC_NODE_PUBLIC_MASTER + description: The type of network connectivity of the GKE cluster. + master_ip_range: + type: string + description: The IP range that will be used to allocate GKE cluster master resources from. This field + must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER. + description: The configurations of the GKE cluster used by the GCP workspace. + location: + type: string + description: The Google Cloud region of the workspace data plane in your Google account (for example, ``us-east4``). + managed_services_customer_managed_key_id: + type: string + description: ID of the key configuration for encrypting managed services. + network: + type: object + properties: + gcp_common_network_config: + type: object + properties: + gke_cluster_master_ip_range: + type: string + description: The IP range that will be used to allocate GKE cluster master resources from. This + field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER. + gke_connectivity_type: + type: string + x-enum: + - PRIVATE_NODE_PUBLIC_MASTER + - PUBLIC_NODE_PUBLIC_MASTER + description: The type of network connectivity of the GKE cluster. + description: The shared network config for GCP workspace. This object has common network configurations + that are network attributions of a workspace. This object is input-only. gcp_managed_network_config: type: object properties: @@ -2041,160 +2083,105 @@ paths: type: string description: 'The IP range which will be used to allocate GKE cluster nodes from. Note: Pods, services and master IP range must be mutually exclusive.' - description: The network configuration for the workspace. - gke_config: - type: object - properties: - connectivity_type: - type: string - x-enum: - - PRIVATE_NODE_PUBLIC_MASTER - - PUBLIC_NODE_PUBLIC_MASTER - description: The type of network connectivity of the GKE cluster. - master_ip_range: - type: string - description: The IP range that will be used to allocate GKE cluster master resources from. This - field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER. - description: The configurations of the GKE cluster used by the GCP workspace. - location: - type: string - description: The Google Cloud region of the workspace data plane in your Google account (for example, - ``us-east4``). - managed_services_customer_managed_key_id: - type: string - description: ID of the key configuration for encrypting managed services. - network: - type: object - properties: - gcp_common_network_config: - type: object - properties: - gke_cluster_master_ip_range: - type: string - description: The IP range that will be used to allocate GKE cluster master resources from. This - field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER. - gke_connectivity_type: - type: string - x-enum: - - PRIVATE_NODE_PUBLIC_MASTER - - PUBLIC_NODE_PUBLIC_MASTER - description: The type of network connectivity of the GKE cluster. - description: The shared network config for GCP workspace. This object has common network configurations - that are network attributions of a workspace. This object is input-only. - gcp_managed_network_config: - type: object - properties: - gke_cluster_pod_ip_range: - type: string - description: The IP range that will be used to allocate GKE cluster Pods from. - gke_cluster_service_ip_range: - type: string - description: The IP range that will be used to allocate GKE cluster Services from. - subnet_cidr: - type: string - description: 'The IP range which will be used to allocate GKE cluster nodes from. Note: Pods, - services and master IP range must be mutually exclusive.' - description: The mutually exclusive network deployment modes. The option decides which network mode - the workspace will use. The network config for GCP workspace with Databricks managed network. - This object is input-only and will not be provided when listing workspaces. - network_id: - type: string - description: The ID of the network object, if the workspace is a BYOVPC workspace. This should apply - to workspaces on all clouds in internal services. In accounts-rest-api, user will use workspace.network_id - for input and output instead. Currently (2021-06-19) the network ID is only used by GCP. - description: The network configuration for the workspace. DEPRECATED. Use ``network_id`` instead. - network_connectivity_config_id: - type: string - description: The object ID of network connectivity config. + description: The mutually exclusive network deployment modes. The option decides which network mode + the workspace will use. The network config for GCP workspace with Databricks managed network. This + object is input-only and will not be provided when listing workspaces. network_id: type: string - description: If this workspace is BYO VPC, then the network_id will be populated. If this workspace - is not BYO VPC, then the network_id will be empty. - pricing_tier: - type: string - x-enum: - - COMMUNITY_EDITION - - DEDICATED - - ENTERPRISE - - PREMIUM - - STANDARD - - UNKNOWN - description: |- - Create a collection of name/value pairs. + description: The ID of the network object, if the workspace is a BYOVPC workspace. This should apply + to workspaces on all clouds in internal services. In accounts-rest-api, user will use workspace.network_id + for input and output instead. Currently (2021-06-19) the network ID is only used by GCP. + description: The network configuration for the workspace. DEPRECATED. Use ``network_id`` instead. + network_connectivity_config_id: + type: string + description: The object ID of network connectivity config. + network_id: + type: string + description: If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not + BYO VPC, then the network_id will be empty. + pricing_tier: + type: string + x-enum: + - COMMUNITY_EDITION + - DEDICATED + - ENTERPRISE + - PREMIUM + - STANDARD + - UNKNOWN + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - private_access_settings_id: - type: string - description: ID of the workspace's private access settings object. Only used for PrivateLink. You must - specify this ID if you are using `AWS PrivateLink `__ for either - front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both - connection types. Before configuring PrivateLink, read the `Databricks article about PrivateLink `__.", - storage_configuration_id: - type: string - description: ID of the workspace's storage configuration object. - storage_customer_managed_key_id: - type: string - description: ID of the key configuration for encrypting workspace storage. - storage_mode: - type: string - x-enum: - - CUSTOMER_HOSTED - - DEFAULT_STORAGE - description: The storage mode of the workspace. - workspace_id: - type: integer - description: A unique integer ID for the workspace - workspace_name: - type: string - description: The human-readable name of the workspace. - workspace_status: - type: string - x-enum: - - BANNED - - CANCELLING - - FAILED - - NOT_PROVISIONED - - PROVISIONING - - RUNNING - description: The status of a workspace - workspace_status_message: - type: string - description: Message describing the current workspace status. - required: - - customer_facing_workspace + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + private_access_settings_id: + type: string + description: ID of the workspace's private access settings object. Only used for PrivateLink. You must specify + this ID if you are using `AWS PrivateLink `__ for either front-end + (user-to-workspace connection), back-end (data plane to control plane connection), or both connection + types. Before configuring PrivateLink, read the `Databricks article about PrivateLink `__.", + storage_configuration_id: + type: string + description: ID of the workspace's storage configuration object. + storage_customer_managed_key_id: + type: string + description: ID of the key configuration for encrypting workspace storage. + storage_mode: + type: string + x-enum: + - CUSTOMER_HOSTED + - DEFAULT_STORAGE + description: The storage mode of the workspace. + workspace_id: + type: integer + description: A unique integer ID for the workspace + workspace_name: + type: string + description: The human-readable name of the workspace. + workspace_status: + type: string + x-enum: + - BANNED + - CANCELLING + - FAILED + - NOT_PROVISIONED + - PROVISIONING + - RUNNING + description: The status of a workspace + workspace_status_message: + type: string + description: Message describing the current workspace status. responses: '200': description: Success @@ -2255,9 +2242,6 @@ components: key_vault_uri: type: string description: The base URI of the KeyVault. - subscription_id: - type: string - description: The Azure subscription ID to use for Key Vault access validation during CMK creation. tenant_id: type: string description: The tenant id where the KeyVault lives. @@ -2310,9 +2294,6 @@ components: key_vault_uri: type: string description: The base URI of the KeyVault. - subscription_id: - type: string - description: The Azure subscription ID to use for Key Vault access validation during CMK creation. tenant_id: type: string description: The tenant id where the KeyVault lives. @@ -3574,7 +3555,6 @@ components: JSON_EXTRACT(w.gke_config, '$.connectivity_type') AS gke_connectivity_type, JSON_EXTRACT(w.gke_config, '$.master_ip_range') AS gke_master_ip_range FROM databricks_account.provisioning.workspaces w - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3609,7 +3589,6 @@ components: w.gke_config->>'connectivity_type' AS gke_connectivity_type, w.gke_config->>'master_ip_range' AS gke_master_ip_range FROM databricks_account.provisioning.workspaces w - WHERE account_id = '{{ account_id }}' vw_networks: name: vw_networks id: databricks_account.provisioning.vw_networks @@ -3694,7 +3673,6 @@ components: JSON_EXTRACT(n.vpc_endpoints, '$.rest_api') AS vpc_endpoint_rest_api_ids, JSON_EXTRACT(n.vpc_endpoints, '$.dataplane_relay') AS vpc_endpoint_dataplane_relay_ids FROM databricks_account.provisioning.networks n - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3717,7 +3695,6 @@ components: n.vpc_endpoints->'rest_api' AS vpc_endpoint_rest_api_ids, n.vpc_endpoints->'dataplane_relay' AS vpc_endpoint_dataplane_relay_ids FROM databricks_account.provisioning.networks n - WHERE account_id = '{{ account_id }}' vw_network_errors: name: vw_network_errors id: databricks_account.provisioning.vw_network_errors @@ -3759,7 +3736,6 @@ components: JSON_EXTRACT(e.value, '$.error_message') AS error_message FROM databricks_account.provisioning.networks n, JSON_EACH(n.error_messages) e - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3772,7 +3748,6 @@ components: e.value->>'error_message' AS error_message FROM databricks_account.provisioning.networks n, jsonb_array_elements(n.error_messages::jsonb) AS e - WHERE account_id = '{{ account_id }}' vw_network_warnings: name: vw_network_warnings id: databricks_account.provisioning.vw_network_warnings @@ -3814,7 +3789,6 @@ components: JSON_EXTRACT(w.value, '$.warning_message') AS warning_message FROM databricks_account.provisioning.networks n, JSON_EACH(n.warning_messages) w - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3827,7 +3801,6 @@ components: w.value->>'warning_message' AS warning_message FROM databricks_account.provisioning.networks n, jsonb_array_elements(n.warning_messages::jsonb) AS w - WHERE account_id = '{{ account_id }}' vw_encryption_keys: name: vw_encryption_keys id: databricks_account.provisioning.vw_encryption_keys @@ -3910,7 +3883,6 @@ components: END AS cloud_type FROM databricks_account.provisioning.encryption_keys k, JSON_EACH(k.use_cases) uc - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3937,7 +3909,6 @@ components: END AS cloud_type FROM databricks_account.provisioning.encryption_keys k, jsonb_array_elements(k.use_cases::jsonb) AS uc - WHERE account_id = '{{ account_id }}' vw_credentials: name: vw_credentials id: databricks_account.provisioning.vw_credentials @@ -3974,7 +3945,6 @@ components: c.creation_time, JSON_EXTRACT(c.aws_credentials, '$.sts_role.role_arn') AS aws_role_arn FROM databricks_account.provisioning.credentials c - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3985,7 +3955,6 @@ components: c.creation_time, c.aws_credentials->'sts_role'->>'role_arn' AS aws_role_arn FROM databricks_account.provisioning.credentials c - WHERE account_id = '{{ account_id }}' vw_storage_configurations: name: vw_storage_configurations id: databricks_account.provisioning.vw_storage_configurations @@ -4026,7 +3995,6 @@ components: s.role_arn, JSON_EXTRACT(s.root_bucket_info, '$.bucket_name') AS root_bucket_name FROM databricks_account.provisioning.storage s - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4038,7 +4006,6 @@ components: s.role_arn, s.root_bucket_info->>'bucket_name' AS root_bucket_name FROM databricks_account.provisioning.storage s - WHERE account_id = '{{ account_id }}' vw_vpc_endpoints: name: vw_vpc_endpoints id: databricks_account.provisioning.vw_vpc_endpoints @@ -4119,7 +4086,6 @@ components: ELSE 'UNKNOWN' END AS cloud_type FROM databricks_account.provisioning.vpc_endpoints v - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4144,7 +4110,6 @@ components: ELSE 'UNKNOWN' END AS cloud_type FROM databricks_account.provisioning.vpc_endpoints v - WHERE account_id = '{{ account_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/settings.yaml b/providers/src/databricks_account/v00.00.00000/services/settings.yaml index c75d0aa9..a2532436 100644 --- a/providers/src/databricks_account/v00.00.00000/services/settings.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/settings.yaml @@ -5,10 +5,23 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.settings servers: -- url: https://accounts.cloud.databricks.com +- url: https://{account_host} + variables: + account_host: + description: The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or + set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.0/accounts/{account_id}/ip-access-lists: post: @@ -412,24 +425,18 @@ paths: schema: type: object properties: - network_connectivity_config: - type: object - properties: - name: - type: string - description: The name of the network connectivity configuration. The name can contain alphanumeric characters, - hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the - regular expression ^[0-9a-zA-Z-_]{3,30}$ - region: - type: string - description: The region for the network connectivity configuration. Only workspaces in the same region - can be attached to the network connectivity configuration. - required: - - name - - region - description: Properties of the new network connectivity configuration. + name: + type: string + description: The name of the network connectivity configuration. The name can contain alphanumeric characters, + hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular + expression ^[0-9a-zA-Z-_]{3,30}$ + region: + type: string + description: The region for the network connectivity configuration. Only workspaces in the same region can + be attached to the network connectivity configuration. required: - - network_connectivity_config + - name + - region responses: '200': description: Success @@ -533,64 +540,56 @@ paths: schema: type: object properties: - private_endpoint_rule: + domain_names: + type: array + items: + type: string + description: Only used by private endpoints to customer-managed private endpoint services. Domain names + of target private link service. When updating this field, the full list of target domain_names must be + specified. + endpoint_service: + type: string + description: The full target AWS endpoint service name that connects to the destination resources of the + private endpoint. + error_message: + type: string + gcp_endpoint: type: object properties: - domain_names: - type: array - items: - type: string - description: Only used by private endpoints to customer-managed private endpoint services. Domain names - of target private link service. When updating this field, the full list of target domain_names must - be specified. - endpoint_service: - type: string - description: The full target AWS endpoint service name that connects to the destination resources of - the private endpoint. - error_message: - type: string - gcp_endpoint: + all_vpc_sc_services: + type: boolean + google_api_endpoints: type: object properties: - all_vpc_sc_services: - type: boolean - google_api_endpoints: - type: object - properties: - endpoints: - type: array - items: - type: string - description: Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". - Use "googleapis.com" to cover all Google APIs. - description: Selected Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". - psc_endpoint_uri: - type: string - description: Output only. The URI of the created PSC endpoint. - service_attachment: - type: string - description: 'The full url of the target service attachment. Example: projects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment' - group_id: + endpoints: + type: array + items: + type: string + description: Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". Use + "googleapis.com" to cover all Google APIs. + description: Selected Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". + psc_endpoint_uri: type: string - description: Not used by customer-managed private endpoint services. The sub-resource type (group ID) - of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, - one for blob and one for dfs. - resource_id: + description: Output only. The URI of the created PSC endpoint. + service_attachment: type: string - description: The Azure resource ID of the target resource. - resource_names: - type: array - items: - type: string - description: Only used by private endpoints towards AWS S3 service. The globally unique S3 bucket names - that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint - service. When updating this field, we perform full update on this field. Please ensure a full list - of desired resource_names is provided. - description: |- - Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure - portal after initialization. - required: - - private_endpoint_rule + description: 'The full url of the target service attachment. Example: projects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment' + group_id: + type: string + description: Not used by customer-managed private endpoint services. The sub-resource type (group ID) of + the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, + one for blob and one for dfs. + resource_id: + type: string + description: The Azure resource ID of the target resource. + resource_names: + type: array + items: + type: string + description: Only used by private endpoints towards AWS S3 service. The globally unique S3 bucket names + that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint + service. When updating this field, we perform full update on this field. Please ensure a full list of + desired resource_names is provided. responses: '200': description: Success @@ -621,7 +620,6 @@ paths: :param network_connectivity_config_id: str Your Network Connectvity Configuration ID. - :param page_size: int (optional) :param page_token: str (optional) Pagination token to go to next page based on previous query. @@ -638,11 +636,6 @@ paths: schema: type: string description: Your Network Connectvity Configuration ID. - - name: page_size - in: query - required: false - schema: - type: integer - name: page_token in: query required: false @@ -917,56 +910,48 @@ paths: schema: type: object properties: - private_endpoint_rule: + domain_names: + type: array + items: + type: string + description: Only used by private endpoints to customer-managed private endpoint services. Domain names + of target private link service. When updating this field, the full list of target domain_names must be + specified. + enabled: + type: boolean + description: Update this field to activate/deactivate this private endpoint to allow egress access from + serverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3). + error_message: + type: string + gcp_endpoint: type: object properties: - domain_names: - type: array - items: - type: string - description: Only used by private endpoints to customer-managed private endpoint services. Domain names - of target private link service. When updating this field, the full list of target domain_names must - be specified. - enabled: + all_vpc_sc_services: type: boolean - description: Update this field to activate/deactivate this private endpoint to allow egress access from - serverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3). - error_message: - type: string - gcp_endpoint: + google_api_endpoints: type: object properties: - all_vpc_sc_services: - type: boolean - google_api_endpoints: - type: object - properties: - endpoints: - type: array - items: - type: string - description: Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". - Use "googleapis.com" to cover all Google APIs. - description: Selected Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". - psc_endpoint_uri: - type: string - description: Output only. The URI of the created PSC endpoint. - service_attachment: - type: string - description: 'The full url of the target service attachment. Example: projects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment' - resource_names: - type: array - items: - type: string - description: Only used by private endpoints towards AWS S3 service. The globally unique S3 bucket names - that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint - service. When updating this field, we perform full update on this field. Please ensure a full list - of desired resource_names is provided. - description: |- - Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure - portal after initialization. - required: - - private_endpoint_rule + endpoints: + type: array + items: + type: string + description: Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". Use + "googleapis.com" to cover all Google APIs. + description: Selected Google API hostnames, e.g. "storage.googleapis.com", "bigquery.googleapis.com". + psc_endpoint_uri: + type: string + description: Output only. The URI of the created PSC endpoint. + service_attachment: + type: string + description: 'The full url of the target service attachment. Example: projects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment' + resource_names: + type: array + items: + type: string + description: Only used by private endpoints towards AWS S3 service. The globally unique S3 bucket names + that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint + service. When updating this field, we perform full update on this field. Please ensure a full list of + desired resource_names is provided. responses: '200': description: Success @@ -1013,115 +998,313 @@ paths: schema: type: object properties: - network_policy: + account_id: + type: string + egress: type: object properties: - account_id: - type: string - egress: + network_access: type: object properties: - network_access: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: + Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can + only access explicitly allowed internet and storage destinations, as well as UC connections and + external locations. + allowed_databricks_destinations: + type: array + items: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: List of Databricks workspace destinations that serverless workloads are allowed to + access when in RESTRICTED_ACCESS mode. + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + description: The internet destination to which access will be allowed. Format dependent on + the destination type. + internet_destination_type: + type: string + x-enum: + - DNS_NAME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: |- + Users can specify accessible internet destinations when outbound access is restricted. We only + support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend + support to host names and IP addresses. + description: List of internet destinations that serverless workloads are allowed to access when + in RESTRICTED_ACCESS mode. + allowed_storage_destinations: + type: array + items: + type: object + properties: + azure_storage_account: + type: string + description: The Azure storage account name. + azure_storage_service: + type: string + description: The Azure storage service type (blob, dfs, etc.). + bucket_name: + type: string + region: + type: string + storage_destination_type: + type: string + x-enum: + - AWS_S3 + - AZURE_STORAGE + - GOOGLE_CLOUD_STORAGE + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Users can specify accessible storage destinations. + description: List of storage destinations that serverless workloads are allowed to access when in + RESTRICTED_ACCESS mode. + blocked_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + description: The internet destination to which access will be allowed. Format dependent on + the destination type. + internet_destination_type: + type: string + x-enum: + - DNS_NAME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: |- + Users can specify accessible internet destinations when outbound access is restricted. We only + support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend + support to host names and IP addresses. + description: List of internet destinations that serverless workloads are blocked from accessing. + These destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN. Currently + supports DNS_NAME type only; IP_RANGE support is planned. + policy_enforcement: type: object properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: - Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can - only access explicitly allowed internet and storage destinations, as well as UC connections and - external locations. - allowed_databricks_destinations: + dry_run_mode_product_filter: type: array items: + type: string + x-enum: + - DBSQL + - ML_SERVING + description: The values should match the list of workloads used in networkconfig.proto + enforcement_mode: + type: string + x-enum: + - DRY_RUN + - ENFORCED + description: The mode of policy enforcement. ENFORCED blocks traffic that violates policy, while + DRY_RUN only logs violations without blocking. When not specified, defaults to ENFORCED. + description: Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES + required: + - restriction_mode + description: The access policy enforced for egress traffic to the internet. + description: The network policies applying for egress traffic. + ingress: + type: object + properties: + cross_workspace_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - LEGACY_MODE + - RESTRICTED_ACCESS + description: |- + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. + allow_rules: + type: array + items: + type: object + properties: + authentication: type: object properties: - workspace_ids: + identities: type: array items: - type: integer - description: List of Databricks workspace destinations that serverless workloads are allowed - to access when in RESTRICTED_ACCESS mode. - allowed_internet_destinations: - type: array - items: - type: object - properties: - destination: - type: string - description: The internet destination to which access will be allowed. Format dependent - on the destination type. - internet_destination_type: - type: string - x-enum: - - DNS_NAME - description: |- - Create a collection of name/value pairs. + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: |- - Users can specify accessible internet destinations when outbound access is restricted. We only - support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend - support to host names and IP addresses. - description: List of internet destinations that serverless workloads are allowed to access when - in RESTRICTED_ACCESS mode. - allowed_storage_destinations: - type: array - items: - type: object - properties: - azure_storage_account: - type: string - description: The Azure storage account name. - azure_storage_service: - type: string - description: The Azure storage service type (blob, dfs, etc.). - bucket_name: - type: string - region: - type: string - storage_destination_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string x-enum: - - AWS_S3 - - AZURE_STORAGE - - GOOGLE_CLOUD_STORAGE + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES description: |- Create a collection of name/value pairs. @@ -1159,22 +1342,170 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - description: Users can specify accessible storage destinations. - description: List of storage destinations that serverless workloads are allowed to access when - in RESTRICTED_ACCESS mode. - blocked_internet_destinations: - type: array - items: + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: type: object properties: - destination: - type: string - description: The internet destination to which access will be allowed. Format dependent - on the destination type. - internet_destination_type: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string x-enum: - - DNS_NAME + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES description: |- Create a collection of name/value pairs. @@ -1212,3244 +1543,3929 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - description: |- - Users can specify accessible internet destinations when outbound access is restricted. We only - support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend - support to host names and IP addresses. - description: List of internet destinations that serverless workloads are blocked from accessing. - These destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN. Currently - supports DNS_NAME type only; IP_RANGE support is planned. - policy_enforcement: - type: object - properties: - dry_run_mode_product_filter: - type: array - items: - type: string - x-enum: - - DBSQL - - ML_SERVING - description: The values should match the list of workloads used in networkconfig.proto - enforcement_mode: - type: string - x-enum: - - DRY_RUN - - ENFORCED - description: The mode of policy enforcement. ENFORCED blocks traffic that violates policy, - while DRY_RUN only logs violations without blocking. When not specified, defaults to ENFORCED. - description: Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES - required: - - restriction_mode - description: The access policy enforced for egress traffic to the internet. - description: The network policies applying for egress traffic. - ingress: - type: object - properties: - cross_workspace_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: type: object properties: - authentication: + account_api: type: object properties: - identities: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: type: object properties: - all_source_workspaces: + all_destinations: type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - deny_rules: - type: array - items: + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_source_workspaces: + type: boolean + selected_workspaces: type: object properties: - identities: + workspace_ids: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: 'The network policy restrictions for cross-workspace access: which other workspaces may + access this workspace.' + private_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - ALLOW_ALL_REGISTERED_ENDPOINTS + - RESTRICTED_ACCESS + description: The restriction mode for private access. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_source_workspaces: - type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - required: - - restriction_mode - private_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - ALLOW_ALL_REGISTERED_ENDPOINTS - - RESTRICTED_ACCESS - description: The restriction mode for private access. - allow_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: type: object properties: - all_private_access: + all_destinations: type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: + lakebase_runtime: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Allow rules are evaluated after deny rules. A request matching any allow rule is - allowed; a request matching no rule is denied by default. Only applies when restriction_mode - is RESTRICTED_ACCESS. - deny_rules: - type: array - items: + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: type: object properties: - identities: + endpoint_ids: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_private_access: - type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: - type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: - type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless - of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. - required: - - restriction_mode - description: The network policy restrictions for private access. Configures how requests arriving - over private connectivity are governed. - public_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: type: object properties: - authentication: + account_api: type: object properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: type: object properties: - all_ip_ranges: + all_destinations: type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - deny_rules: - type: array - items: - type: object - properties: - authentication: + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: type: object properties: - identities: + excluded_scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: type: object properties: - all_ip_ranges: - type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - required: - - restriction_mode - description: The network policy restrictions for public access to the workspace. Configures how - public internet traffic is allowed or denied access. - description: The network policies applying for ingress traffic. - ingress_dry_run: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: The network policy restrictions for private access. Configures how requests arriving over + private connectivity are governed. + public_access: type: object properties: - cross_workspace_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + allow_rules: + type: array + items: + type: object + properties: + authentication: type: object properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_source_workspaces: - type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - deny_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: type: object properties: - all_source_workspaces: + all_destinations: type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - required: - - restriction_mode - private_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - ALLOW_ALL_REGISTERED_ENDPOINTS - - RESTRICTED_ACCESS - description: The restriction mode for private access. - allow_rules: - type: array - items: + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: type: object properties: - identities: + ip_ranges: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_private_access: - type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: - type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: - type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Allow rules are evaluated after deny rules. A request matching any allow rule is - allowed; a request matching no rule is denied by default. Only applies when restriction_mode - is RESTRICTED_ACCESS. - deny_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: type: object properties: - all_private_access: + all_destinations: type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: + lakebase_runtime: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless - of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. - required: - - restriction_mode - description: The network policy restrictions for private access. Configures how requests arriving - over private connectivity are governed. - public_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + required: + - restriction_mode + description: The network policy restrictions for public access to the workspace. Configures how public + internet traffic is allowed or denied access. + description: The network policies applying for ingress traffic. + ingress_dry_run: + type: object + properties: + cross_workspace_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - LEGACY_MODE + - RESTRICTED_ACCESS + description: |- + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: type: object properties: - all_ip_ranges: + all_destinations: type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - deny_rules: - type: array - items: + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_source_workspaces: + type: boolean + selected_workspaces: type: object properties: - identities: + workspace_ids: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_ip_ranges: - type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - required: - - restriction_mode - description: The network policy restrictions for public access to the workspace. Configures how - public internet traffic is allowed or denied access. - description: The ingress policy for dry run mode. Dry run will always run even if the request is allowed - by the ingress policy. When this field is set, the policy will be evaluated and emit logs only without - blocking requests. - network_policy_id: - type: string - description: The unique identifier for the network policy. - description: Network policy configuration details. - required: - - network_policy - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/AccountNetworkPolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: NetworkPoliciesAPI - get: - operationId: network_policies_list_network_policies_rpc - summary: Gets an array of network policies. - tags: - - settings - - network_policies - description: |- - Gets an array of network policies. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - :param page_token: str (optional) - Pagination token to go to next page based on previous query. + Example enumeration: - :returns: Iterator over :class:`AccountNetworkPolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: page_token - in: query - required: false - schema: - type: string - description: Pagination token to go to next page based on previous query. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListNetworkPoliciesResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: NetworkPoliciesAPI - /api/2.0/accounts/{account_id}/network-policies/{network_policy_id}: - delete: - operationId: network_policies_delete_network_policy_rpc - summary: Deletes a network policy. Cannot be called on 'default-policy'. - tags: - - settings - - network_policies - description: |- - Deletes a network policy. Cannot be called on 'default-policy'. + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - :param network_policy_id: str - The unique identifier of the network policy to delete. - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: network_policy_id - in: path - required: true - schema: - type: string - description: The unique identifier of the network policy to delete. - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: NetworkPoliciesAPI - get: - operationId: network_policies_get_network_policy_rpc - summary: Gets a network policy. - tags: - - settings - - network_policies - description: |- - Gets a network policy. + Access them by: - :param network_policy_id: str - The unique identifier of the network policy to retrieve. + - attribute access: - :returns: :class:`AccountNetworkPolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: network_policy_id - in: path - required: true - schema: - type: string - description: The unique identifier of the network policy to retrieve. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/AccountNetworkPolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: NetworkPoliciesAPI - put: - operationId: network_policies_update_network_policy_rpc - summary: Updates a network policy. This allows you to modify the configuration of a network policy. - tags: - - settings - - network_policies - description: |- - Updates a network policy. This allows you to modify the configuration of a network policy. + >>> Color.RED + - :param network_policy_id: str - The unique identifier for the network policy. - :param network_policy: :class:`AccountNetworkPolicy` - Updated network policy configuration details. + - value lookup: - :returns: :class:`AccountNetworkPolicy` - parameters: - - name: account_id - in: path - required: true - schema: - type: string - - name: network_policy_id - in: path - required: true - schema: - type: string - description: The unique identifier for the network policy. - requestBody: - content: - application/json: - schema: - type: object - properties: - network_policy: - type: object - properties: - account_id: - type: string - egress: + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: 'The network policy restrictions for cross-workspace access: which other workspaces may + access this workspace.' + private_access: type: object properties: - network_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: - Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can - only access explicitly allowed internet and storage destinations, as well as UC connections and - external locations. - allowed_databricks_destinations: - type: array - items: + restriction_mode: + type: string + x-enum: + - ALLOW_ALL_REGISTERED_ENDPOINTS + - RESTRICTED_ACCESS + description: The restriction mode for private access. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: + type: object + properties: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: + type: object + properties: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: The network policy restrictions for private access. Configures how requests arriving over + private connectivity are governed. + public_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + required: + - restriction_mode + description: The network policy restrictions for public access to the workspace. Configures how public + internet traffic is allowed or denied access. + description: The ingress policy for dry run mode. Dry run will always run even if the request is allowed + by the ingress policy. When this field is set, the policy will be evaluated and emit logs only without + blocking requests. + network_policy_id: + type: string + description: The unique identifier for the network policy. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountNetworkPolicy' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: NetworkPoliciesAPI + get: + operationId: network_policies_list_network_policies_rpc + summary: Gets an array of network policies. + tags: + - settings + - network_policies + description: |- + Gets an array of network policies. + + :param page_token: str (optional) + Pagination token to go to next page based on previous query. + + :returns: Iterator over :class:`AccountNetworkPolicy` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + - name: page_token + in: query + required: false + schema: + type: string + description: Pagination token to go to next page based on previous query. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListNetworkPoliciesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: NetworkPoliciesAPI + /api/2.0/accounts/{account_id}/network-policies/{network_policy_id}: + delete: + operationId: network_policies_delete_network_policy_rpc + summary: Deletes a network policy. Cannot be called on 'default-policy'. + tags: + - settings + - network_policies + description: |- + Deletes a network policy. Cannot be called on 'default-policy'. + + :param network_policy_id: str + The unique identifier of the network policy to delete. + parameters: + - name: account_id + in: path + required: true + schema: + type: string + - name: network_policy_id + in: path + required: true + schema: + type: string + description: The unique identifier of the network policy to delete. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: NetworkPoliciesAPI + get: + operationId: network_policies_get_network_policy_rpc + summary: Gets a network policy. + tags: + - settings + - network_policies + description: |- + Gets a network policy. + + :param network_policy_id: str + The unique identifier of the network policy to retrieve. + + :returns: :class:`AccountNetworkPolicy` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + - name: network_policy_id + in: path + required: true + schema: + type: string + description: The unique identifier of the network policy to retrieve. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountNetworkPolicy' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: NetworkPoliciesAPI + put: + operationId: network_policies_update_network_policy_rpc + summary: Updates a network policy. This allows you to modify the configuration of a network policy. + tags: + - settings + - network_policies + description: |- + Updates a network policy. This allows you to modify the configuration of a network policy. + + :param network_policy_id: str + The unique identifier for the network policy. + :param network_policy: :class:`AccountNetworkPolicy` + Updated network policy configuration details. + + :returns: :class:`AccountNetworkPolicy` + parameters: + - name: account_id + in: path + required: true + schema: + type: string + - name: network_policy_id + in: path + required: true + schema: + type: string + description: The unique identifier for the network policy. + requestBody: + content: + application/json: + schema: + type: object + properties: + account_id: + type: string + egress: + type: object + properties: + network_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: + Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can + only access explicitly allowed internet and storage destinations, as well as UC connections and + external locations. + allowed_databricks_destinations: + type: array + items: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: List of Databricks workspace destinations that serverless workloads are allowed to + access when in RESTRICTED_ACCESS mode. + allowed_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + description: The internet destination to which access will be allowed. Format dependent on + the destination type. + internet_destination_type: + type: string + x-enum: + - DNS_NAME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: |- + Users can specify accessible internet destinations when outbound access is restricted. We only + support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend + support to host names and IP addresses. + description: List of internet destinations that serverless workloads are allowed to access when + in RESTRICTED_ACCESS mode. + allowed_storage_destinations: + type: array + items: + type: object + properties: + azure_storage_account: + type: string + description: The Azure storage account name. + azure_storage_service: + type: string + description: The Azure storage service type (blob, dfs, etc.). + bucket_name: + type: string + region: + type: string + storage_destination_type: + type: string + x-enum: + - AWS_S3 + - AZURE_STORAGE + - GOOGLE_CLOUD_STORAGE + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Users can specify accessible storage destinations. + description: List of storage destinations that serverless workloads are allowed to access when in + RESTRICTED_ACCESS mode. + blocked_internet_destinations: + type: array + items: + type: object + properties: + destination: + type: string + description: The internet destination to which access will be allowed. Format dependent on + the destination type. + internet_destination_type: + type: string + x-enum: + - DNS_NAME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: |- + Users can specify accessible internet destinations when outbound access is restricted. We only + support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend + support to host names and IP addresses. + description: List of internet destinations that serverless workloads are blocked from accessing. + These destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN. Currently + supports DNS_NAME type only; IP_RANGE support is planned. + policy_enforcement: + type: object + properties: + dry_run_mode_product_filter: + type: array + items: + type: string + x-enum: + - DBSQL + - ML_SERVING + description: The values should match the list of workloads used in networkconfig.proto + enforcement_mode: + type: string + x-enum: + - DRY_RUN + - ENFORCED + description: The mode of policy enforcement. ENFORCED blocks traffic that violates policy, while + DRY_RUN only logs violations without blocking. When not specified, defaults to ENFORCED. + description: Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES + required: + - restriction_mode + description: The access policy enforced for egress traffic to the internet. + description: The network policies applying for egress traffic. + ingress: + type: object + properties: + cross_workspace_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - LEGACY_MODE + - RESTRICTED_ACCESS + description: |- + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: 'The network policy restrictions for cross-workspace access: which other workspaces may + access this workspace.' + private_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - ALLOW_ALL_REGISTERED_ENDPOINTS + - RESTRICTED_ACCESS + description: The restriction mode for private access. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: + type: object + properties: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: + type: object + properties: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: The network policy restrictions for private access. Configures how requests arriving over + private connectivity are governed. + public_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: + type: string + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - workspace_ids: - type: array - items: - type: integer - description: List of Databricks workspace destinations that serverless workloads are allowed - to access when in RESTRICTED_ACCESS mode. - allowed_internet_destinations: - type: array - items: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + deny_rules: + type: array + items: + type: object + properties: + authentication: type: object properties: - destination: - type: string - description: The internet destination to which access will be allowed. Format dependent - on the destination type. - internet_destination_type: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string x-enum: - - DNS_NAME + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES description: |- Create a collection of name/value pairs. @@ -4487,33 +5503,193 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - description: |- - Users can specify accessible internet destinations when outbound access is restricted. We only - support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend - support to host names and IP addresses. - description: List of internet destinations that serverless workloads are allowed to access when - in RESTRICTED_ACCESS mode. - allowed_storage_destinations: - type: array - items: + destination: type: object properties: - azure_storage_account: - type: string - description: The Azure storage account name. - azure_storage_service: - type: string - description: The Azure storage service type (blob, dfs, etc.). - bucket_name: - type: string - region: - type: string - storage_destination_type: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + required: + - restriction_mode + description: The network policy restrictions for public access to the workspace. Configures how public + internet traffic is allowed or denied access. + description: The network policies applying for ingress traffic. + ingress_dry_run: + type: object + properties: + cross_workspace_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - LEGACY_MODE + - RESTRICTED_ACCESS + description: |- + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. + allow_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string x-enum: - - AWS_S3 - - AZURE_STORAGE - - GOOGLE_CLOUD_STORAGE + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES description: |- Create a collection of name/value pairs. @@ -4551,22 +5727,170 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - description: Users can specify accessible storage destinations. - description: List of storage destinations that serverless workloads are allowed to access when - in RESTRICTED_ACCESS mode. - blocked_internet_destinations: - type: array - items: + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: type: object properties: - destination: - type: string - description: The internet destination to which access will be allowed. Format dependent - on the destination type. - internet_destination_type: + account_api: + type: object + properties: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: + type: boolean + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: + type: object + properties: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string x-enum: - - DNS_NAME + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES description: |- Create a collection of name/value pairs. @@ -4604,3020 +5928,1017 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - description: |- - Users can specify accessible internet destinations when outbound access is restricted. We only - support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend - support to host names and IP addresses. - description: List of internet destinations that serverless workloads are blocked from accessing. - These destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN. Currently - supports DNS_NAME type only; IP_RANGE support is planned. - policy_enforcement: - type: object - properties: - dry_run_mode_product_filter: - type: array - items: - type: string - x-enum: - - DBSQL - - ML_SERVING - description: The values should match the list of workloads used in networkconfig.proto - enforcement_mode: - type: string - x-enum: - - DRY_RUN - - ENFORCED - description: The mode of policy enforcement. ENFORCED blocks traffic that violates policy, - while DRY_RUN only logs violations without blocking. When not specified, defaults to ENFORCED. - description: Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES - required: - - restriction_mode - description: The access policy enforced for egress traffic to the internet. - description: The network policies applying for egress traffic. - ingress: - type: object - properties: - cross_workspace_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. + destination: type: object properties: - authentication: + account_api: type: object properties: - identities: + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: + all_destinations: + type: boolean + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: The destination the request must match — the resource being accessed, for example + the workspace UI or workspace APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_source_workspaces: + type: boolean + selected_workspaces: type: object properties: - all_source_workspaces: - type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - deny_rules: - type: array - items: + workspace_ids: + type: array + items: + type: integer + description: Specific source workspace IDs to match. + description: The origin the request must match — the source workspace the request comes from, + either specific source workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: 'The network policy restrictions for cross-workspace access: which other workspaces may + access this workspace.' + private_access: + type: object + properties: + restriction_mode: + type: string + x-enum: + - ALLOW_ALL_REGISTERED_ENDPOINTS + - RESTRICTED_ACCESS + description: The restriction mode for private access. + allow_rules: + type: array + items: + type: object + properties: + authentication: type: object properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_source_workspaces: - type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - required: - - restriction_mode - private_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - ALLOW_ALL_REGISTERED_ENDPOINTS - - RESTRICTED_ACCESS - description: The restriction mode for private access. - allow_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: type: object properties: - all_private_access: + all_destinations: type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: + lakebase_runtime: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: + workspace_api: + type: object + properties: + excluded_scopes: + type: array + items: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: + type: string + x-enum: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: + all_destinations: type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Allow rules are evaluated after deny rules. A request matching any allow rule is - allowed; a request matching no rule is denied by default. Only applies when restriction_mode - is RESTRICTED_ACCESS. - deny_rules: - type: array - items: + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: type: object properties: - identities: + endpoint_ids: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; + a request matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_private_access: - type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: - type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: - type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless - of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. - required: - - restriction_mode - description: The network policy restrictions for private access. Configures how requests arriving - over private connectivity are governed. - public_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: The authenticated identity the request must match. When unset, the rule matches + all users and service principals. On the account-level network policy, scoping to specific + identities is not currently supported, so this field must be unset (the rule matches all + users and service principals). + destination: type: object properties: - authentication: + account_api: type: object properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: type: object properties: - all_ip_ranges: + all_destinations: type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - deny_rules: - type: array - items: - type: object - properties: - authentication: + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: type: object properties: - identities: + excluded_scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: The destination the request must match — the resource being accessed, for example + the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_private_access: + type: boolean + description: Matches requests arriving over any private connectivity, including registered + endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be used + in deny rules of workspace-level network policies. Must be set to true when specified. + all_registered_endpoints: + type: boolean + description: Matches requests arriving through any endpoint registered to the account. + Must be set to true when specified. + azure_workspace_private_link: + type: boolean + description: Matches requests arriving through the workspace's Azure Private Link (ui-api) + endpoints. Can only be used in deny rules of workspace-level network policies. Must + be set to true when specified. + endpoints: type: object properties: - all_ip_ranges: - type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - required: - - restriction_mode - description: The network policy restrictions for public access to the workspace. Configures how - public internet traffic is allowed or denied access. - description: The network policies applying for ingress traffic. - ingress_dry_run: + endpoint_ids: + type: array + items: + type: string + description: The IDs of the registered endpoints. Must contain at least one endpoint + ID. + description: Matches requests arriving through any of the specified registered endpoints. + description: The origin the request must match — the private connectivity the request arrives + through, for example a specific set of registered endpoints or any endpoint registered to + the account. See PrivateRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless + of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. + required: + - restriction_mode + description: The network policy restrictions for private access. Configures how requests arriving over + private connectivity are governed. + public_access: type: object properties: - cross_workspace_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + restriction_mode: + type: string + x-enum: + - FULL_ACCESS + - RESTRICTED_ACCESS + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + allow_rules: + type: array + items: + type: object + properties: + authentication: type: object properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_source_workspaces: - type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - deny_rules: - type: array - items: - type: object - properties: - authentication: - type: object - properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: + type: object + properties: + account_api: + type: object + properties: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: + type: object + properties: + all_destinations: + type: boolean + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: type: object properties: - all_source_workspaces: + all_destinations: type: boolean - selected_workspaces: - type: object - properties: - workspace_ids: - type: array - items: - type: integer - description: Specific source workspace IDs to match. - required: - - restriction_mode - private_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - ALLOW_ALL_REGISTERED_ENDPOINTS - - RESTRICTED_ACCESS - description: The restriction mode for private access. - allow_rules: - type: array - items: - type: object - properties: - authentication: + workspace_api: type: object properties: - identities: + excluded_scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: - type: string - description: The label for this ingress rule. - origin: + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: type: object properties: - all_private_access: - type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: - type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: + all_destinations: type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Allow rules are evaluated after deny rules. A request matching any allow rule is - allowed; a request matching no rule is denied by default. Only applies when restriction_mode - is RESTRICTED_ACCESS. - deny_rules: - type: array - items: + label: + type: string + description: The label for this ingress rule. + origin: type: object properties: - authentication: + all_ip_ranges: + type: boolean + excluded_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: type: object properties: - identities: + ip_ranges: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + deny_rules: + type: array + items: + type: object + properties: + authentication: + type: object + properties: + identities: + type: array + items: + type: object + properties: + principal_id: + type: integer + principal_type: + type: string + x-enum: + - PRINCIPAL_TYPE_SERVICE_PRINCIPAL + - PRINCIPAL_TYPE_USER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: - type: string - x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: The authenticated identity the request must match. When unset, the rule matches - all users and service principals. On the account-level network policy, scoping to specific - identities is not currently supported, so this field must be unset (the rule matches - all users and service principals). - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. - all_destinations: - type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - description: The destination the request must match — the resource being accessed, for - example the workspace UI, workspace APIs, or account-level APIs. See RequestDestination. - label: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + identity_type: type: string - description: The label for this ingress rule. - origin: - type: object - properties: - all_private_access: - type: boolean - description: Matches requests arriving over any private connectivity, including registered - endpoints and the workspace's Azure Private Link (ui-api) endpoints. Can only be - used in deny rules of workspace-level network policies. Must be set to true when - specified. - all_registered_endpoints: - type: boolean - description: Matches requests arriving through any endpoint registered to the account. - Must be set to true when specified. - azure_workspace_private_link: - type: boolean - description: Matches requests arriving through the workspace's Azure Private Link - (ui-api) endpoints. Can only be used in deny rules of workspace-level network policies. - Must be set to true when specified. - endpoints: - type: object - properties: - endpoint_ids: - type: array - items: - type: string - description: The IDs of the registered endpoints. Must contain at least one endpoint - ID. - description: Matches requests arriving through any of the specified registered endpoints. - description: The origin the request must match — the private connectivity the request - arrives through, for example a specific set of registered endpoints or any endpoint - registered to the account. See PrivateRequestOrigin. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless - of allow rules. Only applies when restriction_mode is RESTRICTED_ACCESS. - required: - - restriction_mode - description: The network policy restrictions for private access. Configures how requests arriving - over private connectivity are governed. - public_access: - type: object - properties: - restriction_mode: - type: string - x-enum: - - FULL_ACCESS - - RESTRICTED_ACCESS - description: |- - Create a collection of name/value pairs. + x-enum: + - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS + - IDENTITY_TYPE_ALL_USERS + - IDENTITY_TYPE_SELECTED_IDENTITIES + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - allow_rules: - type: array - items: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + destination: type: object properties: - authentication: + account_api: type: object properties: - identities: - type: array - items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: The API scopes to match. Use "all-apis" to match any account-level API. + description: Matches account-level Databricks API endpoints for an ingress network policy + rule. + account_databricks_one: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + description: Account DatabricksOne destination is not supported. + account_ui: type: object properties: - all_ip_ranges: + all_destinations: type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - deny_rules: - type: array - items: - type: object - properties: - authentication: + description: Must be set to true. + description: Matches requests to the account console UI. Can only be used in the account-level + network policy. + all_destinations: + type: boolean + description: When true, match all destinations, no other destination fields can be set. + When not set or false, at least one specific destination must be provided. + apps_runtime: + type: object + properties: + all_destinations: + type: boolean + lakebase_runtime: + type: object + properties: + all_destinations: + type: boolean + workspace_api: type: object properties: - identities: + excluded_scopes: type: array items: - type: object - properties: - principal_id: - type: integer - principal_type: - type: string - x-enum: - - PRINCIPAL_TYPE_SERVICE_PRINCIPAL - - PRINCIPAL_TYPE_USER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - identity_type: + type: string + description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here + ("allow all except"). Mutually exclusive with ``scopes`` — a single destination + may set at most one of the two.' + scope_qualifier: type: string x-enum: - - IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS - - IDENTITY_TYPE_ALL_USERS - - IDENTITY_TYPE_SELECTED_IDENTITIES - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - destination: - type: object - properties: - account_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: The API scopes to match. Use "all-apis" to match any account-level - API. - description: Matches account-level Databricks API endpoints for an ingress network - policy rule. - account_databricks_one: - type: object - properties: - all_destinations: - type: boolean - description: Account DatabricksOne destination is not supported. - account_ui: - type: object - properties: - all_destinations: - type: boolean - description: Must be set to true. - description: Matches requests to the account console UI. Can only be used in the account-level - network policy. + - API_SCOPE_QUALIFIER_ALL + - API_SCOPE_QUALIFIER_READ + description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. + scopes: + type: array + items: + type: string + description: Matches workspace-level Databricks API endpoints for an ingress network policy + rule. + workspace_ui: + type: object + properties: all_destinations: type: boolean - description: When true, match all destinations, no other destination fields can be - set. When not set or false, at least one specific destination must be provided. - apps_runtime: - type: object - properties: - all_destinations: - type: boolean - lakebase_runtime: - type: object - properties: - all_destinations: - type: boolean - workspace_api: - type: object - properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed - here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination - may set at most one of the two.' - scope_constraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use scope_qualifier instead.' - scope_qualifier: - type: string - x-enum: - - API_SCOPE_QUALIFIER_ALL - - API_SCOPE_QUALIFIER_READ - description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. - scopes: - type: array - items: - type: string - description: Matches workspace-level Databricks API endpoints for an ingress network - policy rule. - workspace_ui: - type: object - properties: - all_destinations: - type: boolean - label: - type: string - description: The label for this ingress rule. - origin: + label: + type: string + description: The label for this ingress rule. + origin: + type: object + properties: + all_ip_ranges: + type: boolean + excluded_ip_ranges: type: object properties: - all_ip_ranges: - type: boolean - excluded_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: 'Excluded means: all public IP ranges except this one.' - included_ip_ranges: - type: object - properties: - ip_ranges: - type: array - items: - type: string - description: Will not allow IP ranges with private IPs. - managed_ip_range: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region - must belong to the partner named in ``name``. Empty list means all regions of - the partner. Region casing matches the partner's source (e.g., Microsoft uses - "EastUS"), so values are stored verbatim, not lowercased. - description: A single Databricks-maintained IP range for a well-known partner (e.g., - Power BI, dbt), optionally scoped to specific partner regions. Customers create - one rule per partner. - description: |- - An ingress rule is enforced when a request satisfies all specified attributes — including - request origin, destination, and authentication. - required: - - restriction_mode - description: The network policy restrictions for public access to the workspace. Configures how - public internet traffic is allowed or denied access. - description: The ingress policy for dry run mode. Dry run will always run even if the request is allowed - by the ingress policy. When this field is set, the policy will be evaluated and emit logs only without - blocking requests. - network_policy_id: - type: string - description: The unique identifier for the network policy. - description: Updated network policy configuration details. - required: - - network_policy + ip_ranges: + type: array + items: + type: string + description: 'Excluded means: all public IP ranges except this one.' + included_ip_ranges: + type: object + properties: + ip_ranges: + type: array + items: + type: string + description: Will not allow IP ranges with private IPs. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. + required: + - restriction_mode + description: The network policy restrictions for public access to the workspace. Configures how public + internet traffic is allowed or denied access. + description: The ingress policy for dry run mode. Dry run will always run even if the request is allowed + by the ingress policy. When this field is set, the policy will be evaluated and emit logs only without + blocking requests. + network_policy_id: + type: string + description: The unique identifier for the network policy. responses: '200': description: Success @@ -7717,17 +7038,11 @@ paths: schema: type: object properties: - workspace_network_option: - type: object - properties: - network_policy_id: - type: string - workspace_id: - type: integer - description: The workspace ID. - description: The network option details for the workspace. - required: - - workspace_network_option + network_policy_id: + type: string + workspace_id: + type: integer + description: The workspace ID. responses: '200': description: Success @@ -7950,6 +7265,10 @@ components: Config: type: object properties: + databricks_app_slack: + $ref: '#/components/schemas/DatabricksAppSlackConfig' + databricks_app_teams: + $ref: '#/components/schemas/DatabricksAppTeamsConfig' email: $ref: '#/components/schemas/EmailConfig' generic_webhook: @@ -8071,6 +7390,8 @@ components: properties: cross_workspace_access: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess' + description: 'The network policy restrictions for cross-workspace access: which other workspaces may access this + workspace.' private_access: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyPrivateAccess' description: The network policy restrictions for private access. Configures how requests arriving over private connectivity @@ -8083,15 +7404,6 @@ components: CustomerFacingIngressNetworkPolicyAccountApiDestination: type: object properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here ("allow all except"). Mutually - exclusive with ``scopes`` — a single destination may set at most one of the two.' - scope_constraint: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeConstraint' - description: 'Deprecated: Use scope_qualifier instead.' scope_qualifier: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeQualifier' description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. @@ -8143,10 +7455,14 @@ components: type: array items: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule' + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; a request + matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. deny_rules: type: array items: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule' + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless of allow rules. + Only applies when restriction_mode is RESTRICTED_ACCESS. required: - restriction_mode CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule: @@ -8154,13 +7470,22 @@ components: properties: authentication: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyAuthentication' + description: The authenticated identity the request must match. When unset, the rule matches all users and service + principals. destination: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyRequestDestination' + description: The destination the request must match — the resource being accessed, for example the workspace UI + or workspace APIs. See RequestDestination. label: type: string description: The label for this ingress rule. origin: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin' + description: The origin the request must match — the source workspace the request comes from, either specific source + workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin: type: object properties: @@ -8190,23 +7515,6 @@ components: properties: all_destinations: type: boolean - CustomerFacingIngressNetworkPolicyManagedIpRange: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region must belong to the partner named - in ``name``. Empty list means all regions of the partner. Region casing matches the partner's source (e.g., Microsoft - uses "EastUS"), so values are stored verbatim, not lowercased. - description: |- - A Databricks-managed IP range identified by name (e.g., "powerbi", "dbt"), optionally scoped to - specific partner regions. Customers reference a name instead of raw CIDRs; Databricks keeps the - underlying IP list current. CustomerFacingIngressNetworkPolicyPrivateAccess: type: object properties: @@ -8315,10 +7623,6 @@ components: included_ip_ranges: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyIpRanges' description: Will not allow IP ranges with private IPs. - managed_ip_range: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyManagedIpRange' - description: A single Databricks-maintained IP range for a well-known partner (e.g., Power BI, dbt), optionally - scoped to specific partner regions. Customers create one rule per partner. CustomerFacingIngressNetworkPolicyRequestDestination: type: object properties: @@ -8351,9 +7655,6 @@ components: type: string description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination may set at most one of the two.' - scope_constraint: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeConstraint' - description: 'Deprecated: Use scope_qualifier instead.' scope_qualifier: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeQualifier' description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. @@ -8452,6 +7753,48 @@ components: name is required to be 'default' if the setting only has one instance per workspace. required: - boolean_val + DatabricksAppSlackConfig: + type: object + properties: + channel_id: + type: string + description: '[Input-Only] Slack channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Slack workspace (team) ID the Databricks app is installed in.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + description: |- + Slack channel reached through the Databricks app. The app must already be installed in the Slack + workspace and connected to this Databricks workspace. + DatabricksAppTeamsConfig: + type: object + properties: + channel_id: + type: string + description: '[Input-Only] Teams channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Microsoft Entra group ID of the team that owns the channel.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + tenant_id: + type: string + description: '[Input-Only] Microsoft Entra tenant ID of the Microsoft 365 tenant the app is installed in.' + tenant_id_set: + type: boolean + description: '[Output-Only] Whether tenant ID is set.' + description: |- + Microsoft Teams channel reached through the Databricks app. The app must already be installed in + the Microsoft 365 tenant and connected to this Databricks workspace. DefaultNamespaceSetting: type: object properties: @@ -9020,40 +8363,8 @@ components: GenericWebhookConfig: type: object properties: - oauth_audience: - type: string - oauth_audience_set: - type: boolean - description: '[Output-Only] Whether OAuth2 audience is set.' - oauth_client_id: - type: string - description: '[Input-Only][Optional] OAuth2 client ID for the client_credentials grant.' - oauth_client_id_set: - type: boolean - description: '[Output-Only] Whether OAuth2 client ID is set.' - oauth_client_secret: - type: string - description: '[Input-Only][Optional] OAuth2 client secret for the client_credentials grant.' - oauth_client_secret_set: - type: boolean - description: '[Output-Only] Whether OAuth2 client secret is set.' - oauth_scopes: - type: array - items: - type: string - description: '[Input-Only][Optional] OAuth2 scopes requested at token mint (required by some IdPs).' - oauth_scopes_set: - type: boolean - description: '[Output-Only] Whether OAuth2 scopes are set.' - oauth_token_url: - type: string - description: '[Input-Only][Optional] OAuth2 token endpoint URL (customer IdP) where access tokens are minted.' - oauth_token_url_set: - type: boolean - description: '[Output-Only] Whether OAuth2 token URL is set.' password: type: string - description: '[Input-Only][Optional] Password for webhook.' password_set: type: boolean description: '[Output-Only] Whether password is set.' @@ -9407,8 +8718,6 @@ components: $ref: '#/components/schemas/NccAwsStableIpRule' azure_service_endpoint_rule: $ref: '#/components/schemas/NccAzureServiceEndpointRule' - gcp_project_id_rule: - $ref: '#/components/schemas/NetworkConnectivityConfigEgressConfigDefaultRuleGcpProjectIdRule' description: Default rules don't have specific targets. NccEgressTargetRules: type: object @@ -9502,13 +8811,6 @@ components: description: |- Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization. - NetworkConnectivityConfigEgressConfigDefaultRuleGcpProjectIdRule: - type: object - properties: - project_ids: - type: array - items: - type: string NetworkConnectivityConfiguration: type: object properties: @@ -9622,9 +8924,6 @@ components: items: type: string description: Output only. Inferred API path scopes collected for this token when autoscope is enabled. - last_accessed_time: - type: integer - description: Server time (in epoch milliseconds) when the token was accessed most recently. scopes: type: array items: @@ -9997,7 +9296,6 @@ components: ComplianceStandard: type: string x-enum: - - ARC_AMPE - CANADA_PROTECTED_B - CYBER_ESSENTIAL_PLUS - FEDRAMP_HIGH @@ -10017,12 +9315,6 @@ components: description: |- Compliance standard for SHIELD customers. See README.md for how instructions of how to add new standards. - CustomerFacingIngressNetworkPolicyApiScopeConstraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use ApiScopeQualifier instead.' CustomerFacingIngressNetworkPolicyApiScopeQualifier: type: string x-enum: @@ -10121,44 +9413,14 @@ components: type: string x-enum: - FULL_ACCESS + - LEGACY_MODE - RESTRICTED_ACCESS description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode: type: string x-enum: @@ -10261,6 +9523,8 @@ components: DestinationType: type: string x-enum: + - DATABRICKS_APP_SLACK + - DATABRICKS_APP_TEAMS - EMAIL - MICROSOFT_TEAMS - PAGERDUTY @@ -11083,7 +10347,6 @@ components: a.value AS ip_address FROM databricks_account.settings.account_ip_access_lists l, JSON_EACH(l.ip_addresses) a - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11101,7 +10364,6 @@ components: a.value AS ip_address FROM databricks_account.settings.account_ip_access_lists l, jsonb_array_elements(l.ip_addresses::jsonb) AS a - WHERE account_id = '{{ account_id }}' vw_network_connectivity_configs: name: vw_network_connectivity_configs id: databricks_account.settings.vw_network_connectivity_configs @@ -11158,7 +10420,6 @@ components: JSON_EXTRACT(ncc.egress_config, '$.default_rules.azure_service_endpoint_rule.subnets') AS azure_svc_endpoint_subnets, JSON_EXTRACT(ncc.egress_config, '$.default_rules.azure_service_endpoint_rule.target_services') AS azure_svc_endpoint_services FROM databricks_account.settings.network_connectivity ncc - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11174,7 +10435,6 @@ components: ncc.egress_config->'default_rules'->'azure_service_endpoint_rule'->'subnets' AS azure_svc_endpoint_subnets, ncc.egress_config->'default_rules'->'azure_service_endpoint_rule'->'target_services' AS azure_svc_endpoint_services FROM databricks_account.settings.network_connectivity ncc - WHERE account_id = '{{ account_id }}' vw_ncc_aws_private_endpoint_rules: name: vw_ncc_aws_private_endpoint_rules id: databricks_account.settings.vw_ncc_aws_private_endpoint_rules @@ -11256,7 +10516,6 @@ components: JSON_EXTRACT(r.value, '$.updated_time') AS updated_time FROM databricks_account.settings.network_connectivity ncc, JSON_EACH(JSON_EXTRACT(ncc.egress_config, '$.target_rules.aws_private_endpoint_rules')) r - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11279,7 +10538,6 @@ components: (r.value->>'updated_time')::bigint AS updated_time FROM databricks_account.settings.network_connectivity ncc, jsonb_array_elements((ncc.egress_config->'target_rules'->'aws_private_endpoint_rules')::jsonb) AS r - WHERE account_id = '{{ account_id }}' vw_ncc_azure_private_endpoint_rules: name: vw_ncc_azure_private_endpoint_rules id: databricks_account.settings.vw_ncc_azure_private_endpoint_rules @@ -11357,7 +10615,6 @@ components: JSON_EXTRACT(r.value, '$.updated_time') AS updated_time FROM databricks_account.settings.network_connectivity ncc, JSON_EACH(JSON_EXTRACT(ncc.egress_config, '$.target_rules.azure_private_endpoint_rules')) r - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11379,7 +10636,6 @@ components: (r.value->>'updated_time')::bigint AS updated_time FROM databricks_account.settings.network_connectivity ncc, jsonb_array_elements((ncc.egress_config->'target_rules'->'azure_private_endpoint_rules')::jsonb) AS r - WHERE account_id = '{{ account_id }}' vw_network_policy_internet_destinations: name: vw_network_policy_internet_destinations id: databricks_account.settings.vw_network_policy_internet_destinations @@ -11421,7 +10677,6 @@ components: JSON_EXTRACT(d.value, '$.internet_destination_type') AS destination_type FROM databricks_account.settings.network_policies np, JSON_EACH(JSON_EXTRACT(np.egress, '$.network_access.allowed_internet_destinations')) d - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11434,7 +10689,6 @@ components: d.value->>'internet_destination_type' AS destination_type FROM databricks_account.settings.network_policies np, jsonb_array_elements((np.egress->'network_access'->'allowed_internet_destinations')::jsonb) AS d - WHERE account_id = '{{ account_id }}' vw_network_policy_storage_destinations: name: vw_network_policy_storage_destinations id: databricks_account.settings.vw_network_policy_storage_destinations @@ -11488,7 +10742,6 @@ components: JSON_EXTRACT(d.value, '$.azure_storage_service') AS azure_storage_service FROM databricks_account.settings.network_policies np, JSON_EACH(JSON_EXTRACT(np.egress, '$.network_access.allowed_storage_destinations')) d - WHERE account_id = '{{ account_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -11504,7 +10757,6 @@ components: d.value->>'azure_storage_service' AS azure_storage_service FROM databricks_account.settings.network_policies np, jsonb_array_elements((np.egress->'network_access'->'allowed_storage_destinations')::jsonb) AS d - WHERE account_id = '{{ account_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml b/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml index e0eaaeec..666b168c 100644 --- a/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml @@ -6,10 +6,25 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.settingsv2 servers: - - url: https://accounts.cloud.databricks.com + - url: https://{account_host} + variables: + account_host: + description: >- + The Databricks account console host. Selected by DATABRICKS_CLOUD + (aws, azure or gcp; default aws), or set explicitly with + DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com paths: /api/2.1/accounts/{account_id}/settings/{name}: get: @@ -107,989 +122,977 @@ paths: schema: type: object properties: - setting: + aibi_dashboard_embedding_access_policy: type: object properties: - aibi_dashboard_embedding_access_policy: - type: object - properties: - access_policy_type: - type: string - x-enum: - - ALLOW_ALL_DOMAINS - - ALLOW_APPROVED_DOMAINS - - DENY_ALL_DOMAINS - description: >- - Create a collection of name/value pairs. + access_policy_type: + type: string + x-enum: + - ALLOW_ALL_DOMAINS + - ALLOW_APPROVED_DOMAINS + - DENY_ALL_DOMAINS + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - access_policy_type - aibi_dashboard_embedding_approved_domains: - type: object - properties: - approved_domains: - type: array - items: - type: string - description: >- - Setting value for - aibi_dashboard_embedding_approved_domains setting. This - is the setting value set by consumers, check - effective_aibi_dashboard_embedding_approved_domains for - final setting value. - allowed_apps_user_api_scopes: + attributes -- see the documentation for details. + required: + - access_policy_type + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + description: >- + Setting value for aibi_dashboard_embedding_approved_domains + setting. This is the setting value set by consumers, check + effective_aibi_dashboard_embedding_approved_domains for + final setting value. + allowed_apps_user_api_scopes: + type: object + properties: + allowed_scopes: + type: array + items: + type: string + description: >- + Setting value for allowed_apps_user_api_scopes setting. This + is the setting value set by consumers, check + effective_allowed_apps_user_api_scopes for final setting + value. + automatic_cluster_update_workspace: + type: object + properties: + can_toggle: + type: boolean + enabled: + type: boolean + enablement_details: type: object properties: - allowed_scopes: - type: array - items: - type: string + forced_for_compliance_mode: + type: boolean + description: >- + The feature is force enabled if compliance mode is + active + unavailable_for_disabled_entitlement: + type: boolean + description: >- + The feature is unavailable if the corresponding + entitlement disabled (see + getShieldEntitlementEnable) + unavailable_for_non_enterprise_tier: + type: boolean + description: >- + The feature is unavailable if the customer doesn't + have enterprise tier description: >- - Setting value for allowed_apps_user_api_scopes setting. - This is the setting value set by consumers, check - effective_allowed_apps_user_api_scopes for final setting - value. - automatic_cluster_update_workspace: + Contains an information about the enablement status + judging (e.g. whether the enterprise tier is + enabled) This is only additional information that MUST NOT be used to decide whether the setting + is enabled or not. This is intended to use only for purposes like showing an error message to + the customer with the additional details. For example, using these details we can check why + exactly the feature is disabled for this customer. + maintenance_window: type: object properties: - can_toggle: - type: boolean - enabled: - type: boolean - enablement_details: + week_day_based_schedule: type: object properties: - forced_for_compliance_mode: - type: boolean - description: >- - The feature is force enabled if compliance mode - is active - unavailable_for_disabled_entitlement: - type: boolean + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY description: >- - The feature is unavailable if the corresponding - entitlement disabled (see - getShieldEntitlementEnable) - unavailable_for_non_enterprise_tier: - type: boolean - description: >- - The feature is unavailable if the customer - doesn't have enterprise tier - description: >- - Contains an information about the enablement status - judging (e.g. whether the enterprise tier is - enabled) This is only additional information that MUST NOT be used to decide whether the setting - is enabled or not. This is intended to use only for purposes like showing an error message to - the customer with the additional details. For example, using these details we can check why - exactly the feature is disabled for this customer. - maintenance_window: - type: object - properties: - week_day_based_schedule: - type: object - properties: - day_of_week: - type: string - x-enum: - - FRIDAY - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - frequency: - type: string - x-enum: - - EVERY_WEEK - - FIRST_AND_THIRD_OF_MONTH - - FIRST_OF_MONTH - - FOURTH_OF_MONTH - - SECOND_AND_FOURTH_OF_MONTH - - SECOND_OF_MONTH - - THIRD_OF_MONTH - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + frequency: + type: string + x-enum: + - EVERY_WEEK + - FIRST_AND_THIRD_OF_MONTH + - FIRST_OF_MONTH + - FOURTH_OF_MONTH + - SECOND_AND_FOURTH_OF_MONTH + - SECOND_OF_MONTH + - THIRD_OF_MONTH + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - window_start_time: - type: object - properties: - hours: - type: integer - minutes: - type: integer - restart_even_if_no_updates_available: - type: boolean - description: >- - Setting value for automatic_cluster_update_workspace - setting. This is the setting value set by consumers, - check effective_automatic_cluster_update_workspace for - final setting value. - boolean_val: - type: object - properties: - value: - type: boolean + attributes -- see the documentation for details. + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + restart_even_if_no_updates_available: + type: boolean + description: >- + Setting value for automatic_cluster_update_workspace + setting. This is the setting value set by consumers, check + effective_automatic_cluster_update_workspace for final + setting value. + boolean_val: + type: object + properties: + value: + type: boolean + description: >- + Setting value for boolean type setting. This is the setting + value set by consumers, check effective_boolean_val for + final setting value. + collaboration_platform_connectivity: + type: object + properties: + connectivity: + type: string + x-enum: + - ALLOW_ALL + - ALLOW_SLACK + - ALLOW_TEAMS + - DENY_ALL description: >- - Setting value for boolean type setting. This is the - setting value set by consumers, check - effective_boolean_val for final setting value. - collaboration_platform_connectivity: - type: object - properties: - connectivity: - type: string - x-enum: - - ALLOW_ALL - - ALLOW_SLACK - - ALLOW_TEAMS - - DENY_ALL - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - connectivity + attributes -- see the documentation for details. + required: + - connectivity + description: >- + Setting value for collaboration_platform_connectivity + setting. This is the setting value set by consumers, check + effective_collaboration_platform_connectivity for final + setting value. + effective_aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + x-enum: + - ALLOW_ALL_DOMAINS + - ALLOW_APPROVED_DOMAINS + - DENY_ALL_DOMAINS description: >- - Setting value for collaboration_platform_connectivity - setting. This is the setting value set by consumers, - check effective_collaboration_platform_connectivity for - final setting value. - effective_aibi_dashboard_embedding_access_policy: - type: object - properties: - access_policy_type: - type: string - x-enum: - - ALLOW_ALL_DOMAINS - - ALLOW_APPROVED_DOMAINS - - DENY_ALL_DOMAINS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - access_policy_type - description: >- - Effective setting value for - aibi_dashboard_embedding_access_policy setting. This is - the final effective value of setting. To set a value use - aibi_dashboard_embedding_access_policy. - effective_aibi_dashboard_embedding_approved_domains: - type: object - properties: - approved_domains: - type: array - items: - type: string - description: >- - Effective setting value for - aibi_dashboard_embedding_approved_domains setting. This - is the final effective value of setting. To set a value - use aibi_dashboard_embedding_approved_domains. - effective_allowed_apps_user_api_scopes: + attributes -- see the documentation for details. + required: + - access_policy_type + description: >- + Effective setting value for + aibi_dashboard_embedding_access_policy setting. This is the + final effective value of setting. To set a value use + aibi_dashboard_embedding_access_policy. + effective_aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + description: >- + Effective setting value for + aibi_dashboard_embedding_approved_domains setting. This is + the final effective value of setting. To set a value use + aibi_dashboard_embedding_approved_domains. + effective_allowed_apps_user_api_scopes: + type: object + properties: + allowed_scopes: + type: array + items: + type: string + description: >- + Effective setting value for allowed_apps_user_api_scopes + setting. This is the final effective value of setting. To + set a value use allowed_apps_user_api_scopes. + effective_automatic_cluster_update_workspace: + type: object + properties: + can_toggle: + type: boolean + enabled: + type: boolean + enablement_details: type: object properties: - allowed_scopes: - type: array - items: - type: string + forced_for_compliance_mode: + type: boolean + description: >- + The feature is force enabled if compliance mode is + active + unavailable_for_disabled_entitlement: + type: boolean + description: >- + The feature is unavailable if the corresponding + entitlement disabled (see + getShieldEntitlementEnable) + unavailable_for_non_enterprise_tier: + type: boolean + description: >- + The feature is unavailable if the customer doesn't + have enterprise tier description: >- - Effective setting value for allowed_apps_user_api_scopes - setting. This is the final effective value of setting. - To set a value use allowed_apps_user_api_scopes. - effective_automatic_cluster_update_workspace: + Contains an information about the enablement status + judging (e.g. whether the enterprise tier is + enabled) This is only additional information that MUST NOT be used to decide whether the setting + is enabled or not. This is intended to use only for purposes like showing an error message to + the customer with the additional details. For example, using these details we can check why + exactly the feature is disabled for this customer. + maintenance_window: type: object properties: - can_toggle: - type: boolean - enabled: - type: boolean - enablement_details: + week_day_based_schedule: type: object properties: - forced_for_compliance_mode: - type: boolean + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY description: >- - The feature is force enabled if compliance mode - is active - unavailable_for_disabled_entitlement: - type: boolean - description: >- - The feature is unavailable if the corresponding - entitlement disabled (see - getShieldEntitlementEnable) - unavailable_for_non_enterprise_tier: - type: boolean - description: >- - The feature is unavailable if the customer - doesn't have enterprise tier - description: >- - Contains an information about the enablement status - judging (e.g. whether the enterprise tier is - enabled) This is only additional information that MUST NOT be used to decide whether the setting - is enabled or not. This is intended to use only for purposes like showing an error message to - the customer with the additional details. For example, using these details we can check why - exactly the feature is disabled for this customer. - maintenance_window: - type: object - properties: - week_day_based_schedule: - type: object - properties: - day_of_week: - type: string - x-enum: - - FRIDAY - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - frequency: - type: string - x-enum: - - EVERY_WEEK - - FIRST_AND_THIRD_OF_MONTH - - FIRST_OF_MONTH - - FOURTH_OF_MONTH - - SECOND_AND_FOURTH_OF_MONTH - - SECOND_OF_MONTH - - THIRD_OF_MONTH - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + frequency: + type: string + x-enum: + - EVERY_WEEK + - FIRST_AND_THIRD_OF_MONTH + - FIRST_OF_MONTH + - FOURTH_OF_MONTH + - SECOND_AND_FOURTH_OF_MONTH + - SECOND_OF_MONTH + - THIRD_OF_MONTH + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - window_start_time: - type: object - properties: - hours: - type: integer - minutes: - type: integer - restart_even_if_no_updates_available: - type: boolean - description: >- - Effective setting value for - automatic_cluster_update_workspace setting. This is the - final effective value of setting. To set a value use - automatic_cluster_update_workspace. - effective_boolean_val: - type: object - properties: - value: - type: boolean + attributes -- see the documentation for details. + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + restart_even_if_no_updates_available: + type: boolean + description: >- + Effective setting value for + automatic_cluster_update_workspace setting. This is the + final effective value of setting. To set a value use + automatic_cluster_update_workspace. + effective_boolean_val: + type: object + properties: + value: + type: boolean + description: >- + Effective setting value for boolean type setting. This is + the final effective value of setting. To set a value use + boolean_val. + effective_collaboration_platform_connectivity: + type: object + properties: + connectivity: + type: string + x-enum: + - ALLOW_ALL + - ALLOW_SLACK + - ALLOW_TEAMS + - DENY_ALL description: >- - Effective setting value for boolean type setting. This - is the final effective value of setting. To set a value - use boolean_val. - effective_collaboration_platform_connectivity: - type: object - properties: - connectivity: - type: string - x-enum: - - ALLOW_ALL - - ALLOW_SLACK - - ALLOW_TEAMS - - DENY_ALL - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - connectivity - description: >- - Effective setting value for - collaboration_platform_connectivity setting. This is the - final effective value of setting. To set a value use - collaboration_platform_connectivity. - effective_genie_chat_share_policy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Effective setting value for genie_chat_share_policy - setting. This is the final effective value of setting. - To set a value use genie_chat_share_policy. - effective_integer_val: - type: object - properties: - value: - type: integer - description: >- - Effective setting value for integer type setting. This - is the final effective value of setting. To set a value - use integer_val. - effective_operational_email_custom_recipient: - type: object - properties: - email: - type: string + attributes -- see the documentation for details. + required: + - connectivity + description: >- + Effective setting value for + collaboration_platform_connectivity setting. This is the + final effective value of setting. To set a value use + collaboration_platform_connectivity. + effective_integer_val: + type: object + properties: + value: + type: integer + description: >- + Effective setting value for integer type setting. This is + the final effective value of setting. To set a value use + integer_val. + effective_operational_email_custom_recipient: + type: object + properties: + email: + type: string + description: >- + Effective setting value for + operational_email_custom_recipient setting. This is the + final effective value of setting. To set a value use + operational_email_custom_recipient. + effective_personal_compute: + type: object + properties: + value: + type: string + x-enum: + - DELEGATE + - 'ON' description: >- - Effective setting value for - operational_email_custom_recipient setting. This is the - final effective value of setting. To set a value use - operational_email_custom_recipient. - effective_personal_compute: - type: object - properties: - value: - type: string - x-enum: - - DELEGATE - - 'ON' - description: >- - ON: Grants all users in all workspaces access to the - Personal Compute default policy, allowing + ON: Grants all users in all workspaces access to the + Personal Compute default policy, allowing - all users to create single-machine compute - resources. DELEGATE: Moves access control for the + all users to create single-machine compute resources. + DELEGATE: Moves access control for the - Personal Compute default policy to individual - workspaces and requires a workspace’s users or + Personal Compute default policy to individual workspaces + and requires a workspace’s users or - groups to be added to the ACLs of that workspace’s - Personal Compute default policy before they + groups to be added to the ACLs of that workspace’s + Personal Compute default policy before they - will be able to create compute resources through - that policy. + will be able to create compute resources through that + policy. + description: >- + Effective setting value for personal_compute setting. This + is the final effective value of setting. To set a value use + personal_compute. + effective_restrict_workspace_admins: + type: object + properties: + status: + type: string + x-enum: + - ALLOW_ALL + - RESTRICT_TOKENS_AND_JOB_RUN_AS description: >- - Effective setting value for personal_compute setting. - This is the final effective value of setting. To set a - value use personal_compute. - effective_restrict_workspace_admins: - type: object - properties: - status: - type: string - x-enum: - - ALLOW_ALL - - RESTRICT_TOKENS_AND_JOB_RUN_AS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - disable_gov_tag_creation: - type: boolean - description: >- - When true, workspace admins cannot create governance - tags. ALLOW_ALL status does not override this; they - are independent. - required: - - status - description: >- - Effective setting value for restrict_workspace_admins - setting. This is the final effective value of setting. - To set a value use restrict_workspace_admins. - effective_string_val: - type: object - properties: - value: - type: string - description: >- - Effective setting value for string type setting. This is - the final effective value of setting. To set a value use - string_val. - genie_chat_share_policy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Setting value for genie_chat_share_policy setting. This - is the setting value set by consumers, check - effective_genie_chat_share_policy for final setting - value. - integer_val: - type: object - properties: - value: - type: integer + attributes -- see the documentation for details. + disable_gov_tag_creation: + type: boolean description: >- - Setting value for integer type setting. This is the - setting value set by consumers, check - effective_integer_val for final setting value. - name: + When true, workspace admins cannot create governance + tags. ALLOW_ALL status does not override this; they are + independent. + required: + - status + description: >- + Effective setting value for restrict_workspace_admins + setting. This is the final effective value of setting. To + set a value use restrict_workspace_admins. + effective_string_val: + type: object + properties: + value: type: string - description: Name of the setting. - operational_email_custom_recipient: - type: object - properties: - email: - type: string + description: >- + Effective setting value for string type setting. This is the + final effective value of setting. To set a value use + string_val. + effective_workspace_label: + type: object + properties: + color: + type: string + label: + type: string + description: >- + Effective setting value for workspace_label setting. This is + the final effective value of setting. To set a value use + workspace_label. + integer_val: + type: object + properties: + value: + type: integer + description: >- + Setting value for integer type setting. This is the setting + value set by consumers, check effective_integer_val for + final setting value. + name: + type: string + description: Name of the setting. + operational_email_custom_recipient: + type: object + properties: + email: + type: string + description: >- + Setting value for operational_email_custom_recipient + setting. This is the setting value set by consumers, check + effective_operational_email_custom_recipient for final + setting value. + personal_compute: + type: object + properties: + value: + type: string + x-enum: + - DELEGATE + - 'ON' description: >- - Setting value for operational_email_custom_recipient - setting. This is the setting value set by consumers, - check effective_operational_email_custom_recipient for - final setting value. - personal_compute: - type: object - properties: - value: - type: string - x-enum: - - DELEGATE - - 'ON' - description: >- - ON: Grants all users in all workspaces access to the - Personal Compute default policy, allowing + ON: Grants all users in all workspaces access to the + Personal Compute default policy, allowing - all users to create single-machine compute - resources. DELEGATE: Moves access control for the + all users to create single-machine compute resources. + DELEGATE: Moves access control for the - Personal Compute default policy to individual - workspaces and requires a workspace’s users or + Personal Compute default policy to individual workspaces + and requires a workspace’s users or - groups to be added to the ACLs of that workspace’s - Personal Compute default policy before they + groups to be added to the ACLs of that workspace’s + Personal Compute default policy before they - will be able to create compute resources through - that policy. + will be able to create compute resources through that + policy. + description: >- + Setting value for personal_compute setting. This is the + setting value set by consumers, check + effective_personal_compute for final setting value. + restrict_workspace_admins: + type: object + properties: + status: + type: string + x-enum: + - ALLOW_ALL + - RESTRICT_TOKENS_AND_JOB_RUN_AS description: >- - Setting value for personal_compute setting. This is the - setting value set by consumers, check - effective_personal_compute for final setting value. - restrict_workspace_admins: - type: object - properties: - status: - type: string - x-enum: - - ALLOW_ALL - - RESTRICT_TOKENS_AND_JOB_RUN_AS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - disable_gov_tag_creation: - type: boolean - description: >- - When true, workspace admins cannot create governance - tags. ALLOW_ALL status does not override this; they - are independent. - required: - - status - description: >- - Setting value for restrict_workspace_admins setting. - This is the setting value set by consumers, check - effective_restrict_workspace_admins for final setting - value. - string_val: - type: object - properties: - value: - type: string + attributes -- see the documentation for details. + disable_gov_tag_creation: + type: boolean description: >- - Setting value for string type setting. This is the - setting value set by consumers, check - effective_string_val for final setting value. - required: - - setting + When true, workspace admins cannot create governance + tags. ALLOW_ALL status does not override this; they are + independent. + required: + - status + description: >- + Setting value for restrict_workspace_admins setting. This is + the setting value set by consumers, check + effective_restrict_workspace_admins for final setting value. + string_val: + type: object + properties: + value: + type: string + description: >- + Setting value for string type setting. This is the setting + value set by consumers, check effective_string_val for final + setting value. + workspace_label: + type: object + properties: + color: + type: string + label: + type: string + description: >- + Setting value for workspace_label setting. This is the + setting value set by consumers, check + effective_workspace_label for final setting value. responses: '200': description: Success @@ -1227,42 +1230,32 @@ paths: schema: type: object properties: - setting: + boolean_val: type: object properties: - boolean_val: - type: object - properties: - value: - type: boolean - effective_boolean_val: - type: object - properties: - value: - type: boolean - effective_string_val: - type: object - properties: - value: - type: string - name: + value: + type: boolean + effective_boolean_val: + type: object + properties: + value: + type: boolean + effective_string_val: + type: object + properties: + value: type: string - description: Name of the setting. - string_val: - type: object - properties: - value: - type: string - user_id: + name: + type: string + description: Name of the setting. + string_val: + type: object + properties: + value: type: string - description: User ID of the user. - description: >- - User Preference represents a user-specific setting scoped to - an individual user within an - account. Unlike workspace or account settings that apply to all users, user preferences allow - personal customization (e.g., UI theme, editor preferences) without affecting other users. - required: - - setting + user_id: + type: string + description: User ID of the user. responses: '200': description: Success @@ -1547,19 +1540,6 @@ components: Controls which external collaboration platforms (Slack, Microsoft Teams) can connect to a workspace. Defaults to ALLOW_ALL. - GenieChatSharePolicy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Workspace controls that restrict which Genie space chat sharing modes - are available to end - users. When disable_make_chat_private is true, users cannot make a Genie chat private. When - disable_share_with_account_users is true, users cannot share a Genie chat with all account - users. Defaults preserve current behavior (both false). IntegerMessage: type: object properties: @@ -1692,12 +1672,6 @@ components: Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity. - effective_genie_chat_share_policy: - $ref: '#/components/schemas/GenieChatSharePolicy' - description: >- - Effective setting value for genie_chat_share_policy setting. This is - the final effective value of setting. To set a value use - genie_chat_share_policy. effective_integer_val: $ref: '#/components/schemas/IntegerMessage' description: >- @@ -1726,12 +1700,12 @@ components: description: >- Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val. - genie_chat_share_policy: - $ref: '#/components/schemas/GenieChatSharePolicy' + effective_workspace_label: + $ref: '#/components/schemas/WorkspaceLabelMessage' description: >- - Setting value for genie_chat_share_policy setting. This is the - setting value set by consumers, check - effective_genie_chat_share_policy for final setting value. + Effective setting value for workspace_label setting. This is the + final effective value of setting. To set a value use + workspace_label. integer_val: $ref: '#/components/schemas/IntegerMessage' description: >- @@ -1765,6 +1739,12 @@ components: description: >- Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value. + workspace_label: + $ref: '#/components/schemas/WorkspaceLabelMessage' + description: >- + Setting value for workspace_label setting. This is the setting value + set by consumers, check effective_workspace_label for final setting + value. SettingsMetadata: type: object properties: @@ -1818,6 +1798,14 @@ components: individual user within an account. Unlike workspace or account settings that apply to all users, user preferences allow personal customization (e.g., UI theme, editor preferences) without affecting other users. + WorkspaceLabelMessage: + type: object + properties: + color: + type: string + label: + type: string + description: Workspace label and color for display (e.g. in account console). AibiDashboardEmbeddingAccessPolicyAccessPolicyType: type: string x-enum: diff --git a/providers/src/databricks_workspace/v00.00.00000/provider.yaml b/providers/src/databricks_workspace/v00.00.00000/provider.yaml index 277d8e50..5b28ca9b 100644 --- a/providers/src/databricks_workspace/v00.00.00000/provider.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/provider.yaml @@ -13,6 +13,28 @@ providerServices: description: >- OpenAPI specification for the Databricks agentbricks service (workspace-level APIs), generated from the Databricks Python SDK. + agentkit: + id: agentkit:v00.00.00000 + name: agentkit + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/agentkit.yaml + title: Databricks Agentkit API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks agentkit service (workspace-level + APIs), generated from the Databricks Python SDK. + aifunctions: + id: aifunctions:v00.00.00000 + name: aifunctions + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/aifunctions.yaml + title: Databricks Aifunctions API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks aifunctions service + (workspace-level APIs), generated from the Databricks Python SDK. aisearch: id: aisearch:v00.00.00000 name: aisearch @@ -101,6 +123,17 @@ providerServices: description: >- OpenAPI specification for the Databricks database service (workspace-level APIs), generated from the Databricks Python SDK. + dataclassification: + id: dataclassification:v00.00.00000 + name: dataclassification + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/dataclassification.yaml + title: Databricks Dataclassification API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks dataclassification service + (workspace-level APIs), generated from the Databricks Python SDK. dataquality: id: dataquality:v00.00.00000 name: dataquality @@ -112,6 +145,28 @@ providerServices: description: >- OpenAPI specification for the Databricks dataquality service (workspace-level APIs), generated from the Databricks Python SDK. + domains: + id: domains:v00.00.00000 + name: domains + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/domains.yaml + title: Databricks Domains API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks domains service (workspace-level + APIs), generated from the Databricks Python SDK. + environments: + id: environments:v00.00.00000 + name: environments + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/environments.yaml + title: Databricks Environments API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks environments service + (workspace-level APIs), generated from the Databricks Python SDK. files: id: files:v00.00.00000 name: files @@ -156,6 +211,17 @@ providerServices: description: >- OpenAPI specification for the Databricks jobs service (workspace-level APIs), generated from the Databricks Python SDK. + knowledgeassistants: + id: knowledgeassistants:v00.00.00000 + name: knowledgeassistants + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/knowledgeassistants.yaml + title: Databricks Knowledgeassistants API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks knowledgeassistants service + (workspace-level APIs), generated from the Databricks Python SDK. marketplace: id: marketplace:v00.00.00000 name: marketplace @@ -222,6 +288,17 @@ providerServices: description: >- OpenAPI specification for the Databricks qualitymonitorv2 service (workspace-level APIs), generated from the Databricks Python SDK. + sandbox: + id: sandbox:v00.00.00000 + name: sandbox + preferred: true + service: + $ref: databricks_workspace/v00.00.00000/services/sandbox.yaml + title: Databricks Sandbox API (workspace) + version: v00.00.00000 + description: >- + OpenAPI specification for the Databricks sandbox service (workspace-level + APIs), generated from the Databricks Python SDK. serving: id: serving:v00.00.00000 name: serving @@ -328,7 +405,22 @@ config: client_secret_env_var: DATABRICKS_CLIENT_SECRET grant_type: client_credentials token_url: >- - https://accounts.cloud.databricks.com/oidc/accounts/{{ - .__env__DATABRICKS_ACCOUNT_ID }}/v1/token + https://{account_host}/oidc/accounts/{{ .__env__DATABRICKS_ACCOUNT_ID + }}/v1/token scopes: - all-apis + variables: + account_host: + description: >- + The Databricks account console host that issues OAuth M2M tokens. + Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set + explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). + default: accounts.cloud.databricks.com + x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: accounts.cloud.databricks.com + azure: accounts.azuredatabricks.net + gcp: accounts.gcp.databricks.com diff --git a/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml b/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml index 416bd998..3328f8ee 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml @@ -6,14 +6,31 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.agentbricks servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/custom-llms/{id}/optimize/cancel: post: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/agentkit.yaml b/providers/src/databricks_workspace/v00.00.00000/services/agentkit.yaml new file mode 100644 index 00000000..9930d92c --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/agentkit.yaml @@ -0,0 +1,3653 @@ +openapi: 3.0.0 +info: + title: Databricks Agentkit API (workspace) + description: >- + OpenAPI specification for the Databricks agentkit service (workspace-level + APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.agentkit +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}/items:append: + post: + operationId: agent_kit_append_session_items + summary: Appends items to a session. + tags: + - agentkit + - agent_kit + description: |- + Appends items to a session. + + :param parent: str + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + :param items: List[:class:`SessionItem`] + Items to append atomically in request order. Concurrent append requests are serialized into one + committed order without exposing a numeric sequence in the public contract. + + :returns: :class:`AppendSessionItemsResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + items: + type: array + items: + type: object + properties: + data: + type: object + description: >- + Complete SDK-native, JSON-compatible item. The service + stores and returns this value without interpreting + provider-specific fields such as ``type``, ``role``, + or ``content``. + create_time: + type: string + format: date-time + description: >- + Server-assigned time when the append commits. Values + are nondecreasing within a session. Item listing + orders by this timestamp; equal timestamps are + resolved by committed append order. + item_id: + type: string + description: Stable service-generated item ID. + required: + - data + description: A transcript entry in a session's history. + description: >- + Items to append atomically in request order. Concurrent + append requests are serialized into one committed order + without exposing a numeric sequence in the public contract. + required: + - items + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AppendSessionItemsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}/items:clear: + post: + operationId: agent_kit_clear_session_items + summary: Clears all items from a session. + tags: + - agentkit + - agent_kit + description: |- + Clears all items from a session. + + :param parent: str + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + + :returns: :class:`ClearSessionItemsResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ClearSessionItemsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/entries: + post: + operationId: agent_kit_create_memory + summary: >- + Creates a memory entry using exclusive-create semantics. Callers may + choose the entry ID; the service + tags: + - agentkit + - agent_kit + description: >- + Creates a memory entry using exclusive-create semantics. Callers may + choose the entry ID; the service + + generates one when it is omitted. Returns ``ALREADY_EXISTS`` when an + entry with the same actor, + + session, and path already exists. Omitted ``session_id`` is its own + uniqueness key: two + + omitted-session entries with the same actor and path conflict, but an + omitted-session entry does not + + conflict with a session-scoped entry at the same actor and path. + + + :param parent: str + Memory store that will contain the entry, in the form ``memory-stores/{managed_memory_store_id}``. + :param managed_memory_entry: :class:`ManagedMemoryEntry` + The memory entry to create. + :param managed_memory_entry_id: str (optional) + Optional caller-selected memory entry ID. The service generates an ID when omitted. + + :returns: :class:`ManagedMemoryEntry` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `parent` resource name + (`memory-stores/{managed_memory_store_id}`). Memory store that will + contain the entry, in the form + ``memory-stores/{managed_memory_store_id}``. + - name: managed_memory_entry_id + in: query + required: false + schema: + type: string + description: >- + Optional caller-selected memory entry ID. The service generates an + ID when omitted. + requestBody: + content: + application/json: + schema: + type: object + properties: + actor_id: + type: string + description: >- + Customer-provided identifier for the actor whose memory this + entry represents. + path: + type: string + description: >- + Absolute, case-sensitive path identifying the entry within + its actor and optional session. Paths must begin with ``/`` + and must not contain empty, ``.`` or ``..`` segments. + content: + type: string + description: Optional free-form memory content. + create_time: + type: string + format: date-time + description: Time when the entry was created. + description: + type: string + description: Human-readable description of the memory entry. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + Required for updates; assigned by the service on creation. + session_id: + type: string + description: >- + Optional identifier for the session associated with this + memory entry. When omitted, the entry applies across the + actor's sessions. + source_type: + type: string + x-enum: + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_AGENT + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_DREAMER + description: >- + Which writer created this entry. Caller sets this on Create; + immutable after creation. + update_time: + type: string + format: date-time + description: Time when the entry was last updated. + required: + - actor_id + - path + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryEntry' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_list_memories + summary: >- + Lists memory entries for one actor. An exact ``path`` filters entries + across sessions, ignoring + tags: + - agentkit + - agent_kit + description: >- + Lists memory entries for one actor. An exact ``path`` filters entries + across sessions, ignoring + + session metadata. Otherwise, ``session_id`` and ``path_prefix`` restrict + the actor partition. ``view`` + + controls whether each returned entry includes memory content. + + + :param parent: str + Memory store whose entries are listed, in the form ``memory-stores/{managed_memory_store_id}``. + :param actor_id: str + Customer-provided identifier for the actor whose entries are listed. + :param page_size: int (optional) + Maximum number of entries to return. The service may return fewer entries than requested. Defaults + to 10; must be between 1 and 100. + :param page_token: str (optional) + Opaque pagination token from a previous ListManagedMemoryEntries response. + :param path_prefix: str (optional) + Optional path prefix used to restrict entries within the actor partition. + :param session_id: str (optional) + Optional session identifier. When set, only entries with this exact ``session_id`` are returned. + Omitted-session (cross-session) entries are not included. Ignored when path is set. + :param view: :class:`ManagedMemoryEntryView` (optional) + Controls whether each returned entry includes memory content. Defaults to ``FULL``. + + :returns: Iterator over :class:`ManagedMemoryEntry` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `parent` resource name + (`memory-stores/{managed_memory_store_id}`). Memory store whose + entries are listed, in the form + ``memory-stores/{managed_memory_store_id}``. + - name: actor_id + in: query + required: true + schema: + type: string + description: Customer-provided identifier for the actor whose entries are listed. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of entries to return. The service may return fewer + entries than requested. Defaults to 10; must be between 1 and 100. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + Opaque pagination token from a previous ListManagedMemoryEntries + response. + - name: path_prefix + in: query + required: false + schema: + type: string + description: >- + Optional path prefix used to restrict entries within the actor + partition. + - name: session_id + in: query + required: false + schema: + type: string + description: >- + Optional session identifier. When set, only entries with this exact + ``session_id`` are returned. Omitted-session (cross-session) entries + are not included. Ignored when path is set. + - name: view + in: query + required: false + schema: + $ref: '#/components/schemas/ManagedMemoryEntryView' + description: >- + Controls whether each returned entry includes memory content. + Defaults to ``FULL``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExtractMemoriesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores: + post: + operationId: agent_kit_create_memory_store + summary: Creates a memory store in the caller's workspace. + tags: + - agentkit + - agent_kit + description: |- + Creates a memory store in the caller's workspace. + + :param managed_memory_store: :class:`ManagedMemoryStore` + The memory store to create. + :param managed_memory_store_id: str + 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. + + :returns: :class:`ManagedMemoryStore` + parameters: + - name: managed_memory_store_id + in: query + required: true + schema: + type: string + description: >- + 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. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that + created the store. This is immutable server-set attribution + and does not grant access; authorization is evaluated from + the authenticated request context. + description: + type: string + description: Human-readable description of the memory store. + display_name: + type: string + description: >- + Deprecated compatibility alias for the caller-provided + memory store ID. Canonical clients provide the ID through + ``CreateMemoryStoreRequest.managed_memory_store_id`` and use + ``name`` as the resource identifier. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}``. + owner_user_id: + type: string + description: >- + Deprecated alias for ``creator_user_id``. This identifies + the original creator, not a transferable owner. Use + ``creator_user_id`` instead. + storage_backend: + type: object + properties: + backend_id: + type: string + description: >- + Backend-specific identifier. For Lakebase, this is the + project ID. + backend_type: + type: string + x-enum: + - STORAGE_BACKEND_TYPE_LAKEBASE + description: Type of the storage backend. + description: Service-managed storage backing this memory store. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + workspace_id: + type: integer + description: Workspace that owns the memory store. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_list_memory_stores + summary: Lists memory stores in the caller's workspace. + tags: + - agentkit + - agent_kit + description: |- + Lists memory stores in the caller's workspace. + + :param page_size: int (optional) + Maximum number of stores to return. The service may return fewer stores than requested. Defaults to + 10; must be between 1 and 100. + :param page_token: str (optional) + Opaque pagination token from a previous ListManagedMemoryStores response. + + :returns: Iterator over :class:`ManagedMemoryStore` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of stores to return. The service may return fewer + stores than requested. Defaults to 10; must be between 1 and 100. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + Opaque pagination token from a previous ListManagedMemoryStores + response. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListManagedMemoryStoresResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions: + post: + operationId: agent_kit_create_session + summary: Creates a session within a session store. + tags: + - agentkit + - agent_kit + description: |- + Creates a session within a session store. + + :param parent: str + Resource name of the containing session store, in the form ``session-stores/{session_store_id}``. + :param session: :class:`Session` + The session to create. ``actor_id`` is required. A session with ``parent_session_id`` is a child and + must use its parent's ``actor_id``. Independent forks are created only through ``ForkSession``. + :param session_id: str (optional) + Optional caller-selected session ID. The service generates a UUID when this field is omitted. The ID + must be unique; a collision returns ``ALREADY_EXISTS``. + + :returns: :class:`Session` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}`). Resource name of the + containing session store, in the form + ``session-stores/{session_store_id}``. + - name: session_id + in: query + required: false + schema: + type: string + description: >- + Optional caller-selected session ID. The service generates a UUID + when this field is omitted. The ID must be unique; a collision + returns ``ALREADY_EXISTS``. + requestBody: + content: + application/json: + schema: + type: object + properties: + actor_id: + type: string + description: >- + Opaque caller-provided identifier for the application actor + associated with the session. This is application data and + has no Databricks authentication or authorization semantics. + Use the same value as the Managed Memory Entry ``actor_id`` + when storing memories associated with this actor. Every + session must set it. A child session must use the same value + as its parent. + create_time: + type: string + format: date-time + description: Time when the session was created. + last_activity_time: + type: string + format: date-time + description: Time when the session's item history was last mutated. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: >- + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + parent_session_id: + type: string + description: >- + Immediate parent session ID. Set only at creation for child + sessions, immutable thereafter, and restricted to the same + store. + root_session_id: + type: string + description: >- + Top-level session ID in the spawn tree. This equals + ``session_id`` for a root or fork and is inherited + transitively by child sessions. + session_id: + type: string + description: >- + Unique session ID. The service generates a UUID unless the + caller supplies ``CreateSessionRequest.session_id``. + update_time: + type: string + format: date-time + description: Time when session resource fields last changed. + required: + - actor_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_list_sessions + summary: Lists sessions within a session store. + tags: + - agentkit + - agent_kit + description: |- + Lists sessions within a session store. + + :param parent: str + Resource name of the containing session store, in the form ``session-stores/{session_store_id}``. + :param filter: str (optional) + Filter expression. Supported fields include ``actor_id`` and ``metadata``; for example, ``actor_id = + "support-customer-123"``. + :param order_by: str (optional) + Sort order. Defaults to ``last_activity_time desc``. Page-token continuation is exactly-once when + ordering by ``create_time`` (immutable); ordering by ``last_activity_time`` is best-effort, because + that value changes as a session gains activity, so a session updated between page requests may be + repeated or skipped. To enumerate every session exactly once, order by ``create_time``. + :param page_size: int (optional) + Maximum number of sessions to return. Defaults to 10; must be between 1 and 100. + :param page_token: str (optional) + Token returned by a previous list request. + + :returns: Iterator over :class:`Session` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}`). Resource name of the + containing session store, in the form + ``session-stores/{session_store_id}``. + - name: filter + in: query + required: false + schema: + type: string + description: >- + Filter expression. Supported fields include ``actor_id`` and + ``metadata``; for example, ``actor_id = "support-customer-123"``. + - name: order_by + in: query + required: false + schema: + type: string + description: >- + Sort order. Defaults to ``last_activity_time desc``. Page-token + continuation is exactly-once when ordering by ``create_time`` + (immutable); ordering by ``last_activity_time`` is best-effort, + because that value changes as a session gains activity, so a session + updated between page requests may be repeated or skipped. To + enumerate every session exactly once, order by ``create_time``. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of sessions to return. Defaults to 10; must be + between 1 and 100. + - name: page_token + in: query + required: false + schema: + type: string + description: Token returned by a previous list request. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListSessionsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores: + post: + operationId: agent_kit_create_session_store + summary: Creates a session store. + tags: + - agentkit + - agent_kit + description: |- + Creates a session store. + + :param session_store: :class:`SessionStore` + The session store to create. + :param session_store_id: str + Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a + lowercase letter, and contain only lowercase letters, digits, and hyphens. + + :returns: :class:`SessionStore` + parameters: + - name: session_store_id + in: query + required: true + schema: + type: string + description: >- + Caller-provided, workspace-unique session store ID. It must be 3-55 + characters, begin with a lowercase letter, and contain only + lowercase letters, digits, and hyphens. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that + created the store. This is immutable server-set attribution + and does not grant access; authorization is evaluated from + the authenticated request context. + description: + type: string + description: Human-readable description of the session store. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: >- + Resource name in the form + ``session-stores/{session_store_id}``. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SessionStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_list_session_stores + summary: Lists session stores. + tags: + - agentkit + - agent_kit + description: |- + Lists session stores. + + :param page_size: int (optional) + Maximum number of session stores to return. Defaults to 10; must be between 1 and 100. + :param page_token: str (optional) + Token returned by a previous list request. + + :returns: Iterator over :class:`SessionStore` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of session stores to return. Defaults to 10; must be + between 1 and 100. + - name: page_token + in: query + required: false + schema: + type: string + description: Token returned by a previous list request. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListSessionStoresResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}: + delete: + operationId: agent_kit_delete_memory + summary: >- + Deletes a memory entry by resource name. Returns ``NOT_FOUND`` when the + entry does not exist in the + tags: + - agentkit + - agent_kit + description: >- + Deletes a memory entry by resource name. Returns ``NOT_FOUND`` when the + entry does not exist in the + + caller's workspace. + + + :param name: str + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + - name: managed_memory_entry_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_entry_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_get_memory + summary: >- + Retrieves a memory entry by resource name. ``view`` controls whether the + response includes memory + tags: + - agentkit + - agent_kit + description: >- + Retrieves a memory entry by resource name. ``view`` controls whether the + response includes memory + + content. Returns ``NOT_FOUND`` when the entry does not exist in the + caller's workspace. + + + :param name: str + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + :param view: :class:`ManagedMemoryEntryView` (optional) + Controls whether the response includes memory content. Defaults to ``FULL``. + + :returns: :class:`ManagedMemoryEntry` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + - name: managed_memory_entry_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_entry_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + - name: view + in: query + required: false + schema: + $ref: '#/components/schemas/ManagedMemoryEntryView' + description: >- + Controls whether the response includes memory content. Defaults to + ``FULL``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryEntry' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + patch: + operationId: agent_kit_update_memory + summary: >- + Updates selected mutable fields on a memory entry. Identity fields are + immutable. + tags: + - agentkit + - agent_kit + description: >- + Updates selected mutable fields on a memory entry. Identity fields are + immutable. + + + :param name: str + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. Required for updates; + assigned by the service on creation. + :param managed_memory_entry: :class:`ManagedMemoryEntry` + The memory entry to update. + :param update_mask: FieldMask + Fields to update. Only ``content`` and ``description`` may be updated. + + :returns: :class:`ManagedMemoryEntry` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + Required for updates; assigned by the service on creation. + - name: managed_memory_entry_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_entry_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}`). + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + Required for updates; assigned by the service on creation. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Fields to update. Only ``content`` and ``description`` may be + updated. + requestBody: + content: + application/json: + schema: + type: object + properties: + actor_id: + type: string + description: >- + Customer-provided identifier for the actor whose memory this + entry represents. + path: + type: string + description: >- + Absolute, case-sensitive path identifying the entry within + its actor and optional session. Paths must begin with ``/`` + and must not contain empty, ``.`` or ``..`` segments. + content: + type: string + description: Optional free-form memory content. + create_time: + type: string + format: date-time + description: Time when the entry was created. + description: + type: string + description: Human-readable description of the memory entry. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + Required for updates; assigned by the service on creation. + session_id: + type: string + description: >- + Optional identifier for the session associated with this + memory entry. When omitted, the entry applies across the + actor's sessions. + source_type: + type: string + x-enum: + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_AGENT + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_DREAMER + description: >- + Which writer created this entry. Caller sets this on Create; + immutable after creation. + update_time: + type: string + format: date-time + description: Time when the entry was last updated. + required: + - actor_id + - path + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryEntry' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}: + delete: + operationId: agent_kit_delete_memory_store + summary: >- + Deletes a memory store by resource name. Returns ``NOT_FOUND`` when the + store does not exist in the + tags: + - agentkit + - agent_kit + description: >- + Deletes a memory store by resource name. Returns ``NOT_FOUND`` when the + store does not exist in the + + caller's workspace. + + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_get_memory_store + summary: >- + Retrieves a memory store by resource name. Returns ``NOT_FOUND`` when + the store does not exist in the + tags: + - agentkit + - agent_kit + description: >- + Retrieves a memory store by resource name. Returns ``NOT_FOUND`` when + the store does not exist in the + + caller's workspace. + + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + + :returns: :class:`ManagedMemoryStore` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + patch: + operationId: agent_kit_update_memory_store + summary: Updates a memory store's description and metadata. + tags: + - agentkit + - agent_kit + description: |- + Updates a memory store's description and metadata. + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + :param managed_memory_store: :class:`ManagedMemoryStore` + The memory store to update. ``name`` is taken from the URL. + :param update_mask: FieldMask + Only ``description`` and ``metadata`` may be updated. Selecting ``metadata`` replaces the entire + map. + + :returns: :class:`ManagedMemoryStore` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Only ``description`` and ``metadata`` may be updated. Selecting + ``metadata`` replaces the entire map. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that + created the store. This is immutable server-set attribution + and does not grant access; authorization is evaluated from + the authenticated request context. + description: + type: string + description: Human-readable description of the memory store. + display_name: + type: string + description: >- + Deprecated compatibility alias for the caller-provided + memory store ID. Canonical clients provide the ID through + ``CreateMemoryStoreRequest.managed_memory_store_id`` and use + ``name`` as the resource identifier. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}``. + owner_user_id: + type: string + description: >- + Deprecated alias for ``creator_user_id``. This identifies + the original creator, not a transferable owner. Use + ``creator_user_id`` instead. + storage_backend: + type: object + properties: + backend_id: + type: string + description: >- + Backend-specific identifier. For Lakebase, this is the + project ID. + backend_type: + type: string + x-enum: + - STORAGE_BACKEND_TYPE_LAKEBASE + description: Type of the storage backend. + description: Service-managed storage backing this memory store. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + workspace_id: + type: integer + description: Workspace that owns the memory store. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ManagedMemoryStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}: + delete: + operationId: agent_kit_delete_session + summary: >- + Deletes a session, its items, and any descendant sessions recursively. + Independently retained memory + tags: + - agentkit + - agent_kit + description: >- + Deletes a session, its items, and any descendant sessions recursively. + Independently retained memory + + is not deleted. + + + :param name: str + Resource name in the form ``session-stores/{session_store_id}/sessions/{session_id}``. + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_get_session + summary: Gets a session by resource name. + tags: + - agentkit + - agent_kit + description: |- + Gets a session by resource name. + + :param name: str + Resource name in the form ``session-stores/{session_store_id}/sessions/{session_id}``. + + :returns: :class:`Session` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + patch: + operationId: agent_kit_update_session + summary: Updates a session's mutable fields. + tags: + - agentkit + - agent_kit + description: |- + Updates a session's mutable fields. + + :param name: str + Resource name in the form ``session-stores/{session_store_id}/sessions/{session_id}``. + :param session: :class:`Session` + Session to update. + :param update_mask: FieldMask + Fields to update. Only ``metadata`` is mutable; any other path returns ``INVALID_PARAMETER_VALUE``. + + :returns: :class:`Session` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `name` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Fields to update. Only ``metadata`` is mutable; any other path + returns ``INVALID_PARAMETER_VALUE``. + requestBody: + content: + application/json: + schema: + type: object + properties: + actor_id: + type: string + description: >- + Opaque caller-provided identifier for the application actor + associated with the session. This is application data and + has no Databricks authentication or authorization semantics. + Use the same value as the Managed Memory Entry ``actor_id`` + when storing memories associated with this actor. Every + session must set it. A child session must use the same value + as its parent. + create_time: + type: string + format: date-time + description: Time when the session was created. + last_activity_time: + type: string + format: date-time + description: Time when the session's item history was last mutated. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: >- + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + parent_session_id: + type: string + description: >- + Immediate parent session ID. Set only at creation for child + sessions, immutable thereafter, and restricted to the same + store. + root_session_id: + type: string + description: >- + Top-level session ID in the spawn tree. This equals + ``session_id`` for a root or fork and is inherited + transitively by child sessions. + session_id: + type: string + description: >- + Unique session ID. The service generates a UUID unless the + caller supplies ``CreateSessionRequest.session_id``. + update_time: + type: string + format: date-time + description: Time when session resource fields last changed. + required: + - actor_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Session' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}: + delete: + operationId: agent_kit_delete_session_store + summary: >- + Deletes a session store, its sessions and items, and its service-managed + storage. Memory entries + tags: + - agentkit + - agent_kit + description: >- + Deletes a session store, its sessions and items, and its service-managed + storage. Memory entries + + retained by a separate Memory Store are not deleted. + + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + get: + operationId: agent_kit_get_session_store + summary: Gets a session store by resource name. + tags: + - agentkit + - agent_kit + description: |- + Gets a session store by resource name. + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + + :returns: :class:`SessionStore` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SessionStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + patch: + operationId: agent_kit_update_session_store + summary: Updates a session store's description and metadata. + tags: + - agentkit + - agent_kit + description: |- + Updates a session store's description and metadata. + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + :param session_store: :class:`SessionStore` + Session store to update. + :param update_mask: FieldMask + Fields to update. Only ``description`` and ``metadata`` are mutable; any other path returns + ``INVALID_PARAMETER_VALUE``. + + :returns: :class:`SessionStore` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Fields to update. Only ``description`` and ``metadata`` are mutable; + any other path returns ``INVALID_PARAMETER_VALUE``. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that + created the store. This is immutable server-set attribution + and does not grant access; authorization is evaluated from + the authenticated request context. + description: + type: string + description: Human-readable description of the session store. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: >- + Resource name in the form + ``session-stores/{session_store_id}``. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SessionStore' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}/extractions: + post: + operationId: agent_kit_extract_memories + summary: >- + Synchronously extracts memories from a single session into the given + memory store, returning the + tags: + - agentkit + - agent_kit + description: >- + Synchronously extracts memories from a single session into the given + memory store, returning the + + entries that were written. + + + :param session_store: str + Session store containing the session, in the form ``session-stores/{session_store_id}``. + :param session_id: str + Identifier of the session whose transcript is distilled into memories. + :param memory_store: str + Memory store the extracted entries are written to, in the form + ``memory-stores/{managed_memory_store_id}``. + :param dry_run: bool (optional) + When true, extract and return the entries without writing them to the memory store. Defaults to + false, which persists the extracted entries and returns them. + :param instructions: str (optional) + Instructions steering what is extracted from the session. + + :returns: :class:`ExtractMemoriesResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `session_store` resource name + (`session-stores/{session_store_id}`). Session store containing the + session, in the form ``session-stores/{session_store_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + Identifier of the session whose transcript is distilled into + memories. + requestBody: + content: + application/json: + schema: + type: object + properties: + memory_store: + type: string + description: >- + Memory store the extracted entries are written to, in the + form ``memory-stores/{managed_memory_store_id}``. + dry_run: + type: boolean + description: >- + When true, extract and return the entries without writing + them to the memory store. Defaults to false, which persists + the extracted entries and returns them. + instructions: + type: string + description: Instructions steering what is extracted from the session. + required: + - memory_store + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExtractMemoriesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions:fork: + post: + operationId: agent_kit_fork_session + summary: Forks a session into an independent top-level copy. + tags: + - agentkit + - agent_kit + description: |- + Forks a session into an independent top-level copy. + + :param parent: str + Resource name of the containing session store, in the form ``session-stores/{session_store_id}``. + :param source_session_id: str + ID of the session to copy. + :param actor_id: str + Opaque caller-provided identifier for the application actor associated with the forked session. + :param metadata: Dict[str,str] (optional) + Optional metadata for the fork. + :param session_id: str (optional) + Optional unique ID for the forked session. A collision returns ``ALREADY_EXISTS``. + :param up_to_item_id: str (optional) + Optional last item ID to copy through, inclusively. When omitted, the fork atomically copies all + items committed before the fork operation begins. + + :returns: :class:`ForkSessionResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}`). Resource name of the + containing session store, in the form + ``session-stores/{session_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + source_session_id: + type: string + description: ID of the session to copy. + actor_id: + type: string + description: >- + Opaque caller-provided identifier for the application actor + associated with the forked session. + metadata: + type: object + description: Optional metadata for the fork. + session_id: + type: string + description: >- + Optional unique ID for the forked session. A collision + returns ``ALREADY_EXISTS``. + up_to_item_id: + type: string + description: >- + Optional last item ID to copy through, inclusively. When + omitted, the fork atomically copies all items committed + before the fork operation begins. + required: + - source_session_id + - actor_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ForkSessionResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/permissions/self: + get: + operationId: agent_kit_get_memory_store_permission + summary: >- + Retrieves the current caller's effective memory store permission. + Returns PERMISSION_LEVEL_UNSPECIFIED + tags: + - agentkit + - agent_kit + description: >- + Retrieves the current caller's effective memory store permission. + Returns PERMISSION_LEVEL_UNSPECIFIED + + when the caller has no access. + + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + + :returns: :class:`MemoryStorePermission` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MemoryStorePermission' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/permissions/self: + get: + operationId: agent_kit_get_session_store_permission + summary: >- + Retrieves the current caller's effective session store permission. + Returns + tags: + - agentkit + - agent_kit + description: >- + Retrieves the current caller's effective session store permission. + Returns + + PERMISSION_LEVEL_UNSPECIFIED when the caller has no access. + + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + + :returns: :class:`SessionStorePermission` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SessionStorePermission' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/permissions:grant: + post: + operationId: agent_kit_grant_memory_store_permission + summary: >- + Grants a READ or WRITE permission on a memory store to a principal. Only + the owner or a workspace + tags: + - agentkit + - agent_kit + description: >- + Grants a READ or WRITE permission on a memory store to a principal. Only + the owner or a workspace + + admin may grant permissions. + + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + :param principal: :class:`StorePrincipal` + Principal to grant the permission to. + :param permission: :class:`PermissionLevel` + Permission level to grant. + + :returns: :class:`GrantMemoryStorePermissionResponse` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + name: + type: string + principal_type: + type: string + x-enum: + - SERVICE_PRINCIPAL + - USER + description: >- + The kind of principal. Required unless the deprecated + type alias is supplied. + required: + - name + description: Principal to grant the permission to. + permission: + type: string + x-enum: + - READ + - WRITE + description: Permission level to grant. + required: + - principal + - permission + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GrantMemoryStorePermissionResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/permissions:grant: + post: + operationId: agent_kit_grant_session_store_permission + summary: >- + Grants a READ or WRITE permission on a session store to a principal. + Only the owner or a workspace + tags: + - agentkit + - agent_kit + description: >- + Grants a READ or WRITE permission on a session store to a principal. + Only the owner or a workspace + + admin may grant permissions. + + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + :param principal: :class:`StorePrincipal` + Principal to grant the permission to. + :param permission: :class:`PermissionLevel` + Permission level to grant. + + :returns: :class:`GrantSessionStorePermissionResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + name: + type: string + principal_type: + type: string + x-enum: + - SERVICE_PRINCIPAL + - USER + description: >- + The kind of principal. Required unless the deprecated + type alias is supplied. + required: + - name + description: Principal to grant the permission to. + permission: + type: string + x-enum: + - READ + - WRITE + description: Permission level to grant. + required: + - principal + - permission + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GrantSessionStorePermissionResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/permissions: + get: + operationId: agent_kit_list_memory_store_permissions + summary: >- + Lists explicit memory store grants. Only the owner or a workspace admin + may list permissions. + tags: + - agentkit + - agent_kit + description: >- + Lists explicit memory store grants. Only the owner or a workspace admin + may list permissions. + + + :param parent: str + Resource name of the store, in the form ``memory-stores/{managed_memory_store_id}``. + :param page_size: int (optional) + Maximum number of permissions to return. Defaults to 100; maximum is 1000. + :param page_token: str (optional) + Continuation token from a previous response. + + :returns: Iterator over :class:`MemoryStorePermission` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `parent` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name of the + store, in the form ``memory-stores/{managed_memory_store_id}``. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of permissions to return. Defaults to 100; maximum is + 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: Continuation token from a previous response. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListMemoryStorePermissionsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}/items: + get: + operationId: agent_kit_list_session_items + summary: Lists items in a session. + tags: + - agentkit + - agent_kit + description: |- + Lists items in a session. + + :param parent: str + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + :param order_by: str (optional) + Sort order. Supported values are ``create_time asc`` and ``create_time desc``. The default is + ``create_time desc``, which returns the most recently appended items first. Equal timestamps are + resolved by committed append order in the requested direction. + :param page_size: int (optional) + Maximum number of items to return. Defaults to 10; must be between 1 and 100. + :param page_token: str (optional) + Token returned by a previous list request. + + :returns: Iterator over :class:`SessionItem` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: order_by + in: query + required: false + schema: + type: string + description: >- + Sort order. Supported values are ``create_time asc`` and + ``create_time desc``. The default is ``create_time desc``, which + returns the most recently appended items first. Equal timestamps are + resolved by committed append order in the requested direction. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of items to return. Defaults to 10; must be between 1 + and 100. + - name: page_token + in: query + required: false + schema: + type: string + description: Token returned by a previous list request. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AppendSessionItemsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/permissions: + get: + operationId: agent_kit_list_session_store_permissions + summary: >- + Lists explicit session store grants. Only the owner or a workspace admin + may list permissions. + tags: + - agentkit + - agent_kit + description: >- + Lists explicit session store grants. Only the owner or a workspace admin + may list permissions. + + + :param parent: str + Resource name of the store, in the form ``session-stores/{session_store_id}``. + :param page_size: int (optional) + Maximum number of permissions to return. Defaults to 100; maximum is 1000. + :param page_token: str (optional) + Continuation token from a previous response. + + :returns: Iterator over :class:`SessionStorePermission` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}`). Resource name of the store, + in the form ``session-stores/{session_store_id}``. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of permissions to return. Defaults to 100; maximum is + 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: Continuation token from a previous response. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListSessionStorePermissionsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/sessions/{session_id}/items:pop: + post: + operationId: agent_kit_pop_session_item + summary: Pops the newest item from a session. + tags: + - agentkit + - agent_kit + description: |- + Pops the newest item from a session. + + :param parent: str + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + + :returns: :class:`PopSessionItemResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + - name: session_id + in: path + required: true + schema: + type: string + description: >- + The `session_id` segment of the `parent` resource name + (`session-stores/{session_store_id}/sessions/{session_id}`). + Resource name of the containing session, in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PopSessionItemResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/permissions:revoke: + post: + operationId: agent_kit_revoke_memory_store_permission + summary: >- + Removes a principal's explicit READ and WRITE grants on a memory store. + Only the owner or a workspace + tags: + - agentkit + - agent_kit + description: >- + Removes a principal's explicit READ and WRITE grants on a memory store. + Only the owner or a workspace + + admin may revoke permissions. Ownership and inherited access are + unaffected. + + + :param name: str + Resource name in the form ``memory-stores/{managed_memory_store_id}``. + :param principal: :class:`StorePrincipal` + Principal whose READ and WRITE grants will be removed. + + :returns: :class:`RevokeMemoryStorePermissionResponse` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `name` resource name + (`memory-stores/{managed_memory_store_id}`). Resource name in the + form ``memory-stores/{managed_memory_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + name: + type: string + principal_type: + type: string + x-enum: + - SERVICE_PRINCIPAL + - USER + description: >- + The kind of principal. Required unless the deprecated + type alias is supplied. + required: + - name + description: Principal whose READ and WRITE grants will be removed. + required: + - principal + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/RevokeMemoryStorePermissionResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/session-stores/{session_store_id}/permissions:revoke: + post: + operationId: agent_kit_revoke_session_store_permission + summary: >- + Removes a principal's explicit READ and WRITE grants on a session store. + Only the owner or a workspace + tags: + - agentkit + - agent_kit + description: >- + Removes a principal's explicit READ and WRITE grants on a session store. + Only the owner or a workspace + + admin may revoke permissions. Ownership and inherited access are + unaffected. + + + :param name: str + Resource name in the form ``session-stores/{session_store_id}``. + :param principal: :class:`StorePrincipal` + Principal whose READ and WRITE grants will be removed. + + :returns: :class:`RevokeSessionStorePermissionResponse` + parameters: + - name: session_store_id + in: path + required: true + schema: + type: string + description: >- + The `session_store_id` segment of the `name` resource name + (`session-stores/{session_store_id}`). Resource name in the form + ``session-stores/{session_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + principal: + type: object + properties: + name: + type: string + principal_type: + type: string + x-enum: + - SERVICE_PRINCIPAL + - USER + description: >- + The kind of principal. Required unless the deprecated + type alias is supplied. + required: + - name + description: Principal whose READ and WRITE grants will be removed. + required: + - principal + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/RevokeSessionStorePermissionResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI + /api/2.0/agents/memory-stores/{managed_memory_store_id}/entries:search: + post: + operationId: agent_kit_search_memories + summary: >- + Searches memory entries by text query for one actor. Returns matching + entries and scores ranked by + tags: + - agentkit + - agent_kit + description: >- + Searches memory entries by text query for one actor. Returns matching + entries and scores ranked by + + relevance; ``view`` controls whether each returned entry includes + content. + + + :param parent: str + Memory store whose entries are searched, in the form ``memory-stores/{managed_memory_store_id}``. + :param actor_id: str + Customer-provided identifier for the actor whose entries are searched. + :param query: str + Free-form search query. + :param limit: int (optional) + Deprecated alias for ``page_size``. When both fields are set, their values must match. + :param page_size: int (optional) + Maximum number of relevance-ranked entries to return. Defaults to 10 and must be between 1 and 100. + :param page_token: str (optional) + Reserved for pagination compatibility. The server currently ignores this field because Search + returns a ranked top-N result set. + :param path_prefix: str (optional) + Optional absolute, case-sensitive path prefix used to restrict searched entries within the actor + partition. The prefix must begin with ``/`` and must not contain empty, ``.`` or ``..`` segments. + :param session_id: str (optional) + Optional session identifier. When set, only entries with this exact ``session_id`` are searched. + Omitted-session (cross-session) entries are not included. + :param view: :class:`ManagedMemoryEntryView` (optional) + Controls whether each returned entry includes memory content. Search scores are always returned. + Defaults to ``FULL``. + + :returns: Iterator over :class:`ManagedMemoryEntrySearchResult` + parameters: + - name: managed_memory_store_id + in: path + required: true + schema: + type: string + description: >- + The `managed_memory_store_id` segment of the `parent` resource name + (`memory-stores/{managed_memory_store_id}`). Memory store whose + entries are searched, in the form + ``memory-stores/{managed_memory_store_id}``. + requestBody: + content: + application/json: + schema: + type: object + properties: + actor_id: + type: string + description: >- + Customer-provided identifier for the actor whose entries are + searched. + query: + type: string + description: Free-form search query. + limit: + type: integer + description: >- + Deprecated alias for ``page_size``. When both fields are + set, their values must match. + page_size: + type: integer + description: >- + Maximum number of relevance-ranked entries to return. + Defaults to 10 and must be between 1 and 100. + page_token: + type: string + description: >- + Reserved for pagination compatibility. The server currently + ignores this field because Search returns a ranked top-N + result set. + path_prefix: + type: string + description: >- + Optional absolute, case-sensitive path prefix used to + restrict searched entries within the actor partition. The + prefix must begin with ``/`` and must not contain empty, + ``.`` or ``..`` segments. + session_id: + type: string + description: >- + Optional session identifier. When set, only entries with + this exact ``session_id`` are searched. Omitted-session + (cross-session) entries are not included. + view: + type: string + x-enum: + - MANAGED_MEMORY_ENTRY_VIEW_BASIC + - MANAGED_MEMORY_ENTRY_VIEW_FULL + description: >- + Controls whether each returned entry includes memory + content. Search scores are always returned. Defaults to + ``FULL``. + required: + - actor_id + - query + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SearchManagedMemoryEntriesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AgentKitAPI +components: + schemas: + AppendSessionItemsResponse: + type: object + properties: + session_items: + type: array + items: + $ref: '#/components/schemas/SessionItem' + description: Persisted session items with service-assigned fields. + description: Response containing appended items. + ClearSessionItemsResponse: + type: object + properties: {} + description: Response from clearing items from a session. + ExtractMemoriesResponse: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/ManagedMemoryEntry' + description: The memory entries written by this extraction. + name: + type: string + description: >- + Correlation identifier for this extraction, for logging and tracing. + Not a fetchable resource. + description: Result of a single-session memory extraction. + ForkSessionResponse: + type: object + properties: + session: + $ref: '#/components/schemas/Session' + description: The newly-created independent top-level session. + description: Response from forking a session. + GrantMemoryStorePermissionResponse: + type: object + properties: {} + description: Response from granting a permission on a memory store. + GrantSessionStorePermissionResponse: + type: object + properties: {} + description: Response from granting a permission on a session store. + ListManagedMemoryEntriesResponse: + type: object + properties: + managed_memory_entries: + type: array + items: + $ref: '#/components/schemas/ManagedMemoryEntry' + description: Memory entries matching the request and selected response view. + next_page_token: + type: string + description: >- + Opaque pagination token. This field is omitted when there are no + more results. + description: Response containing memory entries. + ListManagedMemoryStoresResponse: + type: object + properties: + managed_memory_stores: + type: array + items: + $ref: '#/components/schemas/ManagedMemoryStore' + description: Memory stores in the caller's workspace. + next_page_token: + type: string + description: >- + Opaque pagination token. This field is omitted when there are no + more results. + description: Response containing memory stores in the caller's workspace. + ListMemoryStorePermissionsResponse: + type: object + properties: + memory_store_permissions: + type: array + items: + $ref: '#/components/schemas/MemoryStorePermission' + description: >- + Explicit READ or WRITE grants. Implicit owner/admin access and + inherited grants are excluded. + next_page_token: + type: string + description: >- + Token for the next page, omitted when all permissions have been + returned. + description: A page of explicit memory store permissions. + ListSessionItemsResponse: + type: object + properties: + next_page_token: + type: string + description: Token to retrieve the next page. + session_items: + type: array + items: + $ref: '#/components/schemas/SessionItem' + description: Session items in the requested page. + description: Response containing a page of session items. + ListSessionStorePermissionsResponse: + type: object + properties: + next_page_token: + type: string + description: >- + Token for the next page, omitted when all permissions have been + returned. + session_store_permissions: + type: array + items: + $ref: '#/components/schemas/SessionStorePermission' + description: >- + Explicit READ or WRITE grants. Implicit owner/admin access and + inherited grants are excluded. + description: A page of explicit session store permissions. + ListSessionStoresResponse: + type: object + properties: + next_page_token: + type: string + description: Token to retrieve the next page. + session_stores: + type: array + items: + $ref: '#/components/schemas/SessionStore' + description: Session stores in the requested page. + description: Response containing a page of session stores. + ListSessionsResponse: + type: object + properties: + next_page_token: + type: string + description: Token to retrieve the next page. + sessions: + type: array + items: + $ref: '#/components/schemas/Session' + description: Sessions in the requested page. + description: Response containing a page of sessions. + ManagedMemoryEntry: + type: object + properties: + actor_id: + type: string + description: >- + Customer-provided identifier for the actor whose memory this entry + represents. + path: + type: string + description: >- + Absolute, case-sensitive path identifying the entry within its actor + and optional session. Paths must begin with ``/`` and must not + contain empty, ``.`` or ``..`` segments. + content: + type: string + description: Optional free-form memory content. + create_time: + type: string + format: date-time + description: Time when the entry was created. + description: + type: string + description: Human-readable description of the memory entry. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}``. + Required for updates; assigned by the service on creation. + session_id: + type: string + description: >- + Optional identifier for the session associated with this memory + entry. When omitted, the entry applies across the actor's sessions. + source_type: + $ref: '#/components/schemas/ManagedMemoryEntrySourceType' + description: >- + Which writer created this entry. Caller sets this on Create; + immutable after creation. + update_time: + type: string + format: date-time + description: Time when the entry was last updated. + required: + - actor_id + - path + description: A workspace-scoped entry in a memory store. + ManagedMemoryEntrySearchResult: + type: object + properties: + managed_memory_entry: + $ref: '#/components/schemas/ManagedMemoryEntry' + description: Memory entry matching the query. + score: + type: number + description: Relevance score for the result. Higher scores are more relevant. + description: One relevance-ranked memory search result. + ManagedMemoryStore: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that created + the store. This is immutable server-set attribution and does not + grant access; authorization is evaluated from the authenticated + request context. + description: + type: string + description: Human-readable description of the memory store. + display_name: + type: string + description: >- + Deprecated compatibility alias for the caller-provided memory store + ID. Canonical clients provide the ID through + ``CreateMemoryStoreRequest.managed_memory_store_id`` and use + ``name`` as the resource identifier. + name: + type: string + description: >- + Resource name in the form + ``memory-stores/{managed_memory_store_id}``. + owner_user_id: + type: string + description: >- + Deprecated alias for ``creator_user_id``. This identifies the + original creator, not a transferable owner. Use ``creator_user_id`` + instead. + storage_backend: + $ref: '#/components/schemas/StorageBackend' + description: Service-managed storage backing this memory store. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + workspace_id: + type: integer + description: Workspace that owns the memory store. + description: A workspace-scoped memory store backed by service-managed storage. + MemoryStorePermission: + type: object + properties: + permission: + $ref: '#/components/schemas/PermissionLevel' + description: >- + The permission level. WRITE includes READ; + PERMISSION_LEVEL_UNSPECIFIED means neither is available. + principal: + $ref: '#/components/schemas/StorePrincipal' + description: The principal whose permission is reported. + description: A principal's permission on a memory store. + PopSessionItemResponse: + type: object + properties: + item: + $ref: '#/components/schemas/SessionItem' + description: Removed item, if any. + description: Response containing the popped item. + RevokeMemoryStorePermissionResponse: + type: object + properties: {} + description: Response from revoking a memory store permission. + RevokeSessionStorePermissionResponse: + type: object + properties: {} + description: Response from revoking a session store permission. + SearchManagedMemoryEntriesResponse: + type: object + properties: + managed_memory_entries: + type: array + items: + $ref: '#/components/schemas/ManagedMemoryEntry' + description: >- + Deprecated compatibility alias for clients migrating to ``results``. + This contains the same entries in the same order, but omits their + relevance scores. + next_page_token: + type: string + description: >- + Opaque pagination token. Search currently returns an unpaginated + ranked top-N result set, so the server does not populate this field. + results: + type: array + items: + $ref: '#/components/schemas/ManagedMemoryEntrySearchResult' + description: >- + Canonical matching entries and relevance scores, ordered most + relevant first. + description: Response containing memory entries ranked by relevance. + Session: + type: object + properties: + actor_id: + type: string + description: >- + Opaque caller-provided identifier for the application actor + associated with the session. This is application data and has no + Databricks authentication or authorization semantics. Use the same + value as the Managed Memory Entry ``actor_id`` when storing memories + associated with this actor. Every session must set it. A child + session must use the same value as its parent. + create_time: + type: string + format: date-time + description: Time when the session was created. + last_activity_time: + type: string + format: date-time + description: Time when the session's item history was last mutated. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: >- + Resource name in the form + ``session-stores/{session_store_id}/sessions/{session_id}``. + parent_session_id: + type: string + description: >- + Immediate parent session ID. Set only at creation for child + sessions, immutable thereafter, and restricted to the same store. + root_session_id: + type: string + description: >- + Top-level session ID in the spawn tree. This equals ``session_id`` + for a root or fork and is inherited transitively by child sessions. + session_id: + type: string + description: >- + Unique session ID. The service generates a UUID unless the caller + supplies ``CreateSessionRequest.session_id``. + update_time: + type: string + format: date-time + description: Time when session resource fields last changed. + required: + - actor_id + description: A durable logical interaction stored within a Session Store. + SessionItem: + type: object + properties: + data: + type: object + description: >- + Complete SDK-native, JSON-compatible item. The service stores and + returns this value without interpreting provider-specific fields + such as ``type``, ``role``, or ``content``. + create_time: + type: string + format: date-time + description: >- + Server-assigned time when the append commits. Values are + nondecreasing within a session. Item listing orders by this + timestamp; equal timestamps are resolved by committed append order. + item_id: + type: string + description: Stable service-generated item ID. + required: + - data + description: A transcript entry in a session's history. + SessionStore: + type: object + properties: + create_time: + type: string + format: date-time + description: Time when the store was created. + creator_user_id: + type: string + description: >- + Workspace-local user ID of the authenticated principal that created + the store. This is immutable server-set attribution and does not + grant access; authorization is evaluated from the authenticated + request context. + description: + type: string + description: Human-readable description of the session store. + metadata: + type: object + description: Mutable caller-defined string labels. + name: + type: string + description: Resource name in the form ``session-stores/{session_store_id}``. + update_time: + type: string + format: date-time + description: Time when the store was last updated. + description: A workspace-scoped session store. + SessionStorePermission: + type: object + properties: + permission: + $ref: '#/components/schemas/PermissionLevel' + description: >- + The permission level. WRITE includes READ; + PERMISSION_LEVEL_UNSPECIFIED means neither is available. + principal: + $ref: '#/components/schemas/StorePrincipal' + description: The principal whose permission is reported. + description: A principal's permission on a session store. + StorageBackend: + type: object + properties: + backend_id: + type: string + description: Backend-specific identifier. For Lakebase, this is the project ID. + backend_type: + $ref: '#/components/schemas/StorageBackendType' + description: Type of the storage backend. + description: Service-managed storage backing a memory store. + StorePrincipal: + type: object + properties: + name: + type: string + principal_type: + $ref: '#/components/schemas/PrincipalType' + description: >- + The kind of principal. Required unless the deprecated type alias is + supplied. + required: + - name + description: >- + A principal a store permission is granted to. ``name`` is the + principal's Lakebase identifier: a + user's email or a service principal's application (client) id. + ManagedMemoryEntrySourceType: + type: string + x-enum: + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_AGENT + - MANAGED_MEMORY_ENTRY_SOURCE_TYPE_DREAMER + description: Identifies the source that created a memory entry. + ManagedMemoryEntryView: + type: string + x-enum: + - MANAGED_MEMORY_ENTRY_VIEW_BASIC + - MANAGED_MEMORY_ENTRY_VIEW_FULL + description: Controls how much memory entry data is returned. + PermissionLevel: + type: string + x-enum: + - READ + - WRITE + description: Permission level granted on a store. WRITE is a superset of READ. + PrincipalType: + type: string + x-enum: + - SERVICE_PRINCIPAL + - USER + description: The kind of Databricks principal a store permission is granted to. + StorageBackendType: + type: string + x-enum: + - STORAGE_BACKEND_TYPE_LAKEBASE + description: Type of service-managed storage backing a memory store. + x-stackQL-resources: + session_items: + id: databricks_workspace.agentkit.session_items + name: session_items + title: Session Items + methods: + append: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}~1items:append/post + response: + mediaType: application/json + openAPIDocKey: '200' + clear: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}~1items:clear/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}~1items/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.session_items + pop: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}~1items:pop/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/session_items/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + memories: + id: databricks_workspace.agentkit.memories + name: memories + title: Memories + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.managed_memory_entries + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries~1{managed_memory_entry_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries~1{managed_memory_entry_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries~1{managed_memory_entry_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + search: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1entries:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/memories/methods/get' + - $ref: '#/components/x-stackQL-resources/memories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/memories/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/memories/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/memories/methods/delete' + replace: [] + memory_stores: + id: databricks_workspace.agentkit.memory_stores + name: memory_stores + title: Memory Stores + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1agents~1memory-stores/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1agents~1memory-stores/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.managed_memory_stores + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/memory_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/memory_stores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/memory_stores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/memory_stores/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/memory_stores/methods/delete' + replace: [] + sessions: + id: databricks_workspace.agentkit.sessions + name: sessions + title: Sessions + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + extract_memories: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions~1{session_id}~1extractions/post + response: + mediaType: application/json + openAPIDocKey: '200' + fork: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1sessions:fork/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sessions/methods/get' + - $ref: '#/components/x-stackQL-resources/sessions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/sessions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/sessions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/sessions/methods/delete' + replace: [] + session_stores: + id: databricks_workspace.agentkit.session_stores + name: session_stores + title: Session Stores + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1agents~1session-stores/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1agents~1session-stores/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.session_stores + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/session_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/session_stores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/session_stores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/session_stores/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/session_stores/methods/delete' + replace: [] + memory_store_self_permission: + id: databricks_workspace.agentkit.memory_store_self_permission + name: memory_store_self_permission + title: Memory Store Self Permission + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1permissions~1self/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/memory_store_self_permission/methods/get + insert: [] + update: [] + delete: [] + replace: [] + session_store_self_permission: + id: databricks_workspace.agentkit.session_store_self_permission + name: session_store_self_permission + title: Session Store Self Permission + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1permissions~1self/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/session_store_self_permission/methods/get + insert: [] + update: [] + delete: [] + replace: [] + memory_store_permissions: + id: databricks_workspace.agentkit.memory_store_permissions + name: memory_store_permissions + title: Memory Store Permissions + methods: + grant: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1permissions:grant/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.memory_store_permissions + revoke: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1memory-stores~1{managed_memory_store_id}~1permissions:revoke/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/memory_store_permissions/methods/list + insert: [] + update: [] + delete: [] + replace: [] + session_store_permissions: + id: databricks_workspace.agentkit.session_store_permissions + name: session_store_permissions + title: Session Store Permissions + methods: + grant: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1permissions:grant/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.session_store_permissions + revoke: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1agents~1session-stores~1{session_store_id}~1permissions:revoke/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/session_store_permissions/methods/list + insert: [] + update: [] + delete: [] + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/aifunctions.yaml b/providers/src/databricks_workspace/v00.00.00000/services/aifunctions.yaml new file mode 100644 index 00000000..4906ce9b --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/aifunctions.yaml @@ -0,0 +1,881 @@ +openapi: 3.0.0 +info: + title: Databricks Aifunctions API (workspace) + description: >- + OpenAPI specification for the Databricks aifunctions service + (workspace-level APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.aifunctions +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/2.0/ai-functions/ai-classify: + post: + operationId: ai_functions_ai_classify + summary: >- + Classifies content according to a set of provided labels. For REST API + requests, the default rate + tags: + - aifunctions + - ai_functions + description: >- + Classifies content according to a set of provided labels. For REST API + requests, the default rate + + limit is 1,200 requests per minute per workspace. Contact your + Databricks account team to request a + + higher limit. + + + :param content: any + The content to classify. It accepts a plain string or the response object of + [ai_parse_document](:method:AiFunctions/AiParseDocument). + :param labels: any + The label set to classify as. Either a JSON array of label strings (e.g. ["spam", "not_spam"]), or a + JSON object mapping each label to a description (e.g. {"spam": "unsolicited bulk message", + "not_spam": "a legitimate message"}). Accepts 2 to 500 labels, each 1 to 100 characters. + :param options: :class:`AiClassifyOptions` (optional) + Function options. Omitted fields fall back to their documented defaults. + + :returns: :class:`AiClassifyResponse` + requestBody: + content: + application/json: + schema: + type: object + properties: + content: + type: object + description: >- + The content to classify. It accepts a plain string or the + response object of + [ai_parse_document](:method:AiFunctions/AiParseDocument). + labels: + type: object + description: >- + The label set to classify as. Either a JSON array of label + strings (e.g. ["spam", "not_spam"]), or a JSON object + mapping each label to a description (e.g. {"spam": + "unsolicited bulk message", "not_spam": "a legitimate + message"}). Accepts 2 to 500 labels, each 1 to 100 + characters. + options: + type: object + properties: + enable_confidence_scores: + type: boolean + description: >- + When true, includes a per-label confidence score in the + response. + enable_rationales: + type: boolean + description: >- + When true, includes a rationale explaining each + classification in the response. + instructions: + type: string + description: >- + Natural-language guidance that steers how the text is + classified (up to 20,000 characters). + multilabel: + type: boolean + description: >- + When true, allows more than one label to be returned per + input. + version: + type: string + description: >- + The function version to invoke. Defaults to the latest + version. Supported versions: ["2.1"]. + description: >- + Function options. Omitted fields fall back to their + documented defaults. + required: + - content + - labels + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AiClassifyResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiFunctionsAPI + /api/2.0/ai-functions/ai-decide: + post: + operationId: ai_functions_ai_decide + summary: >- + Turn text and structured data into decisions your application can use. + Define questions and criteria + tags: + - aifunctions + - ai_functions + description: >- + Turn text and structured data into decisions your application can use. + Define questions and criteria + + to choose an option, estimate a probability, or assign a score given a + provided state. + + + :param state: any + A string, JSON object, or array containing the content, related context, and examples needed to + answer the provided questions. For example, provide a support message, a conversation, or records + describing the current state of an application. All questions receive this same state. + :param questions: any + A JSON object mapping question IDs to their definitions. Each ID must contain non-whitespace text; + its answer is returned with the same ID in ``response.answers``. + + Each definition is an object with the required fields ``type`` and ``instructions``. The + ``criteria`` field is optional for the type ``noul`` but is required for the types ``choice`` and + ``score``. + + The ``instructions`` field describes the judgment to make and can be a string, object, or array. Use + an object or array to include supporting context alongside the instructions. + + The ``type`` can be one of: + + - ``choice``: Selects one option from a defined set. Requires ``criteria`` to be an object mapping 1 + to 255 nonempty option names to descriptions. The criteria description can be a string, object, + array, or null when the name needs no additional detail. For example: + + .. code-block:: json + + { + "team": { + "type": "choice", + "instructions": "Which team should handle this ticket?", + "criteria": { + "billing": "Payments, charges, and refunds", + "technical_support": null + } + } + } + + - ``noul``: Estimates the probability that the answer to a true-or-false question is true. + ``criteria`` can take the fields ``true`` or ``false``, or both, with descriptions that are + strings, objects, or arrays. Omit ``criteria`` to use the question alone. The instructions or at + least one criteria description must contain non-whitespace text, a nonempty object, or a nonempty + array. For example, both of the following are valid: + + .. code-block:: json + + { + "escalate": { + "type": "noul", + "instructions": "Does this ticket need escalation?", + "criteria": { + "true": "Suspected fraud or an exception to standard policy", + "false": "A routine issue frontline support can resolve" + } + } + } + + or + + .. code-block:: json + + { + "escalate": { + "type": "noul", + "instructions": "Does this ticket need escalation?" + } + } + + - ``score``: Rates the state on an ordered scale. Requires ``criteria`` to be an array of 2 to 10 + level descriptions, ordered from low to high. Descriptions must contain non-whitespace text, a + nonempty object, or a nonempty array. Array positions define levels starting at 0. For example: + + .. code-block:: json + + { + "urgency": { + "type": "score", + "instructions": "How urgent is this ticket?", + "criteria": [ + "Routine: can wait a few days", + "Time-sensitive: needs attention today", + "Critical: needs immediate action" + ] + } + } + :param options: :class:`AiDecideOptions` (optional) + Function options. Omitted fields fall back to their documented defaults. + + :returns: :class:`AiDecideResponse` + requestBody: + content: + application/json: + schema: + type: object + properties: + state: + type: object + description: >- + A string, JSON object, or array containing the content, + related context, and examples needed to answer the provided + questions. For example, provide a support message, a + conversation, or records describing the current state of an + application. All questions receive this same state. + questions: + type: object + description: >- + A JSON object mapping question IDs to their definitions. + Each ID must contain non-whitespace text; its answer is + returned with the same ID in ``response.answers``. Each + definition is an object with the required fields ``type`` + and ``instructions``. The ``criteria`` field is optional for + the type ``noul`` but is required for the types ``choice`` + and ``score``. The ``instructions`` field describes the + judgment to make and can be a string, object, or array. Use + an object or array to include supporting context alongside + the instructions. The ``type`` can be one of: - ``choice``: + Selects one option from a defined set. Requires ``criteria`` + to be an object mapping 1 to 255 nonempty option names to + descriptions. The criteria description can be a string, + object, array, or null when the name needs no additional + detail. For example: .. code-block:: json { "team": { + "type": "choice", "instructions": "Which team should handle + this ticket?", "criteria": { "billing": "Payments, charges, + and refunds", "technical_support": null } } } - ``noul``: + Estimates the probability that the answer to a true-or-false + question is true. ``criteria`` can take the fields ``true`` + or ``false``, or both, with descriptions that are strings, + objects, or arrays. Omit ``criteria`` to use the question + alone. The instructions or at least one criteria description + must contain non-whitespace text, a nonempty object, or a + nonempty array. For example, both of the following are + valid: .. code-block:: json { "escalate": { "type": "noul", + "instructions": "Does this ticket need escalation?", + "criteria": { "true": "Suspected fraud or an exception to + standard policy", "false": "A routine issue frontline + support can resolve" } } } or .. code-block:: json { + "escalate": { "type": "noul", "instructions": "Does this + ticket need escalation?" } } - ``score``: Rates the state on + an ordered scale. Requires ``criteria`` to be an array of 2 + to 10 level descriptions, ordered from low to high. + Descriptions must contain non-whitespace text, a nonempty + object, or a nonempty array. Array positions define levels + starting at 0. For example: .. code-block:: json { + "urgency": { "type": "score", "instructions": "How urgent is + this ticket?", "criteria": [ "Routine: can wait a few days", + "Time-sensitive: needs attention today", "Critical: needs + immediate action" ] } } + options: + type: object + properties: + version: + type: string + description: >- + The function API version to invoke. Defaults to "1.0". + Supported versions: ["1.0"]. + description: >- + Function options. Omitted fields fall back to their + documented defaults. + required: + - state + - questions + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AiDecideResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiFunctionsAPI + /api/2.0/ai-functions/ai-extract: + post: + operationId: ai_functions_ai_extract + summary: >- + Extracts structured data from text and documents according to a provided + schema. For REST API + tags: + - aifunctions + - ai_functions + description: >- + Extracts structured data from text and documents according to a provided + schema. For REST API + + requests, the default rate limit is 120 requests per minute per + workspace. Contact your Databricks + + account team to request a higher limit. + + + :param content: any + The text to extract from. It accepts a plain string or the response object of + [ai_parse_document](:method:AiFunctions/AiParseDocument). + :param schema: any + 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. + :param options: :class:`AiExtractOptions` (optional) + Function options. Omitted fields fall back to their documented defaults. + + :returns: :class:`AiExtractResponse` + requestBody: + content: + application/json: + schema: + type: object + properties: + content: + type: object + description: >- + The text to extract from. It accepts a plain string or the + response object of + [ai_parse_document](:method:AiFunctions/AiParseDocument). + schema: + type: object + 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. + options: + type: object + properties: + enable_citations: + type: boolean + description: >- + When true, includes citation metadata locating each + extracted value in the source. Depending on the type of + input, citations can be one of two types: For raw text + (STRING) inputs, a citation is a span of text in the + original input. Each object in ``metadata.citations`` + has an ``id`` (integer matching a ``citation_ids`` entry + on a field), a ``start`` (inclusive 0-based character + offset into the input string), and a ``stop`` (exclusive + 0-based character offset into the input string). For PDF + documents and images (when using ai_extract downstream + of ai_parse_document), a citation is a bounding box in + the original input. Each object in + ``metadata.citations`` has an ``id`` (integer matching a + ``citation_ids`` entry on a field) and a ``bbox`` (array + of {coord, page_id} objects, identical in shape to + element.bbox in ai_parse_document output; coord is pixel + coordinates on the page image as [x0, y0, x1, y1], and + page_id is a 0-based page index). + enable_confidence_scores: + type: boolean + description: >- + When true, includes a per-field confidence score in the + response. + instructions: + type: string + description: >- + Natural-language guidance that steers how data is + extracted (up to 20,000 characters). + mode: + type: string + description: >- + Extraction mode. Supported modes: "precision" — more + powerful extraction for complex schemas, long documents, + and reasoning-heavy extractions. Defaults to none + (standard extraction). + version: + type: string + description: >- + The function version to invoke. Defaults to the latest + version. Supported versions: ["2.1"]. + description: >- + Function options. Omitted fields fall back to their + documented defaults. + required: + - content + - schema + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AiExtractResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiFunctionsAPI + /api/2.0/ai-functions/ai-parse-document: + post: + operationId: ai_functions_ai_parse_document + summary: Parse structured content from unstructured documents. + tags: + - aifunctions + - ai_functions + description: |- + Parse structured content from unstructured documents. + + :param content: str + The document to parse. The REST API accepts a Unity Catalog volume path to the source file or a + base64 data URL containing the file bytes (for example, + data:application/pdf;base64, or data:image/jpeg;base64,). + Supported formats: PDF, DOCX, DOC, PPTX, PPT, JPG, JPEG, PNG, TIFF. Accepts up to 100 pages and 100 + MB per document. + :param options: :class:`AiParseDocumentOptions` (optional) + Function options. Omitted fields fall back to their documented defaults. + + :returns: :class:`AiParseDocumentResponse` + requestBody: + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The document to parse. The REST API accepts a Unity Catalog + volume path to the source file or a base64 data URL + containing the file bytes (for example, + data:application/pdf;base64, or + data:image/jpeg;base64,). Supported + formats: PDF, DOCX, DOC, PPTX, PPT, JPG, JPEG, PNG, TIFF. + Accepts up to 100 pages and 100 MB per document. + options: + type: object + properties: + description_element_types: + type: string + description: >- + Element types for which an AI-generated description is + produced. Use "*" (default) to generate descriptions for + all supported element types, "figure" to generate them + for figures only, or "" (empty string) to generate none. + Only figure descriptions are supported for version + "2.0", so "*" and "figure" produce the same behavior. + image_output_path: + type: string + description: >- + Unity Catalog volume path where rendered page and + element images are written. + page_range: + type: string + description: >- + Pages to parse (1-indexed), as a comma-separated list of + page numbers or ranges (e.g. "1,3,5-10"). + version: + type: string + description: >- + The ai_parse_document output schema version. Supported + value: "2.0". + description: >- + Function options. Omitted fields fall back to their + documented defaults. + required: + - content + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AiParseDocumentResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiFunctionsAPI +components: + schemas: + AiClassifyOptions: + type: object + properties: + enable_confidence_scores: + type: boolean + description: When true, includes a per-label confidence score in the response. + enable_rationales: + type: boolean + description: >- + When true, includes a rationale explaining each classification in + the response. + instructions: + type: string + description: >- + Natural-language guidance that steers how the text is classified (up + to 20,000 characters). + multilabel: + type: boolean + description: When true, allows more than one label to be returned per input. + version: + type: string + description: >- + The function version to invoke. Defaults to the latest version. + Supported versions: ["2.1"]. + description: ai_classify + AiClassifyResponse: + type: object + properties: + metadata: + $ref: '#/components/schemas/AiClassifyResponseMetadata' + response: + type: object + description: >- + The function result as a JSON value. An array of per-label objects: + one element in single-label mode (the default), or multiple elements + when ``multilabel`` is true. When ``enable_confidence_scores`` and + ``enable_rationales`` are true, ``confidence_score`` and + ``rationale`` are included in each response value, respectively. + AiClassifyResponseMetadata: + type: object + properties: + version: + type: string + AiDecideOptions: + type: object + properties: + version: + type: string + description: >- + The function API version to invoke. Defaults to "1.0". Supported + versions: ["1.0"]. + description: ai_decide + AiDecideResponse: + type: object + properties: + metadata: + $ref: '#/components/schemas/AiDecideResponseMetadata' + response: + type: object + description: >- + A JSON object containing an ``answers`` map with one answer for each + question, keyed by the same IDs as ``questions``. Each answer has a + ``type`` matching its question and the following fields: - + ``choice``: choice is the highest-probability option from + ``criteria``. ``probabilities`` maps every option name to its + probability. ``confidence`` is a number from 0 to 1 indicating how + well the state supports the assessment. The ``probabilities`` values + sum to 1. For example: .. code-block:: json { "answers": { "team": { + "type": "choice", "choice": "billing", "probabilities": { "billing": + 0.85, "technical_support": 0.15 }, "confidence": 0.9 } } } - + ``noul``: ``probability`` is a number from 0 to 1 estimating the + probability that the answer is true. For example: .. code-block:: + json { "answers": { "escalate": { "type": "noul", "probability": 0.8 + } } } - ``score``: score is the probability-weighted mean of the + zero-based level indices. It can fall between levels, from 0 to the + number of levels minus 1. ``probabilities`` maps each level index to + its probability, and ``legend`` maps each index to its original + description. Both maps use string keys such as "0", "1", and "2". + ``confidence`` is a number from 0 to 1 indicating how well the state + supports the assessment. The ``probabilities`` values sum to 1. For + example: .. code-block:: json { "answers": { "urgency": { "type": + "score", "score": 1.6, "probabilities": { "0": 0.1, "1": 0.2, "2": + 0.7 }, "legend": { "0": "Routine: can wait a few days", "1": + "Time-sensitive: needs attention today", "2": "Critical: needs + immediate action" }, "confidence": 0.85 } } } + AiDecideResponseMetadata: + type: object + properties: + version: + type: string + AiExtractBbox: + type: object + properties: + coord: + type: array + items: + type: integer + description: Pixel coordinates on the page image as [x0, y0, x1, y1]. + page_id: + type: integer + description: 0-based page index the box is on. + description: A bounding box on a source page; used by bbox-input citations. + AiExtractCitation: + type: object + properties: + bbox: + type: array + items: + $ref: '#/components/schemas/AiExtractBbox' + description: >- + Bounding boxes locating the citation on the source pages; set for + bbox citations. + id: + type: integer + description: Integer matching a citation_ids entry on an extracted field. + start: + type: integer + description: >- + Inclusive 0-based character offset into the input string; set for + span citations. + stop: + type: integer + description: >- + Exclusive 0-based character offset into the input string; set for + span citations. + description: >- + A citation locating an extracted value in the source. start/stop are set + for span (STRING input) + citations, bbox for bbox (parsed-document input) citations. + AiExtractOptions: + type: object + properties: + enable_citations: + type: boolean + description: >- + When true, includes citation metadata locating each extracted value + in the source. Depending on the type of input, citations can be one + of two types: For raw text (STRING) inputs, a citation is a span of + text in the original input. Each object in ``metadata.citations`` + has an ``id`` (integer matching a ``citation_ids`` entry on a + field), a ``start`` (inclusive 0-based character offset into the + input string), and a ``stop`` (exclusive 0-based character offset + into the input string). For PDF documents and images (when using + ai_extract downstream of ai_parse_document), a citation is a + bounding box in the original input. Each object in + ``metadata.citations`` has an ``id`` (integer matching a + ``citation_ids`` entry on a field) and a ``bbox`` (array of {coord, + page_id} objects, identical in shape to element.bbox in + ai_parse_document output; coord is pixel coordinates on the page + image as [x0, y0, x1, y1], and page_id is a 0-based page index). + enable_confidence_scores: + type: boolean + description: When true, includes a per-field confidence score in the response. + instructions: + type: string + description: >- + Natural-language guidance that steers how data is extracted (up to + 20,000 characters). + mode: + type: string + description: >- + Extraction mode. Supported modes: "precision" — more powerful + extraction for complex schemas, long documents, and reasoning-heavy + extractions. Defaults to none (standard extraction). + version: + type: string + description: >- + The function version to invoke. Defaults to the latest version. + Supported versions: ["2.1"]. + description: ai_extract + AiExtractResponse: + type: object + properties: + metadata: + $ref: '#/components/schemas/AiExtractResponseMetadata' + response: + type: object + description: >- + The function result as a JSON value. When + ``enable_confidence_scores`` and ``enable_citations`` are true, + ``confidence`` and ``citation_ids`` are included in each response + field, respectively. + AiExtractResponseMetadata: + type: object + properties: + chunk_type: + type: string + citations: + type: array + items: + $ref: '#/components/schemas/AiExtractCitation' + description: >- + Citation objects locating each result in the source; present when + citations are enabled. + mode: + type: string + description: >- + The resolved extraction mode; present when a non-default mode was + used. + version: + type: string + description: The resolved function version. + AiParseDocumentFileMetadata: + type: object + properties: + file_modification_time: + type: string + description: Last-modified timestamp of the source file, as an HTTP date string. + file_name: + type: string + description: Base name of the source file. + file_path: + type: string + description: Unity Catalog volume path of the source file. + file_size: + type: integer + description: Size of the source file in bytes. + description: Metadata about the source file; present only for file-path input. + AiParseDocumentOptions: + type: object + properties: + description_element_types: + type: string + description: >- + Element types for which an AI-generated description is produced. Use + "*" (default) to generate descriptions for all supported element + types, "figure" to generate them for figures only, or "" (empty + string) to generate none. Only figure descriptions are supported for + version "2.0", so "*" and "figure" produce the same behavior. + image_output_path: + type: string + description: >- + Unity Catalog volume path where rendered page and element images are + written. + page_range: + type: string + description: >- + Pages to parse (1-indexed), as a comma-separated list of page + numbers or ranges (e.g. "1,3,5-10"). + version: + type: string + description: 'The ai_parse_document output schema version. Supported value: "2.0".' + description: ai_parse_document + AiParseDocumentPageError: + type: object + properties: + error_message: + type: string + description: Message describing why the page failed. + page_id: + type: integer + description: 0-based index of the page that failed. + description: A single page that failed to parse while the overall request succeeded. + AiParseDocumentResponse: + type: object + properties: + document: + type: object + error_status: + type: array + items: + $ref: '#/components/schemas/AiParseDocumentPageError' + description: >- + Per-page partial-failure details; present when the request succeeds + (2xx) but individual pages fail. + metadata: + $ref: '#/components/schemas/AiParseDocumentResponseMetadata' + description: Additional metadata returned by AI Parse Document. + AiParseDocumentResponseMetadata: + type: object + properties: + file_metadata: + $ref: '#/components/schemas/AiParseDocumentFileMetadata' + id: + type: string + description: Unique identifier for the parse request. + version: + type: string + description: The resolved function version. + x-stackQL-resources: + ai_functions: + id: databricks_workspace.aifunctions.ai_functions + name: ai_functions + title: Ai Functions + methods: + ai_classify: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1ai-functions~1ai-classify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + ai_decide: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1ai-functions~1ai-decide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + ai_extract: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1ai-functions~1ai-extract/post' + response: + mediaType: application/json + openAPIDocKey: '200' + ai_parse_document: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1ai-functions~1ai-parse-document/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/aisearch.yaml b/providers/src/databricks_workspace/v00.00.00000/services/aisearch.yaml index 78ec6005..0bd2f097 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/aisearch.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/aisearch.yaml @@ -6,16 +6,33 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.aisearch servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: - /api/2.0/ai-search/{parent}/endpoints: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints: post: operationId: ai_search_create_endpoint summary: Create a new AI Search endpoint. @@ -38,14 +55,15 @@ paths: :returns: :class:`Endpoint` parameters: - - name: parent + - name: workspace_id in: path required: true schema: type: string description: >- - The Workspace where this Endpoint will be created. Format: - ``workspaces/{workspace_id}`` + The `workspace_id` segment of the `parent` resource name + (`workspaces/{workspace_id}`). The Workspace where this Endpoint + will be created. Format: ``workspaces/{workspace_id}`` - name: endpoint_id in: query required: false @@ -64,213 +82,168 @@ paths: schema: type: object properties: - endpoint: + endpoint_type: + type: string + x-enum: + - STANDARD + - STORAGE_OPTIMIZED + description: >- + Type of endpoint. Required on create and immutable + thereafter. + budget_policy_id: + type: string + description: The user-selected budget policy id for the endpoint. + create_time: + type: string + format: date-time + description: Time the endpoint was created. + creator: + type: string + description: Creator of the endpoint + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + description: Key field for an AI Search endpoint tag. + value: + type: string + description: '[Optional] Value field for an AI Search endpoint tag.' + required: + - key + description: >- + User-defined key/value tag attached to an AI Search + endpoint for cost attribution and access + control. + description: The custom tags assigned to the endpoint + effective_budget_policy_id: + type: string + description: The budget policy id applied to the endpoint + endpoint_status: type: object properties: - endpoint_type: + message: type: string - x-enum: - - STANDARD - - STORAGE_OPTIMIZED description: >- - Type of endpoint. Required on create and immutable - thereafter. - budget_policy_id: - type: string - description: The user-selected budget policy id for the endpoint. - create_time: - type: string - format: date-time - description: Time the endpoint was created. - creator: - type: string - description: Creator of the endpoint - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - description: Key field for an AI Search endpoint tag. - value: - type: string - description: >- - [Optional] Value field for an AI Search endpoint - tag. - required: - - key - description: >- - User-defined key/value tag attached to an AI Search - endpoint for cost attribution and access - control. - description: The custom tags assigned to the endpoint - effective_budget_policy_id: - type: string - description: The budget policy id applied to the endpoint - endpoint_status: - type: object - properties: - message: - type: string - description: >- - Human-readable detail about the endpoint's current - state or the reason for a state transition. - state: - type: string - x-enum: - - DELETED - - OFFLINE - - ONLINE - - PROVISIONING - - RED_STATE - - YELLOW_STATE - description: >- - Current lifecycle state of the endpoint. See - ``State`` for the meaning of each value. - description: Current status of the endpoint - id: - type: string - description: Unique identifier of the endpoint - index_count: - type: integer - description: Number of indexes on the endpoint - last_updated_user: + Human-readable detail about the endpoint's current state + or the reason for a state transition. + state: type: string - description: User who last updated the endpoint - name: - type: string - description: >- - 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. - replica_count: - type: integer + x-enum: + - DELETED + - OFFLINE + - ONLINE + - PROVISIONING + - RED_STATE + - STARTING + - STOPPED + - STOPPING + - YELLOW_STATE description: >- - The client-supplied desired number of replicas for the - endpoint, applied at create/update time. Mutually - exclusive with ``target_qps``. - scaling_info: - type: object - properties: - requested_target_qps: - type: integer - description: >- - The requested QPS target for the endpoint. - Best-effort; the system does not guarantee this QPS - will be achieved. - state: - type: string - x-enum: - - SCALING_CHANGE_APPLIED - - SCALING_CHANGE_IN_PROGRESS - - SCALING_CHANGE_UNSPECIFIED - description: The current state of the scaling change request. - description: Scaling information for the endpoint - target_qps: + Current lifecycle state of the endpoint. See ``State`` + for the meaning of each value. + description: Current status of the endpoint + id: + type: string + description: Unique identifier of the endpoint + index_count: + type: integer + description: Number of indexes on the endpoint + last_updated_user: + type: string + description: User who last updated the endpoint + name: + type: string + description: >- + 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. + replica_count: + type: integer + description: >- + The client-supplied desired number of replicas for the + endpoint, applied at create/update time. Mutually exclusive + with ``target_qps``. + scaling_info: + type: object + properties: + requested_target_qps: type: integer description: >- - Target QPS for the endpoint. Mutually exclusive with - ``replica_count``. Best-effort; the system does not - guarantee this QPS will be achieved. - throughput_info: - type: object - properties: - change_request_message: - type: string - description: >- - Additional information about the throughput change - request - change_request_state: - type: string - x-enum: - - CHANGE_ADJUSTED - - CHANGE_FAILED - - CHANGE_IN_PROGRESS - - CHANGE_REACHED_MAXIMUM - - CHANGE_REACHED_MINIMUM - - CHANGE_SUCCESS - description: >- - The state of the most recent throughput change - request - current_concurrency: - type: number - description: >- - The current concurrency (total CPU) allocated to the - endpoint - current_concurrency_utilization_percentage: - type: number - description: >- - The current utilization of concurrency as a - percentage (0-100) - current_num_replicas: - type: integer - description: >- - The current number of replicas allocated to the - endpoint - maximum_concurrency_allowed: - type: number - description: The maximum concurrency allowed for this endpoint - minimal_concurrency_allowed: - type: number - description: The minimum concurrency allowed for this endpoint - requested_concurrency: - type: number - description: >- - The requested concurrency (total CPU) for the - endpoint - requested_num_replicas: - type: integer - description: The requested number of replicas for the endpoint - description: Throughput information for the endpoint - update_time: + The requested QPS target for the endpoint. Best-effort; + the system does not guarantee this QPS will be achieved. + state: type: string - format: date-time - description: Time the endpoint was last updated. - usage_policy_id: + x-enum: + - SCALING_CHANGE_APPLIED + - SCALING_CHANGE_IN_PROGRESS + - SCALING_CHANGE_UNSPECIFIED + description: The current state of the scaling change request. + description: Scaling information for the endpoint + target_qps: + type: integer + description: >- + Target QPS for the endpoint. Mutually exclusive with + ``replica_count``. Best-effort; the system does not + guarantee this QPS will be achieved. + throughput_info: + type: object + properties: + change_request_message: type: string - description: The usage policy id applied to the endpoint. - warnings: - type: array - items: - type: object - properties: - index_names: - type: array - items: - type: string - description: Indexes affected by this warning. - message: - type: string - description: Human-readable detail about the warning. - status_code: - type: string - x-enum: - - ENDPOINT_HAS_INDEX_WITHOUT_OPTIMIZED_ROUTE - - ENDPOINT_HAS_MANAGED_INDEX - - RERANKER_TEMPORARILY_UNAVAILABLE - description: Status code categorizing the warning. - description: >- - Advisory warning surfaced on an AI Search endpoint — a - non-fatal condition the customer should - be aware of (for example, a temporarily unavailable reranker or an index without an optimized - query route). description: >- - Advisory warnings surfaced when target_qps is set on a - Standard endpoint. - required: - - endpoint_type - description: >- - The Endpoint resource to create. Fields other than - ``endpoint.name`` carry the desired configuration; - ``endpoint.name`` is server-assigned from ``parent`` and - ``endpoint_id``. + Additional information about the throughput change + request + change_request_state: + type: string + x-enum: + - CHANGE_ADJUSTED + - CHANGE_FAILED + - CHANGE_IN_PROGRESS + - CHANGE_REACHED_MAXIMUM + - CHANGE_REACHED_MINIMUM + - CHANGE_SUCCESS + description: The state of the most recent throughput change request + current_concurrency: + type: number + description: >- + The current concurrency (total CPU) allocated to the + endpoint + current_concurrency_utilization_percentage: + type: number + description: >- + The current utilization of concurrency as a percentage + (0-100) + current_num_replicas: + type: integer + description: The current number of replicas allocated to the endpoint + maximum_concurrency_allowed: + type: number + description: The maximum concurrency allowed for this endpoint + minimal_concurrency_allowed: + type: number + description: The minimum concurrency allowed for this endpoint + requested_concurrency: + type: number + description: The requested concurrency (total CPU) for the endpoint + requested_num_replicas: + type: integer + description: The requested number of replicas for the endpoint + description: Throughput information for the endpoint + update_time: + type: string + format: date-time + description: Time the endpoint was last updated. + usage_policy_id: + type: string + description: The usage policy id applied to the endpoint. required: - - endpoint + - endpoint_type responses: '200': description: Success @@ -310,14 +283,15 @@ paths: :returns: Iterator over :class:`Endpoint` parameters: - - name: parent + - name: workspace_id in: path required: true schema: type: string description: >- - The Workspace that owns this collection of endpoints. Format: - ``workspaces/{workspace_id}`` + The `workspace_id` segment of the `parent` resource name + (`workspaces/{workspace_id}`). The Workspace that owns this + collection of endpoints. Format: ``workspaces/{workspace_id}`` - name: page_size in: query required: false @@ -355,7 +329,7 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{parent}/indexes: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes: post: operationId: ai_search_create_index summary: Create a new AI Search index. @@ -379,13 +353,25 @@ paths: :returns: :class:`Index` parameters: - - name: parent + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `parent` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). The Endpoint + where this Index will be created. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` + - name: endpoint_id in: path required: true schema: type: string description: >- - The Endpoint where this Index will be created. Format: + The `endpoint_id` segment of the `parent` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). The Endpoint + where this Index will be created. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` - name: index_id in: query @@ -405,219 +391,190 @@ paths: schema: type: object properties: - index: + primary_key: + type: string + description: >- + Primary key of the index. Set on create and immutable + thereafter. + index_type: + type: string + x-enum: + - DELTA_SYNC + - DIRECT_ACCESS + description: Type of index. Required on create and immutable thereafter. + creator: + type: string + description: Creator of the index. + delta_sync_index_spec: type: object properties: - primary_key: - type: string - description: >- - Primary key of the index. Set on create and immutable - thereafter. - index_type: + pipeline_type: type: string x-enum: - - DELTA_SYNC - - DIRECT_ACCESS + - CONTINUOUS + - TRIGGERED description: >- - Type of index. Required on create and immutable - thereafter. - creator: - type: string - description: Creator of the index. - delta_sync_index_spec: - type: object - properties: - pipeline_type: - type: string - x-enum: - - CONTINUOUS - - TRIGGERED - description: >- - Pipeline execution mode. Required on create — the - backend rejects an unset value. Storage Optimized - endpoints accept only ``TRIGGERED``; Standard - endpoints accept both. No explicit ``stage`` — a - REQUIRED field staged below its service would be - dropped from combined specs while remaining in - ``required``, tripping the OpenAPI - required-vs-properties consistency check. The field - inherits the service's launch stage. - columns_to_sync: - type: array - items: + Pipeline execution mode. Required on create — the + backend rejects an unset value. Storage Optimized + endpoints accept only ``TRIGGERED``; Standard endpoints + accept both. No explicit ``stage`` — a REQUIRED field + staged below its service would be dropped from combined + specs while remaining in ``required``, tripping the + OpenAPI required-vs-properties consistency check. The + field inherits the service's launch stage. + columns_to_sync: + type: array + items: + type: string + description: >- + [Optional] Select the columns to sync with the index. If + left blank, all columns from the source table are + synced. The primary key column and embedding source or + vector column are always synced. + embedding_source_columns: + type: array + items: + type: object + properties: + embedding_model_endpoint: type: string - description: >- - [Optional] Select the columns to sync with the - index. If left blank, all columns from the source - table are synced. The primary key column and - embedding source or vector column are always synced. - embedding_source_columns: - type: array - items: - type: object - properties: - embedding_model_endpoint: - type: string - description: >- - Name of the embedding model endpoint, used by - default for both ingestion and querying. - model_endpoint_name_for_query: - type: string - description: >- - Name of the embedding model endpoint which, if - specified, is used for querying (not - ingestion). - name: - type: string - description: Name of the source column. description: >- - Name of an embedding source column and its - associated embedding model endpoint. - description: The columns that contain the embedding source. - embedding_vector_columns: - type: array - items: - type: object - properties: - embedding_dimension: - type: integer - description: Dimension of the embedding vector. - name: - type: string - description: Name of the column. - description: Name and dimension of an embedding vector column. - description: The columns that contain the embedding vectors. - embedding_writeback_table: - type: string - description: >- - [Optional] Name of the Delta table to sync the index - contents and computed embeddings to. - pipeline_id: - type: string - description: >- - The ID of the pipeline that is used to sync the - index. - source_table: - type: string - description: The full name of the source Delta table. - required: - - pipeline_type - description: >- - Specification for a Delta Sync index. Set when - ``index_type`` is ``DELTA_SYNC``. - direct_access_index_spec: - type: object - properties: - embedding_source_columns: - type: array - items: - type: object - properties: - embedding_model_endpoint: - type: string - description: >- - Name of the embedding model endpoint, used by - default for both ingestion and querying. - model_endpoint_name_for_query: - type: string - description: >- - Name of the embedding model endpoint which, if - specified, is used for querying (not - ingestion). - name: - type: string - description: Name of the source column. + Name of the embedding model endpoint, used by + default for both ingestion and querying. + model_endpoint_name_for_query: + type: string description: >- - Name of an embedding source column and its - associated embedding model endpoint. - description: The columns that contain the embedding source. - embedding_vector_columns: - type: array - items: - type: object - properties: - embedding_dimension: - type: integer - description: Dimension of the embedding vector. - name: - type: string - description: Name of the column. - description: Name and dimension of an embedding vector column. - description: The columns that contain the embedding vectors. - requested_schema_json: - type: string - description: >- - The index schema exactly as the user supplied it on - create, preserving the original type spellings (e.g. - ``integer``) rather than Unity Catalog's canonical - names (e.g. ``int``) that ``schema_json`` returns. - schema_json: - type: string - description: >- - The schema of the index in JSON format. Supported - types are ``integer``, ``long``, ``float``, - ``double``, ``boolean``, ``string``, ``date``, - ``timestamp``. Supported types for vector columns: - ``array``, ``array``. - description: >- - Specification for a Direct Access index. Set when - ``index_type`` is ``DIRECT_ACCESS``. - endpoint: + Name of the embedding model endpoint which, if + specified, is used for querying (not ingestion). + name: + type: string + description: Name of the source column. + description: >- + Name of an embedding source column and its associated + embedding model endpoint. + description: The columns that contain the embedding source. + embedding_vector_columns: + type: array + items: + type: object + properties: + embedding_dimension: + type: integer + description: Dimension of the embedding vector. + name: + type: string + description: Name of the column. + description: Name and dimension of an embedding vector column. + description: The columns that contain the embedding vectors. + embedding_writeback_table: type: string description: >- - Name of the endpoint associated with the index. Ignored - on create — the endpoint is taken from - ``CreateIndexRequest.parent``; populated only on output. - index_subtype: + [Optional] Name of the Delta table to sync the index + contents and computed embeddings to. + pipeline_id: type: string - x-enum: - - FULL_TEXT - - HYBRID - - VECTOR - description: >- - The subtype of the index. Set on create and immutable - thereafter. - name: + description: The ID of the pipeline that is used to sync the index. + source_table: type: string - description: >- - Name of the AI Search index. Server-assigned full - resource path - (``workspaces/{workspace}/endpoints/{endpoint}/indexes/{index}``) - on output, where ``{index}`` is the index's Unity - Catalog table name. On create, the user-supplied UC - table name is conveyed via - ``CreateIndexRequest.index_id``; the server composes the - full ``name`` and returns it on the response. - status: - type: object - properties: - index_url: - type: string - description: >- - Index API URL used to perform operations on the - index. - indexed_row_count: - type: integer - description: Number of rows indexed. - message: - type: string - description: >- - Human-readable detail about the index's current - state. - ready: - type: boolean - description: Whether the index is ready for search. - description: Current status of the index. + description: The full name of the source Delta table. required: - - primary_key - - index_type + - pipeline_type + description: >- + Specification for a Delta Sync index. Set when + ``index_type`` is ``DELTA_SYNC``. + direct_access_index_spec: + type: object + properties: + embedding_source_columns: + type: array + items: + type: object + properties: + embedding_model_endpoint: + type: string + description: >- + Name of the embedding model endpoint, used by + default for both ingestion and querying. + model_endpoint_name_for_query: + type: string + description: >- + Name of the embedding model endpoint which, if + specified, is used for querying (not ingestion). + name: + type: string + description: Name of the source column. + description: >- + Name of an embedding source column and its associated + embedding model endpoint. + description: The columns that contain the embedding source. + embedding_vector_columns: + type: array + items: + type: object + properties: + embedding_dimension: + type: integer + description: Dimension of the embedding vector. + name: + type: string + description: Name of the column. + description: Name and dimension of an embedding vector column. + description: The columns that contain the embedding vectors. + schema_json: + type: string + description: >- + The schema of the index in JSON format. Supported types + are ``integer``, ``long``, ``float``, ``double``, + ``boolean``, ``string``, ``date``, ``timestamp``. + Supported types for vector columns: ``array``, + ``array``. + description: >- + Specification for a Direct Access index. Set when + ``index_type`` is ``DIRECT_ACCESS``. + endpoint: + type: string description: >- - The Index resource to create. Fields other than - ``index.name`` carry the desired configuration; - ``index.name`` is server-assigned from ``parent`` and - ``index_id``. + Name of the endpoint associated with the index. Ignored on + create — the endpoint is taken from + ``CreateIndexRequest.parent``; populated only on output. + index_subtype: + type: string + x-enum: + - FULL_TEXT + - HYBRID + - VECTOR + description: >- + The subtype of the index. Set on create and immutable + thereafter. + name: + type: string + description: >- + Name of the AI Search index. Server-assigned full resource + path + (``workspaces/{workspace}/endpoints/{endpoint}/indexes/{index}``) + on output, where ``{index}`` is the index's Unity Catalog + table name. On create, the user-supplied UC table name is + conveyed via ``CreateIndexRequest.index_id``; the server + composes the full ``name`` and returns it on the response. + status: + type: object + properties: + index_url: + type: string + description: Index API URL used to perform operations on the index. + indexed_row_count: + type: integer + description: Number of rows indexed. + message: + type: string + description: Human-readable detail about the index's current state. + ready: + type: boolean + description: Whether the index is ready for search. + description: Current status of the index. required: - - index + - primary_key + - index_type responses: '200': description: Success @@ -649,11 +606,6 @@ paths: :param parent: str The Endpoint that owns this collection of indexes. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` - :param debug_level: int (optional) - Opt-in debug level. When set to 1 or higher, the backend computes per-index routing eligibility and - populates ``can_use_optimized_route`` on each returned index. When unset (0), that field is left - unpopulated and the eligibility computation is skipped. Matches the ``debug_level`` convention on - the query path. :param page_size: int (optional) Best-effort upper bound on the number of results to return. Honored as an upper bound by the shim: ``page_size`` only narrows the legacy backend's response, never widens it, so the practical cap is @@ -663,25 +615,26 @@ paths: :returns: Iterator over :class:`Index` parameters: - - name: parent + - name: workspace_id in: path required: true schema: type: string description: >- - The Endpoint that owns this collection of indexes. Format: + The `workspace_id` segment of the `parent` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). The Endpoint + that owns this collection of indexes. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` - - name: debug_level - in: query - required: false + - name: endpoint_id + in: path + required: true schema: - type: integer + type: string description: >- - Opt-in debug level. When set to 1 or higher, the backend computes - per-index routing eligibility and populates - ``can_use_optimized_route`` on each returned index. When unset (0), - that field is left unpopulated and the eligibility computation is - skipped. Matches the ``debug_level`` convention on the query path. + The `endpoint_id` segment of the `parent` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). The Endpoint + that owns this collection of indexes. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` - name: page_size in: query required: false @@ -719,28 +672,40 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}: delete: - operationId: ai_search_delete_index - summary: Delete an AI Search index. + operationId: ai_search_delete_endpoint + summary: Delete an AI Search endpoint. tags: - aisearch - ai_search description: |- - Delete an AI Search index. + Delete an AI Search endpoint. :param name: str - Full resource name of the index to delete. Format: - ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + Full resource name of the endpoint to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` parameters: - - name: name + - name: workspace_id in: path required: true schema: type: string description: >- - Full resource name of the index to delete. Format: - ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). Full resource + name of the endpoint to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). Full resource + name of the endpoint to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` responses: '200': description: Success @@ -757,35 +722,46 @@ paths: type: string x-stackql-sdk-source: AiSearchAPI get: - operationId: ai_search_get_index - summary: Get details for a single AI Search index. + operationId: ai_search_get_endpoint + summary: Get details for a single AI Search endpoint. tags: - aisearch - ai_search description: |- - Get details for a single AI Search index. + Get details for a single AI Search endpoint. :param name: str - Full resource name of the index. Format: - ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + Full resource name of the endpoint. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` - :returns: :class:`Index` + :returns: :class:`Endpoint` parameters: - - name: name + - name: workspace_id in: path required: true schema: type: string description: >- - Full resource name of the index. Format: - ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). Full resource + name of the endpoint. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}`). Full resource + name of the endpoint. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}`` responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Index' + $ref: '#/components/schemas/Endpoint' default: description: Error response content: @@ -798,274 +774,117 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - patch: - operationId: ai_search_update_endpoint - summary: >- - Update an existing AI Search endpoint. Multi-bucket masks are supported - and dispatched in + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}: + delete: + operationId: ai_search_delete_index + summary: Delete an AI Search index. tags: - aisearch - ai_search - description: >- - Update an existing AI Search endpoint. Multi-bucket masks are supported - and dispatched in - - deterministic bucket order: budget policy, custom tags, throughput, then - scaling/replicas. Per-bucket - - dispatch is not atomic across buckets — if a later bucket fails, earlier - buckets may already have - - been applied. - + description: |- + Delete an AI Search index. :param name: str - 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. - :param endpoint: :class:`Endpoint` - The Endpoint resource to update. ``endpoint.name`` carries the full resource path. - :param update_mask: FieldMask - The list of fields to update. - - :returns: :class:`Endpoint` + Full resource name of the index to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` parameters: - - name: name + - name: workspace_id in: path required: true schema: type: string description: >- - 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. - - name: update_mask - in: query + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path required: true schema: - type: object - description: The list of fields to update. - requestBody: - content: - application/json: - schema: - type: object - properties: - endpoint: - type: object - properties: - endpoint_type: - type: string - x-enum: - - STANDARD - - STORAGE_OPTIMIZED - description: >- - Type of endpoint. Required on create and immutable - thereafter. - budget_policy_id: - type: string - description: The user-selected budget policy id for the endpoint. - create_time: - type: string - format: date-time - description: Time the endpoint was created. - creator: - type: string - description: Creator of the endpoint - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - description: Key field for an AI Search endpoint tag. - value: - type: string - description: >- - [Optional] Value field for an AI Search endpoint - tag. - required: - - key - description: >- - User-defined key/value tag attached to an AI Search - endpoint for cost attribution and access - control. - description: The custom tags assigned to the endpoint - effective_budget_policy_id: - type: string - description: The budget policy id applied to the endpoint - endpoint_status: - type: object - properties: - message: - type: string - description: >- - Human-readable detail about the endpoint's current - state or the reason for a state transition. - state: - type: string - x-enum: - - DELETED - - OFFLINE - - ONLINE - - PROVISIONING - - RED_STATE - - YELLOW_STATE - description: >- - Current lifecycle state of the endpoint. See - ``State`` for the meaning of each value. - description: Current status of the endpoint - id: - type: string - description: Unique identifier of the endpoint - index_count: - type: integer - description: Number of indexes on the endpoint - last_updated_user: - type: string - description: User who last updated the endpoint - name: - type: string - description: >- - 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. - replica_count: - type: integer - description: >- - The client-supplied desired number of replicas for the - endpoint, applied at create/update time. Mutually - exclusive with ``target_qps``. - scaling_info: - type: object - properties: - requested_target_qps: - type: integer - description: >- - The requested QPS target for the endpoint. - Best-effort; the system does not guarantee this QPS - will be achieved. - state: - type: string - x-enum: - - SCALING_CHANGE_APPLIED - - SCALING_CHANGE_IN_PROGRESS - - SCALING_CHANGE_UNSPECIFIED - description: The current state of the scaling change request. - description: Scaling information for the endpoint - target_qps: - type: integer - description: >- - Target QPS for the endpoint. Mutually exclusive with - ``replica_count``. Best-effort; the system does not - guarantee this QPS will be achieved. - throughput_info: - type: object - properties: - change_request_message: - type: string - description: >- - Additional information about the throughput change - request - change_request_state: - type: string - x-enum: - - CHANGE_ADJUSTED - - CHANGE_FAILED - - CHANGE_IN_PROGRESS - - CHANGE_REACHED_MAXIMUM - - CHANGE_REACHED_MINIMUM - - CHANGE_SUCCESS - description: >- - The state of the most recent throughput change - request - current_concurrency: - type: number - description: >- - The current concurrency (total CPU) allocated to the - endpoint - current_concurrency_utilization_percentage: - type: number - description: >- - The current utilization of concurrency as a - percentage (0-100) - current_num_replicas: - type: integer - description: >- - The current number of replicas allocated to the - endpoint - maximum_concurrency_allowed: - type: number - description: The maximum concurrency allowed for this endpoint - minimal_concurrency_allowed: - type: number - description: The minimum concurrency allowed for this endpoint - requested_concurrency: - type: number - description: >- - The requested concurrency (total CPU) for the - endpoint - requested_num_replicas: - type: integer - description: The requested number of replicas for the endpoint - description: Throughput information for the endpoint - update_time: - type: string - format: date-time - description: Time the endpoint was last updated. - usage_policy_id: - type: string - description: The usage policy id applied to the endpoint. - warnings: - type: array - items: - type: object - properties: - index_names: - type: array - items: - type: string - description: Indexes affected by this warning. - message: - type: string - description: Human-readable detail about the warning. - status_code: - type: string - x-enum: - - ENDPOINT_HAS_INDEX_WITHOUT_OPTIMIZED_ROUTE - - ENDPOINT_HAS_MANAGED_INDEX - - RERANKER_TEMPORARILY_UNAVAILABLE - description: Status code categorizing the warning. - description: >- - Advisory warning surfaced on an AI Search endpoint — a - non-fatal condition the customer should - be aware of (for example, a temporarily unavailable reranker or an index without an optimized - query route). - description: >- - Advisory warnings surfaced when target_qps is set on a - Standard endpoint. - required: - - endpoint_type - description: >- - The Endpoint resource to update. ``endpoint.name`` carries - the full resource path. - required: - - endpoint + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id + in: path + required: true + schema: + type: string + description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to delete. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` responses: '200': description: Success + default: + description: Error response content: application/json: schema: - $ref: '#/components/schemas/Endpoint' + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiSearchAPI + get: + operationId: ai_search_get_index + summary: Get details for a single AI Search index. + tags: + - aisearch + - ai_search + description: |- + Get details for a single AI Search index. + + :param name: str + Full resource name of the index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + + :returns: :class:`Index` + parameters: + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id + in: path + required: true + schema: + type: string + description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Index' default: description: Error response content: @@ -1078,7 +897,7 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}:query: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}:query: post: operationId: ai_search_query_index summary: >- @@ -1104,7 +923,8 @@ paths: :param filters_json: str (optional) JSON string describing query filters (e.g. ``{"id >": 5}``). :param max_results: int (optional) - Maximum number of results to return (the legacy ``num_results``). Defaults to 10. + Maximum number of results to return (the legacy ``num_results``). Defaults to 10. Prefer + ``page_size``; when both are set, ``page_size`` takes precedence. :param query_columns: List[str] (optional) Text columns to search for ``query_text``. When empty, all text columns are searched. :param query_text: str (optional) @@ -1122,12 +942,34 @@ paths: :returns: :class:`QueryIndexResponse` parameters: - - name: name + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to query. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to query. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id in: path required: true schema: type: string description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). Full resource name of the index to query. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` requestBody: @@ -1160,7 +1002,8 @@ paths: type: integer description: >- Maximum number of results to return (the legacy - ``num_results``). Defaults to 10. + ``num_results``). Defaults to 10. Prefer ``page_size``; when + both are set, ``page_size`` takes precedence. query_columns: type: array items: @@ -1245,7 +1088,7 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}:removeData: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}:removeData: post: operationId: ai_search_remove_data summary: Remove rows by primary key from a Direct Access AI Search index. @@ -1263,12 +1106,36 @@ paths: :returns: :class:`RemoveDataResponse` parameters: - - name: name + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Must be a Direct Access index. + Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Must be a Direct Access index. + Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id in: path required: true schema: type: string description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). Full resource name of the index. Must be a Direct Access index. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` @@ -1304,7 +1171,7 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}:scan: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}:scan: post: operationId: ai_search_scan_index summary: Scan (paginate over) the rows of an AI Search index. @@ -1324,12 +1191,34 @@ paths: :returns: :class:`ScanIndexResponse` parameters: - - name: name + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to scan. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to scan. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id in: path required: true schema: type: string description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). Full resource name of the index to scan. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` requestBody: @@ -1365,7 +1254,7 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}:sync: + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}:sync: post: operationId: ai_search_sync_index summary: >- @@ -1388,12 +1277,36 @@ paths: :returns: :class:`SyncIndexResponse` parameters: - - name: name + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to synchronize. Must be a Delta Sync + index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index to synchronize. Must be a Delta Sync + index. Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id in: path required: true schema: type: string description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). Full resource name of the index to synchronize. Must be a Delta Sync index. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` @@ -1416,7 +1329,87 @@ paths: message: type: string x-stackql-sdk-source: AiSearchAPI - /api/2.0/ai-search/{name}:upsertData: + /api/2.0/ai-search/workspaces/{workspace}/endpoints/{endpoint}: + patch: + operationId: ai_search_update_endpoint + summary: >- + Update an existing AI Search endpoint. Multi-bucket masks are supported + and dispatched in + tags: + - aisearch + - ai_search + description: >- + Update an existing AI Search endpoint. Multi-bucket masks are supported + and dispatched in + + deterministic bucket order: budget policy, custom tags, throughput, then + scaling/replicas. Per-bucket + + dispatch is not atomic across buckets — if a later bucket fails, earlier + buckets may already have + + been applied. + + + :param name: str + 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. + :param endpoint: :class:`Endpoint` + The Endpoint resource to update. ``endpoint.name`` carries the full resource path. + :param update_mask: FieldMask + The list of fields to update. + + :returns: :class:`Endpoint` + parameters: + - name: workspace + in: path + required: true + schema: + type: string + description: >- + The `workspace` segment of the `name` resource name + (`workspaces/{workspace}/endpoints/{endpoint}`). 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. + - name: endpoint + in: path + required: true + schema: + $ref: '#/components/schemas/Endpoint' + description: >- + The Endpoint resource to update. ``endpoint.name`` carries the full + resource path. + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Endpoint' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiSearchAPI + /api/2.0/ai-search/workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}:upsertData: post: operationId: ai_search_upsert_data summary: Upsert rows into a Direct Access AI Search index. @@ -1434,12 +1427,36 @@ paths: :returns: :class:`UpsertDataResponse` parameters: - - name: name + - name: workspace_id + in: path + required: true + schema: + type: string + description: >- + The `workspace_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Must be a Direct Access index. + Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: endpoint_id + in: path + required: true + schema: + type: string + description: >- + The `endpoint_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). + Full resource name of the index. Must be a Direct Access index. + Format: + ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` + - name: index_id in: path required: true schema: type: string description: >- + The `index_id` segment of the `name` resource name + (`workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`). Full resource name of the index. Must be a Direct Access index. Format: ``workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`` @@ -1574,13 +1591,6 @@ components: items: $ref: '#/components/schemas/EmbeddingVectorColumn' description: The columns that contain the embedding vectors. - requested_schema_json: - type: string - description: >- - The index schema exactly as the user supplied it on create, - preserving the original type spellings (e.g. ``integer``) rather - than Unity Catalog's canonical names (e.g. ``int``) that - ``schema_json`` returns. schema_json: type: string description: >- @@ -1689,13 +1699,6 @@ components: usage_policy_id: type: string description: The usage policy id applied to the endpoint. - warnings: - type: array - items: - $ref: '#/components/schemas/Warning' - description: >- - Advisory warnings surfaced when target_qps is set on a Standard - endpoint. required: - endpoint_type description: >- @@ -1715,9 +1718,9 @@ components: $ref: '#/components/schemas/ScalingChangeState' description: The current state of the scaling change request. description: >- - Scaling information for a Storage Optimized endpoint — current scaling - state and the requested - QPS target the system is scaling toward. + Scaling information for a Standard endpoint: the current scaling state, + the requested QPS + target, and the progress of an in-progress scaling change. EndpointStatus: type: object properties: @@ -2010,25 +2013,6 @@ components: $ref: '#/components/schemas/DataModificationStatus' description: Overall status of the upsert. description: Response for UpsertData. - Warning: - type: object - properties: - index_names: - type: array - items: - type: string - description: Indexes affected by this warning. - message: - type: string - description: Human-readable detail about the warning. - status_code: - $ref: '#/components/schemas/WarningStatusCode' - description: Status code categorizing the warning. - description: >- - Advisory warning surfaced on an AI Search endpoint — a non-fatal - condition the customer should - be aware of (for example, a temporarily unavailable reranker or an index without an optimized - query route). DataModificationStatus: type: string x-enum: @@ -2048,6 +2032,9 @@ components: - ONLINE - PROVISIONING - RED_STATE + - STARTING + - STOPPED + - STOPPING - YELLOW_STATE description: >- Lifecycle state of an AI Search endpoint, used by both Standard and @@ -2123,9 +2110,7 @@ components: - SCALING_CHANGE_APPLIED - SCALING_CHANGE_IN_PROGRESS - SCALING_CHANGE_UNSPECIFIED - description: >- - State of the most recent scaling change request for a Storage Optimized - endpoint. + description: State of the most recent scaling change request for a Standard endpoint. ThroughputChangeRequestState: type: string x-enum: @@ -2140,15 +2125,6 @@ components: Storage Optimized endpoint. Surfaced on ``EndpointThroughputInfo.change_request_state``. - WarningStatusCode: - type: string - x-enum: - - ENDPOINT_HAS_INDEX_WITHOUT_OPTIMIZED_ROUTE - - ENDPOINT_HAS_MANAGED_INDEX - - RERANKER_TEMPORARILY_UNAVAILABLE - description: >- - Status code categorizing an advisory warning surfaced on an AI Search - endpoint. x-stackQL-resources: endpoints: id: databricks_workspace.aisearch.endpoints @@ -2160,34 +2136,50 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{parent}~1endpoints/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{parent}~1endpoints/get' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpoints + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' update: - config: - requestBodyTranslate: - algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}/patch' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace}~1endpoints~1{endpoint}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' insert: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' update: - $ref: '#/components/x-stackQL-resources/endpoints/methods/update' - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' replace: [] indexes: id: databricks_workspace.aisearch.indexes @@ -2199,26 +2191,30 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{parent}~1indexes/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{parent}~1indexes/get' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.indexes delete: operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}/delete' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}/get' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -2227,7 +2223,8 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}:query/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}:query/post response: mediaType: application/json openAPIDocKey: '200' @@ -2236,7 +2233,8 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}:removeData/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}:removeData/post response: mediaType: application/json openAPIDocKey: '200' @@ -2245,13 +2243,15 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}:scan/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}:scan/post response: mediaType: application/json openAPIDocKey: '200' sync: operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}:sync/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}:sync/post response: mediaType: application/json openAPIDocKey: '200' @@ -2260,14 +2260,15 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1ai-search~1{name}:upsertData/post' + $ref: >- + #/paths/~1api~12.0~1ai-search~1workspaces~1{workspace_id}~1endpoints~1{endpoint_id}~1indexes~1{index_id}:upsertData/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/indexes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/indexes/methods/create' update: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml index 54b47f44..309d2455 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml @@ -5,14 +5,28 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.apps servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/apps: post: @@ -43,228 +57,47 @@ paths: schema: type: object properties: - app: + name: + type: string + active_deployment: type: object properties: - name: - type: string - active_deployment: - type: object - properties: - command: - type: array - items: - type: string - create_time: - type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: - type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as - a secret or a database table. - description: The environment variables to set in the app runtime environment. This will override - the environment variables specified in the app.yaml file. - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: - type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: - type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: - type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The active deployment of the app. A deployment is considered active when it has been deployed - to the app compute. - app_status: - type: object - properties: - message: - type: string - running_instances: - type: integer - description: The number of running instances of this application. - state: - type: string - x-enum: - - CRASHED - - DEPLOYING - - RUNNING - - UNAVAILABLE - description: State of the application. - budget_policy_id: - type: string - compatibility_flags: + command: type: array items: type: string - description: 'Compatibility flags the customer is requesting for the app''s runtime environment. On - update, the submitted set must be a subset of ``effective_compatibility_flags`` (flags may only be - removed, never added). Supported flags: "PREINSTALLED_PACKAGES_LEGACY".' - compute_max_instances: - type: integer - description: Maximum number of app instances. Must be set together with ``compute_min_instances``. - compute_min_instances: - type: integer - description: Minimum number of app instances. Must be set together with ``compute_max_instances``. - compute_size: + create_time: type: string - x-enum: - - LARGE - - LIQUID - - MEDIUM - - XLARGE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - compute_status: + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: type: object properties: - active_instances: - type: integer - message: - type: string - description: Compute status message - state: + source_code_path: type: string - x-enum: - - ACTIVE - - DELETING - - ERROR - - STARTING - - STOPPED - - STOPPING - - UPDATING - description: State of the app compute. - create_time: - type: string - description: The creation time of the app. Formatted timestamp in ISO 6801. - creator: + description: The deployment artifacts for an app. + deployment_id: type: string - description: The email of the user that created the app. - default_git_source: + description: The unique id of the deployment. + env_vars: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as a secret + or a database table. + description: The environment variables to set in the app runtime environment. This will override the + environment variables specified in the app.yaml file. + git_source: type: object properties: branch: @@ -308,1161 +141,1510 @@ paths: tag: type: string description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - default_source_code_path: - type: string - description: The default workspace file system path of the source code from which app deployment are - created. This field tracks the workspace source code path of the last active deployment. - description: + description: Git repository to use as the source for the app deployment. + health_check: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If not + set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before + considering the deployment successful. + mode: type: string - description: The description of the app. - effective_budget_policy_id: + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: type: string - effective_compatibility_flags: - type: array - items: - type: string - description: The compatibility flags currently applied to the app. - effective_resources: - type: array - items: - type: object - properties: - name: - type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + description: The workspace file system path of the source code used to create the app deployment. This + is different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed + app. The former refers to the original source code location of the app in the workspace during deployment + creation, whereas the latter provides a system generated stable snapshotted source code path used + by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The active deployment of the app. A deployment is considered active when it has been deployed + to the app compute. + app_status: + type: object + properties: + message: + type: string + running_instances: + type: integer + description: The number of app instances whose application process is running. + state: + type: string + x-enum: + - CRASHED + - DEPLOYING + - RUNNING + - UNAVAILABLE + description: State of the application. + budget_policy_id: + type: string + compute_max_instances: + type: integer + description: Maximum number of app instances the app is configured to run. Must be set together with ``compute_min_instances``. + compute_min_instances: + type: integer + description: Minimum number of app instances the app is configured to run. Must be set together with ``compute_max_instances``. + compute_size: + type: string + x-enum: + - LARGE + - MEDIUM + - XLARGE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + compute_status: + type: object + properties: + active_instances: + type: integer + message: + type: string + description: Compute status message + state: + type: string + x-enum: + - ACTIVE + - DELETING + - ERROR + - STARTING + - STOPPED + - STOPPING + - UPDATING + description: State of the app compute. + create_time: + type: string + description: The creation time of the app. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user that created the app. + default_git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in + the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the + app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated by + the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch + or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the root + of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source of the app's most recent active deployment, including the repository configuration + and the resolved reference. Populated by the system after a Git-based deployment and used as the default + reference when automatic deployments are enabled. + default_source_code_path: + type: string + description: The default workspace file system path of the source code from which app deployment are created. + This field tracks the workspace source code path of the last active deployment. + description: + type: string + description: The description of the app. + effective_budget_policy_id: + type: string + effective_usage_policy_id: + type: string + effective_user_api_scopes: + type: array + items: + type: string + description: The effective api scopes granted to the user access token. + forward_user_access_token: + type: boolean + description: Forward the user's access token to the app. Requires stopping and starting app compute to take + effect. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in the + app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the app's + service principal access to this repository. + required: + - url + - provider + description: Git repository configuration for app deployments. When specified, deployments can reference + code from this repository by providing only the git reference (branch, tag, or commit). + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in + the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the + app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated by + the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch + or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the root + of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) + and an optional path to the app source code within the repository configured in git_repository. + id: + type: string + description: The unique identifier of the app. + oauth2_app_client_id: + type: string + oauth2_app_integration_id: + type: string + pending_deployment: + type: object + properties: + command: + type: array + items: + type: string + create_time: + type: string + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + description: The deployment artifacts for an app. + deployment_id: + type: string + description: The unique id of the deployment. + env_vars: + type: array + items: + type: object + properties: + name: type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - + value: + type: string + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as a secret + or a database table. + description: The environment variables to set in the app runtime environment. This will override the + environment variables specified in the app.yaml file. + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the + branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the + root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: Git repository to use as the source for the app deployment. + health_check: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If not + set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before + considering the deployment successful. + mode: + type: string + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: + type: string + description: The workspace file system path of the source code used to create the app deployment. This + is different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed + app. The former refers to the original source code location of the app in the workspace during deployment + creation, whereas the latter provides a system generated stable snapshotted source code path used + by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The pending deployment of the app. A deployment is considered pending when it is being prepared + for deployment to the app compute. + resources: + type: array + items: + type: object + properties: + name: + type: string + app: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_USE + description: |- + Create a collection of name/value pairs. - - value lookup: + Example enumeration: - >>> Color(1) - + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - - name lookup: + Access them by: - >>> Color['RED'] - + - attribute access: - Enumerations can be iterated over, and know how many members they have: + >>> Color.RED + - >>> len(Color) - 3 + - value lookup: - >>> list(Color) - [, , ] + >>> Color(1) + - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + - name lookup: - Example enumeration: + >>> Color['RED'] + - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Enumerations can be iterated over, and know how many members they have: - Access them by: + >>> len(Color) + 3 - - attribute access: + >>> list(Color) + [, , ] - >>> Color.RED - + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + database: + type: object + properties: + instance_name: + type: string + database_name: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - - value lookup: + Example enumeration: - >>> Color(1) - + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - - name lookup: + Access them by: - >>> Color['RED'] - + - attribute access: - Enumerations can be iterated over, and know how many members they have: + >>> Color.RED + - >>> len(Color) - 3 + - value lookup: - >>> list(Color) - [, , ] + >>> Color(1) + - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + - name lookup: - Example enumeration: + >>> Color['RED'] + - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Enumerations can be iterated over, and know how many members they have: - Access them by: + >>> len(Color) + 3 - - attribute access: + >>> list(Color) + [, , ] - >>> Color.RED - + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - instance_name + - database_name + - permission + description: + type: string + description: Description of the App Resource. + experiment: + type: object + properties: + experiment_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - - value lookup: + Example enumeration: - >>> Color(1) - + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - - name lookup: + Access them by: - >>> Color['RED'] - + - attribute access: - Enumerations can be iterated over, and know how many members they have: + >>> Color.RED + - >>> len(Color) - 3 + - value lookup: - >>> list(Color) - [, , ] + >>> Color(1) + - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + - name lookup: - Example enumeration: + >>> Color['RED'] + - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Enumerations can be iterated over, and know how many members they have: - Access them by: + >>> len(Color) + 3 - - attribute access: + >>> list(Color) + [, , ] - >>> Color.RED - + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - experiment_id + - permission + genie_space: + type: object + properties: + name: + type: string + space_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_RUN + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - - value lookup: + Example enumeration: - >>> Color(1) - + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - - name lookup: + Access them by: - >>> Color['RED'] - + - attribute access: - Enumerations can be iterated over, and know how many members they have: + >>> Color.RED + - >>> len(Color) - 3 + - value lookup: - >>> list(Color) - [, , ] + >>> Color(1) + - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + - name lookup: - Example enumeration: + >>> Color['RED'] + - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Enumerations can be iterated over, and know how many members they have: - Access them by: + >>> len(Color) + 3 - - attribute access: + >>> list(Color) + [, , ] - >>> Color.RED - + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - name + - space_id + - permission + job: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", + "CAN_MANAGE_RUN", "CAN_VIEW".' + required: + - id + - permission + postgres: + type: object + properties: + branch: + type: string + database: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - - value lookup: + Example enumeration: - >>> Color(1) - + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - - name lookup: + Access them by: - >>> Color['RED'] - + - attribute access: - Enumerations can be iterated over, and know how many members they have: + >>> Color.RED + - >>> len(Color) - 3 + - value lookup: - >>> list(Color) - [, , ] + >>> Color(1) + - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + secret: + type: object + properties: + scope: + type: string + key: + type: string + description: Key of the secret to grant permission on. + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. For secrets, only one permission is allowed. + Permission must be one of: "READ", "WRITE", "MANAGE".' + required: + - scope + - key + - permission + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", + "CAN_QUERY", "CAN_VIEW".' required: - name - description: Union of the app's own resources and the resources inherited from its space. Only populated - when the app belongs to a space that uses the group identity model. - effective_usage_policy_id: - type: string - effective_user_api_scopes: - type: array - items: - type: string - description: The effective api scopes granted to the user access token. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured in - the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant the - app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration for app deployments. When specified, deployments can reference - code from this repository by providing only the git reference (branch, tag, or commit). - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, - this will match commit. If a branch or tag is specified, this contains the commit SHA that the - branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, the - root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - id: - type: string - description: The unique identifier of the app. - last_deployment_id: - type: string - description: The ID of the last deployment created for this app. - oauth2_app_client_id: - type: string - oauth2_app_integration_id: - type: string - pending_deployment: - type: object - properties: - command: - type: array - items: + - permission + sql_warehouse: + type: object + properties: + id: type: string - create_time: - type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: - type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as - a secret or a database table. - description: The environment variables to set in the app runtime environment. This will override - the environment variables specified in the app.yaml file. - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: - type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: - type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: - type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The pending deployment of the app. A deployment is considered pending when it is being - prepared for deployment to the app compute. - resources: - type: array - items: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", + "CAN_USE", "IS_OWNER".' + required: + - id + - permission + uc_securable: type: object properties: - name: + securable_full_name: type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MODIFY + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + securable_kind: type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - + description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. + required: + - securable_full_name + - securable_type + - permission + required: + - name + description: Resources for the app. + service_principal_client_id: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + source_code_path: + type: string + space: + type: string + description: Name of the space this app belongs to. + telemetry_export_destinations: + type: array + items: + type: object + properties: + unity_catalog: + type: object + properties: + logs_table: + type: string + description: Unity Catalog table for OTEL logs. + metrics_table: + type: string + description: Unity Catalog table for OTEL metrics. + traces_table: + type: string + description: Unity Catalog table for OTEL traces (spans). + required: + - logs_table + - metrics_table + - traces_table + description: Unity Catalog Destinations for OTEL telemetry export. + description: A single telemetry export destination with its configuration and status. + thumbnail_url: + type: string + description: The URL of the thumbnail image for the app. + update_time: + type: string + description: The update time of the app. Formatted timestamp in ISO 6801. + updater: + type: string + description: The email of the user that last updated the app. + url: + type: string + description: The URL of the app once it is deployed. + usage_policy_id: + type: string + user_api_scopes: + type: array + items: + type: string + required: + - name + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/App' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + get: + operationId: apps_list + summary: Lists all apps in the workspace. + tags: + - apps + description: |- + Lists all apps in the workspace. - Enumerations can be iterated over, and know how many members they have: + :param page_size: int (optional) + Upper bound for items returned. + :param page_token: str (optional) + Pagination token to go to the next page of apps. Requests first page if absent. + :param space: str (optional) + Filter apps by app space name. When specified, only apps belonging to this space are returned. - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + :returns: Iterator over :class:`App` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: Upper bound for items returned. + - name: page_token + in: query + required: false + schema: + type: string + description: Pagination token to go to the next page of apps. Requests first page if absent. + - name: space + in: query + required: false + schema: + type: string + description: Filter apps by app space name. When specified, only apps belonging to this space are returned. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListAppsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + /api/2.0/app-spaces: + post: + operationId: apps_create_space + summary: Creates a new app space. + tags: + - apps + description: |- + Creates a new app space. - Example enumeration: + :param space: :class:`Space` - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + :returns: :class:`Operation` + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + assume_group_id: + type: string + description: The group whose permissions users assume via Role Authorization for apps in this space. When + set, user tokens assume the role of this group instead of doing regular obo token downscoping. Set only + at space creation. + create_time: + type: string + format: date-time + description: The creation time of the app space. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user that created the app space. + description: + type: string + description: The description of the app space. + effective_usage_policy_id: + type: string + description: The effective usage policy ID used by apps in the space. + effective_user_api_scopes: + type: array + items: + type: string + description: The effective api scopes granted to the user access token. + id: + type: string + description: The unique identifier of the app space. + resources: + type: array + items: + type: object + properties: + name: + type: string + app: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_USE + description: |- + Create a collection of name/value pairs. - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + >>> len(Color) + 3 - Example enumeration: + >>> list(Color) + [, , ] - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + database: + type: object + properties: + instance_name: + type: string + database_name: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + >>> len(Color) + 3 - Example enumeration: + >>> list(Color) + [, , ] - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - instance_name + - database_name + - permission + description: + type: string + description: Description of the App Resource. + experiment: + type: object + properties: + experiment_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + >>> len(Color) + 3 - Example enumeration: + >>> list(Color) + [, , ] - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - experiment_id + - permission + genie_space: + type: object + properties: + name: + type: string + space_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_RUN + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. required: - name - description: Resources for the app. - service_principal_client_id: - type: string - service_principal_id: - type: integer - service_principal_name: - type: string - source_code_path: - type: string - space: - type: string - description: Name of the space this app belongs to. - space_id: - type: string - description: The ID of the app space this app belongs to. None if app does not belong to a space. - telemetry_export_destinations: - type: array - items: + - space_id + - permission + job: type: object properties: - unity_catalog: - type: object - properties: - logs_table: - type: string - description: Unity Catalog table for OTEL logs. - metrics_table: - type: string - description: Unity Catalog table for OTEL metrics. - traces_table: - type: string - description: Unity Catalog table for OTEL traces (spans). - required: - - logs_table - - metrics_table - - traces_table - description: Unity Catalog Destinations for OTEL telemetry export. - description: A single telemetry export destination with its configuration and status. - thumbnail_url: - type: string - description: The URL of the thumbnail image for the app. - update_time: - type: string - description: The update time of the app. Formatted timestamp in ISO 6801. - updater: - type: string - description: The email of the user that last updated the app. - url: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", + "CAN_MANAGE_RUN", "CAN_VIEW".' + required: + - id + - permission + postgres: + type: object + properties: + branch: + type: string + database: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + secret: + type: object + properties: + scope: + type: string + key: + type: string + description: Key of the secret to grant permission on. + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. For secrets, only one permission is allowed. + Permission must be one of: "READ", "WRITE", "MANAGE".' + required: + - scope + - key + - permission + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", + "CAN_QUERY", "CAN_VIEW".' + required: + - name + - permission + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", + "CAN_USE", "IS_OWNER".' + required: + - id + - permission + uc_securable: + type: object + properties: + securable_full_name: + type: string + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MODIFY + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + securable_kind: + type: string + description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. + required: + - securable_full_name + - securable_type + - permission + required: + - name + description: Resources for the app space. Resources configured at the space level are available to all apps + in the space. + service_principal_client_id: + type: string + description: The service principal client ID for the app space. + service_principal_id: + type: integer + description: The service principal ID for the app space. + service_principal_name: + type: string + description: The service principal name for the app space. + status: + type: object + properties: + message: type: string - description: The URL of the app once it is deployed. - usage_policy_id: + state: type: string - user_api_scopes: - type: array - items: - type: string - required: - - name + x-enum: + - SPACE_ACTIVE + - SPACE_CREATING + - SPACE_DELETED + - SPACE_DELETING + - SPACE_ERROR + - SPACE_UPDATING + description: The state of the app space. + description: The status of the app space. + update_time: + type: string + format: date-time + description: The update time of the app space. Formatted timestamp in ISO 6801. + updater: + type: string + description: The email of the user that last updated the app space. + usage_policy_id: + type: string + description: The usage policy ID for managing cost at the space level. + user_api_scopes: + type: array + items: + type: string + description: OAuth scopes for apps in the space. required: - - app + - name responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/App' + type: object default: description: Error response content: @@ -1476,21 +1658,19 @@ paths: type: string x-stackql-sdk-source: AppsAPI get: - operationId: apps_list - summary: Lists all apps in the workspace. + operationId: apps_list_spaces + summary: Lists all app spaces in the workspace. tags: - apps description: |- - Lists all apps in the workspace. + Lists all app spaces in the workspace. :param page_size: int (optional) Upper bound for items returned. :param page_token: str (optional) - Pagination token to go to the next page of apps. Requests first page if absent. - :param space: str (optional) - Filter apps by app space name. When specified, only apps belonging to this space are returned. + Pagination token to go to the next page of app spaces. Requests first page if absent. - :returns: Iterator over :class:`App` + :returns: Iterator over :class:`Space` parameters: - name: page_size in: query @@ -1503,20 +1683,14 @@ paths: required: false schema: type: string - description: Pagination token to go to the next page of apps. Requests first page if absent. - - name: space - in: query - required: false - schema: - type: string - description: Filter apps by app space name. When specified, only apps belonging to this space are returned. + description: Pagination token to go to the next page of app spaces. Requests first page if absent. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListAppsResponse' + $ref: '#/components/schemas/ListSpacesResponse' default: description: Error response content: @@ -1529,2253 +1703,423 @@ paths: message: type: string x-stackql-sdk-source: AppsAPI - /api/2.0/app-spaces: + /api/2.0/apps/{app_name}/update: post: - operationId: apps_create_space - summary: Creates a new app space. + operationId: apps_create_update + summary: Creates an app update and starts the update process. The update process is asynchronous and the status tags: - apps description: |- - Creates a new app space. + Creates an app update and starts the update process. The update process is asynchronous and the status + of the update can be checked with the GetAppUpdate method. - :param space: :class:`Space` + :param app_name: str + :param update_mask: str + 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. - :returns: :class:`Operation` + 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. + :param app: :class:`App` (optional) + + :returns: + Long-running operation waiter for :class:`AppUpdate`. + See :method:wait_get_update_app_succeeded for more details. + parameters: + - name: app_name + in: path + required: true + schema: + type: string requestBody: content: application/json: schema: type: object properties: - space: + update_mask: + type: string + 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. 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. + app: type: object properties: name: type: string - create_time: - type: string - format: date-time - description: The creation time of the app space. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user that created the app space. - description: - type: string - description: The description of the app space. - effective_usage_policy_id: - type: string - description: The effective usage policy ID used by apps in the space. - effective_user_api_scopes: - type: array - items: - type: string - description: The effective api scopes granted to the user access token. - group_id: - type: string - description: The ID of the group attached to the app space. ASPs minted for apps in this space are added - as members of this group at create time, so the group's resource permissions flow through to every - app in the space. - id: - type: string - description: The unique identifier of the app space. - resources: - type: array - items: - type: object - properties: - name: + active_deployment: + type: object + properties: + command: + type: array + items: type: string - app: + create_time: + type: string + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + description: The deployment artifacts for an app. + deployment_id: + type: string + description: The unique id of the deployment. + env_vars: + type: array + items: type: object properties: name: type: string - permission: + value: type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as + a secret or a database table. + description: The environment variables to set in the app runtime environment. This will override + the environment variables specified in the app.yaml file. + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, + bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, + awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified + directly, this will match commit. If a branch or tag is specified, this contains the commit + SHA that the branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, + the root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: Git repository to use as the source for the app deployment. + health_check: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If + not set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests + before considering the deployment successful. + mode: + type: string + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: + type: string + description: The workspace file system path of the source code used to create the app deployment. + This is different from ``deployment_artifacts.source_code_path``, which is the path used by the + deployed app. The former refers to the original source code location of the app in the workspace + during deployment creation, whereas the latter provides a system generated stable snapshotted + source code path used by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The active deployment of the app. A deployment is considered active when it has been deployed + to the app compute. + app_status: + type: object + properties: + message: + type: string + running_instances: + type: integer + description: The number of app instances whose application process is running. + state: + type: string + x-enum: + - CRASHED + - DEPLOYING + - RUNNING + - UNAVAILABLE + description: State of the application. + budget_policy_id: + type: string + compute_max_instances: + type: integer + description: Maximum number of app instances the app is configured to run. Must be set together with + ``compute_min_instances``. + compute_min_instances: + type: integer + description: Minimum number of app instances the app is configured to run. Must be set together with + ``compute_max_instances``. + compute_size: + type: string + x-enum: + - LARGE + - MEDIUM + - XLARGE + description: |- + Create a collection of name/value pairs. - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + >>> len(Color) + 3 - Example enumeration: + >>> list(Color) + [, , ] - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: - type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission - required: - - name - description: Resources for the app space. Resources configured at the space level are available to all - apps in the space. - service_principal_client_id: - type: string - description: The service principal client ID for the app space. - service_principal_id: - type: integer - description: The service principal ID for the app space. - service_principal_name: - type: string - description: The service principal name for the app space. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - SPACE_ACTIVE - - SPACE_CREATING - - SPACE_DELETED - - SPACE_DELETING - - SPACE_ERROR - - SPACE_UPDATING - description: The state of the app space. - description: The status of the app space. - telemetry_export_destinations: - type: array - items: - type: object - properties: - unity_catalog: - type: object - properties: - logs_table: - type: string - description: Unity Catalog table for OTEL logs. - metrics_table: - type: string - description: Unity Catalog table for OTEL metrics. - traces_table: - type: string - description: Unity Catalog table for OTEL traces (spans). - required: - - logs_table - - metrics_table - - traces_table - description: Unity Catalog Destinations for OTEL telemetry export. - description: A single telemetry export destination with its configuration and status. - description: Telemetry export destinations for all apps in this space. When configured, all apps in - the space export OTEL telemetry (logs, metrics, traces) to the specified Unity Catalog tables. - update_time: - type: string - format: date-time - description: The update time of the app space. Formatted timestamp in ISO 6801. - updater: - type: string - description: The email of the user that last updated the app space. - usage_policy_id: - type: string - description: The usage policy ID for managing cost at the space level. - user_api_scopes: - type: array - items: - type: string - description: OAuth scopes for apps in the space. - required: - - name - required: - - space - responses: - '200': - description: Success - content: - application/json: - schema: - type: object - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - get: - operationId: apps_list_spaces - summary: Lists all app spaces in the workspace. - tags: - - apps - description: |- - Lists all app spaces in the workspace. - - :param page_size: int (optional) - Upper bound for items returned. - :param page_token: str (optional) - Pagination token to go to the next page of app spaces. Requests first page if absent. - - :returns: Iterator over :class:`Space` - parameters: - - name: page_size - in: query - required: false - schema: - type: integer - description: Upper bound for items returned. - - name: page_token - in: query - required: false - schema: - type: string - description: Pagination token to go to the next page of app spaces. Requests first page if absent. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListSpacesResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - /api/2.0/apps/{app_name}/update: - post: - operationId: apps_create_update - summary: Creates an app update and starts the update process. The update process is asynchronous and the status - tags: - - apps - description: |- - Creates an app update and starts the update process. The update process is asynchronous and the status - of the update can be checked with the GetAppUpdate method. - - :param app_name: str - :param update_mask: str - 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. - :param app: :class:`App` (optional) - - :returns: - Long-running operation waiter for :class:`AppUpdate`. - See :method:wait_get_update_app_succeeded for more details. - parameters: - - name: app_name - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - update_mask: - type: string - 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. 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. - app: - type: object - properties: - name: - type: string - active_deployment: - type: object - properties: - command: - type: array - items: - type: string - create_time: - type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: - type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as - a secret or a database table. - description: The environment variables to set in the app runtime environment. This will override - the environment variables specified in the app.yaml file. - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: - type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: - type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: - type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The active deployment of the app. A deployment is considered active when it has been deployed - to the app compute. - app_status: - type: object - properties: - message: - type: string - running_instances: - type: integer - description: The number of running instances of this application. - state: - type: string - x-enum: - - CRASHED - - DEPLOYING - - RUNNING - - UNAVAILABLE - description: State of the application. - budget_policy_id: - type: string - compatibility_flags: - type: array - items: - type: string - description: 'Compatibility flags the customer is requesting for the app''s runtime environment. On - update, the submitted set must be a subset of ``effective_compatibility_flags`` (flags may only be - removed, never added). Supported flags: "PREINSTALLED_PACKAGES_LEGACY".' - compute_max_instances: - type: integer - description: Maximum number of app instances. Must be set together with ``compute_min_instances``. - compute_min_instances: - type: integer - description: Minimum number of app instances. Must be set together with ``compute_max_instances``. - compute_size: - type: string - x-enum: - - LARGE - - LIQUID - - MEDIUM - - XLARGE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - compute_status: - type: object - properties: - active_instances: - type: integer - message: - type: string - description: Compute status message - state: - type: string - x-enum: - - ACTIVE - - DELETING - - ERROR - - STARTING - - STOPPED - - STOPPING - - UPDATING - description: State of the app compute. - create_time: - type: string - description: The creation time of the app. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user that created the app. - default_git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, - this will match commit. If a branch or tag is specified, this contains the commit SHA that the - branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, the - root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - default_source_code_path: - type: string - description: The default workspace file system path of the source code from which app deployment are - created. This field tracks the workspace source code path of the last active deployment. - description: - type: string - description: The description of the app. - effective_budget_policy_id: - type: string - effective_compatibility_flags: - type: array - items: - type: string - description: The compatibility flags currently applied to the app. - effective_resources: - type: array - items: - type: object - properties: - name: - type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: - type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission - required: - - name - description: Union of the app's own resources and the resources inherited from its space. Only populated - when the app belongs to a space that uses the group identity model. - effective_usage_policy_id: - type: string - effective_user_api_scopes: - type: array - items: - type: string - description: The effective api scopes granted to the user access token. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured in - the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant the - app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration for app deployments. When specified, deployments can reference - code from this repository by providing only the git reference (branch, tag, or commit). - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, - this will match commit. If a branch or tag is specified, this contains the commit SHA that the - branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, the - root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - id: - type: string - description: The unique identifier of the app. - last_deployment_id: - type: string - description: The ID of the last deployment created for this app. - oauth2_app_client_id: - type: string - oauth2_app_integration_id: - type: string - pending_deployment: - type: object - properties: - command: - type: array - items: - type: string - create_time: - type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: - type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as - a secret or a database table. - description: The environment variables to set in the app runtime environment. This will override - the environment variables specified in the app.yaml file. - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: - type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: - type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: - type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The pending deployment of the app. A deployment is considered pending when it is being - prepared for deployment to the app compute. - resources: - type: array - items: - type: object - properties: - name: - type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: - type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission - required: - - name - description: Resources for the app. - service_principal_client_id: - type: string - service_principal_id: - type: integer - service_principal_name: - type: string - source_code_path: - type: string - space: - type: string - description: Name of the space this app belongs to. - space_id: - type: string - description: The ID of the app space this app belongs to. None if app does not belong to a space. - telemetry_export_destinations: - type: array - items: - type: object - properties: - unity_catalog: - type: object - properties: - logs_table: - type: string - description: Unity Catalog table for OTEL logs. - metrics_table: - type: string - description: Unity Catalog table for OTEL metrics. - traces_table: - type: string - description: Unity Catalog table for OTEL traces (spans). - required: - - logs_table - - metrics_table - - traces_table - description: Unity Catalog Destinations for OTEL telemetry export. - description: A single telemetry export destination with its configuration and status. - thumbnail_url: - type: string - description: The URL of the thumbnail image for the app. - update_time: - type: string - description: The update time of the app. Formatted timestamp in ISO 6801. - updater: - type: string - description: The email of the user that last updated the app. - url: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + compute_status: + type: object + properties: + active_instances: + type: integer + message: + type: string + description: Compute status message + state: + type: string + x-enum: + - ACTIVE + - DELETING + - ERROR + - STARTING + - STOPPED + - STOPPING + - UPDATING + description: State of the app compute. + create_time: type: string - description: The URL of the app once it is deployed. - usage_policy_id: + description: The creation time of the app. Formatted timestamp in ISO 6801. + creator: type: string - user_api_scopes: - type: array - items: - type: string - required: - - name - required: - - update_mask - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/AppUpdate' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - get: - operationId: apps_get_update - summary: Gets the status of an app update. - tags: - - apps - description: |- - Gets the status of an app update. - - :param app_name: str - The name of the app. - - :returns: :class:`AppUpdate` - parameters: - - name: app_name - in: path - required: true - schema: - type: string - description: The name of the app. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/AppUpdate' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - /api/2.0/apps/{name}: - delete: - operationId: apps_delete - summary: Deletes an app. - tags: - - apps - description: |- - Deletes an app. - - :param name: str - The name of the app. - - :returns: :class:`App` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: The name of the app. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/App' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - get: - operationId: apps_get - summary: Retrieves information for the app with the supplied name. - tags: - - apps - description: |- - Retrieves information for the app with the supplied name. - - :param name: str - The name of the app. - - :returns: :class:`App` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: The name of the app. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/App' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: AppsAPI - patch: - operationId: apps_update - summary: Updates the app with the supplied name. - tags: - - apps - description: |- - Updates the app with the supplied name. - - :param name: str - The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It - must be unique within the workspace. - :param app: :class:`App` - - :returns: :class:`App` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must - be unique within the workspace. - requestBody: - content: - application/json: - schema: - type: object - properties: - app: - type: object - properties: - name: + description: The email of the user that created the app. + default_git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the + branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the + root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source of the app's most recent active deployment, including the repository configuration + and the resolved reference. Populated by the system after a Git-based deployment and used as the default + reference when automatic deployments are enabled. + default_source_code_path: type: string - active_deployment: + description: The default workspace file system path of the source code from which app deployment are + created. This field tracks the workspace source code path of the last active deployment. + description: + type: string + description: The description of the app. + effective_budget_policy_id: + type: string + effective_usage_policy_id: + type: string + effective_user_api_scopes: + type: array + items: + type: string + description: The effective api scopes granted to the user access token. + forward_user_access_token: + type: boolean + description: Forward the user's access token to the app. Requires stopping and starting app compute + to take effect. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in + the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the + app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration for app deployments. When specified, deployments can reference + code from this repository by providing only the git reference (branch, tag, or commit). + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the + branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the + root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) + and an optional path to the app source code within the repository configured in git_repository. + id: + type: string + description: The unique identifier of the app. + oauth2_app_client_id: + type: string + oauth2_app_integration_id: + type: string + pending_deployment: type: object properties: command: @@ -3831,226 +2175,79 @@ paths: provider: type: string description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: - type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: - type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: - type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The active deployment of the app. A deployment is considered active when it has been deployed - to the app compute. - app_status: - type: object - properties: - message: - type: string - running_instances: - type: integer - description: The number of running instances of this application. - state: - type: string - x-enum: - - CRASHED - - DEPLOYING - - RUNNING - - UNAVAILABLE - description: State of the application. - budget_policy_id: - type: string - compatibility_flags: - type: array - items: - type: string - description: 'Compatibility flags the customer is requesting for the app''s runtime environment. On - update, the submitted set must be a subset of ``effective_compatibility_flags`` (flags may only be - removed, never added). Supported flags: "PREINSTALLED_PACKAGES_LEGACY".' - compute_max_instances: - type: integer - description: Maximum number of app instances. Must be set together with ``compute_min_instances``. - compute_min_instances: - type: integer - description: Minimum number of app instances. Must be set together with ``compute_max_instances``. - compute_size: - type: string - x-enum: - - LARGE - - LIQUID - - MEDIUM - - XLARGE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - compute_status: - type: object - properties: - active_instances: - type: integer - message: - type: string - description: Compute status message - state: - type: string - x-enum: - - ACTIVE - - DELETING - - ERROR - - STARTING - - STOPPED - - STOPPING - - UPDATING - description: State of the app compute. - create_time: - type: string - description: The creation time of the app. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user that created the app. - default_git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: + bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, + awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified + directly, this will match commit. If a branch or tag is specified, this contains the commit + SHA that the branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, + the root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: Git repository to use as the source for the app deployment. + health_check: type: object properties: - url: + path: type: string - description: URL of the Git repository. - provider: + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: + description: Timeout to wait for the health check to pass before failing the deployment. If + not set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests + before considering the deployment successful. + mode: type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, - this will match commit. If a branch or tag is specified, this contains the commit SHA that the - branch or tag pointed to at deployment time. + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. source_code_path: type: string - description: Relative path to the app source code within the Git repository. If not specified, the - root of the repository is used. - tag: + description: The workspace file system path of the source code used to create the app deployment. + This is different from ``deployment_artifacts.source_code_path``, which is the path used by the + deployed app. The former refers to the original source code location of the app in the workspace + during deployment creation, whereas the latter provides a system generated stable snapshotted + source code path used by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: type: string - description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - default_source_code_path: - type: string - description: The default workspace file system path of the source code from which app deployment are - created. This field tracks the workspace source code path of the last active deployment. - description: - type: string - description: The description of the app. - effective_budget_policy_id: - type: string - effective_compatibility_flags: - type: array - items: - type: string - description: The compatibility flags currently applied to the app. - effective_resources: + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The pending deployment of the app. A deployment is considered pending when it is being + prepared for deployment to the app compute. + resources: type: array items: type: object @@ -4391,6 +2588,7 @@ paths: x-enum: - CONNECTION - FUNCTION + - MODEL_SERVICE - TABLE - VOLUME description: |- @@ -4415,85 +2613,526 @@ paths: >>> Color(1) - - name lookup: + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MODIFY + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + securable_kind: + type: string + description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. + required: + - securable_full_name + - securable_type + - permission + required: + - name + description: Resources for the app. + service_principal_client_id: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + source_code_path: + type: string + space: + type: string + description: Name of the space this app belongs to. + telemetry_export_destinations: + type: array + items: + type: object + properties: + unity_catalog: + type: object + properties: + logs_table: + type: string + description: Unity Catalog table for OTEL logs. + metrics_table: + type: string + description: Unity Catalog table for OTEL metrics. + traces_table: + type: string + description: Unity Catalog table for OTEL traces (spans). + required: + - logs_table + - metrics_table + - traces_table + description: Unity Catalog Destinations for OTEL telemetry export. + description: A single telemetry export destination with its configuration and status. + thumbnail_url: + type: string + description: The URL of the thumbnail image for the app. + update_time: + type: string + description: The update time of the app. Formatted timestamp in ISO 6801. + updater: + type: string + description: The email of the user that last updated the app. + url: + type: string + description: The URL of the app once it is deployed. + usage_policy_id: + type: string + user_api_scopes: + type: array + items: + type: string + required: + - name + required: + - update_mask + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AppUpdate' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + get: + operationId: apps_get_update + summary: Gets the status of an app update. + tags: + - apps + description: |- + Gets the status of an app update. + + :param app_name: str + The name of the app. + + :returns: :class:`AppUpdate` + parameters: + - name: app_name + in: path + required: true + schema: + type: string + description: The name of the app. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AppUpdate' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + /api/2.0/apps/{name}: + delete: + operationId: apps_delete + summary: Deletes an app. + tags: + - apps + description: |- + Deletes an app. + + :param name: str + The name of the app. - >>> Color['RED'] - + :returns: :class:`App` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/App' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + get: + operationId: apps_get + summary: Retrieves information for the app with the supplied name. + tags: + - apps + description: |- + Retrieves information for the app with the supplied name. - Enumerations can be iterated over, and know how many members they have: + :param name: str + The name of the app. - >>> len(Color) - 3 + :returns: :class:`App` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/App' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AppsAPI + patch: + operationId: apps_update + summary: 'Updates the app with the supplied name. This is a full replacement: fields omitted from the request' + tags: + - apps + description: |- + Updates the app with the supplied name. This is a full replacement: fields omitted from the request + are cleared, so send the complete app. - >>> list(Color) - [, , ] + :param name: str + The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It + must be unique within the workspace. + :param app: :class:`App` - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + :returns: :class:`App` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must + be unique within the workspace. + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + active_deployment: + type: object + properties: + command: + type: array + items: + type: string + create_time: + type: string + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + description: The deployment artifacts for an app. + deployment_id: + type: string + description: The unique id of the deployment. + env_vars: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as a secret + or a database table. + description: The environment variables to set in the app runtime environment. This will override the + environment variables specified in the app.yaml file. + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured + in the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant + the app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated + by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the + branch or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the + root of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: Git repository to use as the source for the app deployment. + health_check: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If not + set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before + considering the deployment successful. + mode: + type: string + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: + type: string + description: The workspace file system path of the source code used to create the app deployment. This + is different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed + app. The former refers to the original source code location of the app in the workspace during deployment + creation, whereas the latter provides a system generated stable snapshotted source code path used + by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The active deployment of the app. A deployment is considered active when it has been deployed + to the app compute. + app_status: + type: object + properties: + message: + type: string + running_instances: + type: integer + description: The number of app instances whose application process is running. + state: + type: string + x-enum: + - CRASHED + - DEPLOYING + - RUNNING + - UNAVAILABLE + description: State of the application. + budget_policy_id: + type: string + compute_max_instances: + type: integer + description: Maximum number of app instances the app is configured to run. Must be set together with ``compute_min_instances``. + compute_min_instances: + type: integer + description: Minimum number of app instances the app is configured to run. Must be set together with ``compute_max_instances``. + compute_size: + type: string + x-enum: + - LARGE + - MEDIUM + - XLARGE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission - required: - - name - description: Union of the app's own resources and the resources inherited from its space. Only populated - when the app belongs to a space that uses the group identity model. - effective_usage_policy_id: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + compute_status: + type: object + properties: + active_instances: + type: integer + message: type: string - effective_user_api_scopes: - type: array - items: - type: string - description: The effective api scopes granted to the user access token. + description: Compute status message + state: + type: string + x-enum: + - ACTIVE + - DELETING + - ERROR + - STARTING + - STOPPED + - STOPPING + - UPDATING + description: State of the app compute. + create_time: + type: string + description: The creation time of the app. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user that created the app. + default_git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. git_repository: type: object properties: @@ -4515,8 +3154,157 @@ paths: required: - url - provider - description: Git repository configuration for app deployments. When specified, deployments can reference - code from this repository by providing only the git reference (branch, tag, or commit). + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated by + the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch + or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the root + of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source of the app's most recent active deployment, including the repository configuration + and the resolved reference. Populated by the system after a Git-based deployment and used as the default + reference when automatic deployments are enabled. + default_source_code_path: + type: string + description: The default workspace file system path of the source code from which app deployment are created. + This field tracks the workspace source code path of the last active deployment. + description: + type: string + description: The description of the app. + effective_budget_policy_id: + type: string + effective_usage_policy_id: + type: string + effective_user_api_scopes: + type: array + items: + type: string + description: The effective api scopes granted to the user access token. + forward_user_access_token: + type: boolean + description: Forward the user's access token to the app. Requires stopping and starting app compute to take + effect. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in the + app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the app's + service principal access to this repository. + required: + - url + - provider + description: Git repository configuration for app deployments. When specified, deployments can reference + code from this repository by providing only the git reference (branch, tag, or commit). + git_source: + type: object + properties: + branch: + type: string + description: Git branch to checkout. + commit: + type: string + description: Git commit SHA to checkout. + git_repository: + type: object + properties: + url: + type: string + description: URL of the Git repository. + provider: + type: string + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in + the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the + app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: + type: string + description: The resolved commit SHA that was actually used for the deployment. This is populated by + the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch + or tag pointed to at deployment time. + source_code_path: + type: string + description: Relative path to the app source code within the Git repository. If not specified, the root + of the repository is used. + tag: + type: string + description: Git tag to checkout. + description: The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) + and an optional path to the app source code within the repository configured in git_repository. + id: + type: string + description: The unique identifier of the app. + oauth2_app_client_id: + type: string + oauth2_app_integration_id: + type: string + pending_deployment: + type: object + properties: + command: + type: array + items: + type: string + create_time: + type: string + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: + type: object + properties: + source_code_path: + type: string + description: The deployment artifacts for an app. + deployment_id: + type: string + description: The unique id of the deployment. + env_vars: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as a secret + or a database table. + description: The environment variables to set in the app runtime environment. This will override the + environment variables specified in the app.yaml file. git_source: type: object properties: @@ -4561,628 +3349,542 @@ paths: tag: type: string description: Git tag to checkout. - description: Complete git source specification including repository location and reference. - id: - type: string - description: The unique identifier of the app. - last_deployment_id: - type: string - description: The ID of the last deployment created for this app. - oauth2_app_client_id: - type: string - oauth2_app_integration_id: - type: string - pending_deployment: + description: Git repository to use as the source for the app deployment. + health_check: type: object properties: - command: - type: array - items: - type: string - create_time: - type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: + path: type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as - a secret or a database table. - description: The environment variables to set in the app runtime environment. This will override - the environment variables specified in the app.yaml file. - git_source: - type: object - properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, - bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, - awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified - directly, this will match commit. If a branch or tag is specified, this contains the commit - SHA that the branch or tag pointed to at deployment time. - source_code_path: - type: string - description: Relative path to the app source code within the Git repository. If not specified, - the root of the repository is used. - tag: - type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. - source_code_path: + description: Timeout to wait for the health check to pass before failing the deployment. If not + set, a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before + considering the deployment successful. + mode: + type: string + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: + type: string + description: The workspace file system path of the source code used to create the app deployment. This + is different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed + app. The former refers to the original source code location of the app in the workspace during deployment + creation, whereas the latter provides a system generated stable snapshotted source code path used + by the deployment. + status: + type: object + properties: + message: type: string - description: The workspace file system path of the source code used to create the app deployment. - This is different from ``deployment_artifacts.source_code_path``, which is the path used by the - deployed app. The former refers to the original source code location of the app in the workspace - during deployment creation, whereas the latter provides a system generated stable snapshotted - source code path used by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: + state: type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The pending deployment of the app. A deployment is considered pending when it is being - prepared for deployment to the app compute. - resources: - type: array - items: + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. + description: The pending deployment of the app. A deployment is considered pending when it is being prepared + for deployment to the app compute. + resources: + type: array + items: + type: object + properties: + name: + type: string + app: type: object properties: name: type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. + permission: + type: string + x-enum: + - CAN_USE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + database: + type: object + properties: + instance_name: + type: string + database_name: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - instance_name + - database_name + - permission + description: + type: string + description: Description of the App Resource. + experiment: + type: object + properties: + experiment_id: type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - experiment_id + - permission + genie_space: + type: object + properties: + name: + type: string + space_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_RUN + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - name + - space_id + - permission + job: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", + "CAN_MANAGE_RUN", "CAN_VIEW".' + required: + - id + - permission + postgres: + type: object + properties: + branch: + type: string + database: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + secret: + type: object + properties: + scope: + type: string + key: + type: string + description: Key of the secret to grant permission on. + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. For secrets, only one permission is allowed. + Permission must be one of: "READ", "WRITE", "MANAGE".' + required: + - scope + - key + - permission + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", + "CAN_QUERY", "CAN_VIEW".' + required: + - name + - permission + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", + "CAN_USE", "IS_OWNER".' + required: + - id + - permission + uc_securable: + type: object + properties: + securable_full_name: + type: string + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MODIFY + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + securable_kind: + type: string + description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. required: - - name - description: Resources for the app. - service_principal_client_id: - type: string - service_principal_id: - type: integer - service_principal_name: - type: string - source_code_path: - type: string - space: - type: string - description: Name of the space this app belongs to. - space_id: - type: string - description: The ID of the app space this app belongs to. None if app does not belong to a space. - telemetry_export_destinations: - type: array - items: + - securable_full_name + - securable_type + - permission + required: + - name + description: Resources for the app. + service_principal_client_id: + type: string + service_principal_id: + type: integer + service_principal_name: + type: string + source_code_path: + type: string + space: + type: string + description: Name of the space this app belongs to. + telemetry_export_destinations: + type: array + items: + type: object + properties: + unity_catalog: type: object properties: - unity_catalog: - type: object - properties: - logs_table: - type: string - description: Unity Catalog table for OTEL logs. - metrics_table: - type: string - description: Unity Catalog table for OTEL metrics. - traces_table: - type: string - description: Unity Catalog table for OTEL traces (spans). - required: - - logs_table - - metrics_table - - traces_table - description: Unity Catalog Destinations for OTEL telemetry export. - description: A single telemetry export destination with its configuration and status. - thumbnail_url: - type: string - description: The URL of the thumbnail image for the app. - update_time: - type: string - description: The update time of the app. Formatted timestamp in ISO 6801. - updater: - type: string - description: The email of the user that last updated the app. - url: - type: string - description: The URL of the app once it is deployed. - usage_policy_id: - type: string - user_api_scopes: - type: array - items: - type: string - required: - - name + logs_table: + type: string + description: Unity Catalog table for OTEL logs. + metrics_table: + type: string + description: Unity Catalog table for OTEL metrics. + traces_table: + type: string + description: Unity Catalog table for OTEL traces (spans). + required: + - logs_table + - metrics_table + - traces_table + description: Unity Catalog Destinations for OTEL telemetry export. + description: A single telemetry export destination with its configuration and status. + thumbnail_url: + type: string + description: The URL of the thumbnail image for the app. + update_time: + type: string + description: The update time of the app. Formatted timestamp in ISO 6801. + updater: + type: string + description: The email of the user that last updated the app. + url: + type: string + description: The URL of the app once it is deployed. + usage_policy_id: + type: string + user_api_scopes: + type: array + items: + type: string required: - - app + - name responses: '200': description: Success @@ -5415,543 +4117,514 @@ paths: schema: type: object properties: - space: - type: object - properties: - name: - type: string - create_time: - type: string - format: date-time - description: The creation time of the app space. Formatted timestamp in ISO 6801. - creator: - type: string - description: The email of the user that created the app space. - description: - type: string - description: The description of the app space. - effective_usage_policy_id: - type: string - description: The effective usage policy ID used by apps in the space. - effective_user_api_scopes: - type: array - items: + name: + type: string + assume_group_id: + type: string + description: The group whose permissions users assume via Role Authorization for apps in this space. When + set, user tokens assume the role of this group instead of doing regular obo token downscoping. Set only + at space creation. + create_time: + type: string + format: date-time + description: The creation time of the app space. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user that created the app space. + description: + type: string + description: The description of the app space. + effective_usage_policy_id: + type: string + description: The effective usage policy ID used by apps in the space. + effective_user_api_scopes: + type: array + items: + type: string + description: The effective api scopes granted to the user access token. + id: + type: string + description: The unique identifier of the app space. + resources: + type: array + items: + type: object + properties: + name: type: string - description: The effective api scopes granted to the user access token. - group_id: - type: string - description: The ID of the group attached to the app space. ASPs minted for apps in this space are added - as members of this group at create time, so the group's resource permissions flow through to every - app in the space. - id: - type: string - description: The unique identifier of the app space. - resources: - type: array - items: + app: type: object properties: name: type: string - app: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. + permission: + type: string + x-enum: + - CAN_USE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - database: - type: object - properties: - instance_name: - type: string - database_name: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + database: + type: object + properties: + instance_name: + type: string + database_name: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - instance_name - - database_name - - permission - description: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - instance_name + - database_name + - permission + description: + type: string + description: Description of the App Resource. + experiment: + type: object + properties: + experiment_id: type: string - description: Description of the App Resource. - experiment: - type: object - properties: - experiment_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - >>> Color(1) - + Example enumeration: - - name lookup: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color['RED'] - + Access them by: - Enumerations can be iterated over, and know how many members they have: + - attribute access: - >>> len(Color) - 3 + >>> Color.RED + - >>> list(Color) - [, , ] + - value lookup: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - experiment_id - - permission - genie_space: - type: object - properties: - name: - type: string - space_id: - type: string - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_RUN - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + >>> Color(1) + - Example enumeration: + - name lookup: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> Color['RED'] + - Access them by: + Enumerations can be iterated over, and know how many members they have: - - attribute access: + >>> len(Color) + 3 - >>> Color.RED - + >>> list(Color) + [, , ] - - value lookup: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - experiment_id + - permission + genie_space: + type: object + properties: + name: + type: string + space_id: + type: string + permission: + type: string + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_RUN + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - >>> Color(1) - + Example enumeration: - - name lookup: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color['RED'] - + Access them by: - Enumerations can be iterated over, and know how many members they have: + - attribute access: - >>> len(Color) - 3 + >>> Color.RED + - >>> list(Color) - [, , ] + - value lookup: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - name - - space_id - - permission - job: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", - "CAN_MANAGE_RUN", "CAN_VIEW".' - required: - - id - - permission - postgres: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + >>> Color(1) + - Example enumeration: + - name lookup: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> Color['RED'] + - Access them by: + Enumerations can be iterated over, and know how many members they have: - - attribute access: + >>> len(Color) + 3 - >>> Color.RED - + >>> list(Color) + [, , ] - - value lookup: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - name + - space_id + - permission + job: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: 'Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", + "CAN_MANAGE_RUN", "CAN_VIEW".' + required: + - id + - permission + postgres: + type: object + properties: + branch: + type: string + database: + type: string + permission: + type: string + x-enum: + - CAN_CONNECT_AND_CREATE + description: |- + Create a collection of name/value pairs. - >>> Color(1) - + Example enumeration: - - name lookup: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color['RED'] - + Access them by: - Enumerations can be iterated over, and know how many members they have: + - attribute access: - >>> len(Color) - 3 + >>> Color.RED + - >>> list(Color) - [, , ] + - value lookup: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret: - type: object - properties: - scope: - type: string - key: - type: string - description: Key of the secret to grant permission on. - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. For secrets, only one permission is - allowed. Permission must be one of: "READ", "WRITE", "MANAGE".' - required: - - scope - - key - - permission - serving_endpoint: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", - "CAN_QUERY", "CAN_VIEW".' - required: - - name - - permission - sql_warehouse: - type: object - properties: - id: - type: string - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", - "CAN_USE", "IS_OWNER".' - required: - - id - - permission - uc_securable: - type: object - properties: - securable_full_name: - type: string - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + >>> Color(1) + - Example enumeration: + - name lookup: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> Color['RED'] + - Access them by: + Enumerations can be iterated over, and know how many members they have: - - attribute access: + >>> len(Color) + 3 - >>> Color.RED - + >>> list(Color) + [, , ] - - value lookup: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + secret: + type: object + properties: + scope: + type: string + key: + type: string + description: Key of the secret to grant permission on. + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. For secrets, only one permission is allowed. + Permission must be one of: "READ", "WRITE", "MANAGE".' + required: + - scope + - key + - permission + serving_endpoint: + type: object + properties: + name: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: 'Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", + "CAN_QUERY", "CAN_VIEW".' + required: + - name + - permission + sql_warehouse: + type: object + properties: + id: + type: string + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: 'Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", + "CAN_USE", "IS_OWNER".' + required: + - id + - permission + uc_securable: + type: object + properties: + securable_full_name: + type: string + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. - >>> Color(1) - + Example enumeration: - - name lookup: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color['RED'] - + Access them by: - Enumerations can be iterated over, and know how many members they have: + - attribute access: - >>> len(Color) - 3 + >>> Color.RED + - >>> list(Color) - [, , ] + - value lookup: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + >>> Color(1) + - Example enumeration: + - name lookup: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> Color['RED'] + - Access them by: + Enumerations can be iterated over, and know how many members they have: - - attribute access: + >>> len(Color) + 3 - >>> Color.RED - + >>> list(Color) + [, , ] - - value lookup: + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MODIFY + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. - >>> Color(1) - + Example enumeration: - - name lookup: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color['RED'] - + Access them by: - Enumerations can be iterated over, and know how many members they have: + - attribute access: - >>> len(Color) - 3 + >>> Color.RED + - >>> list(Color) - [, , ] + - value lookup: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - securable_kind: - type: string - description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. - required: - - securable_full_name - - securable_type - - permission + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + securable_kind: + type: string + description: The securable kind from Unity Catalog. See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. required: - - name - description: Resources for the app space. Resources configured at the space level are available to all - apps in the space. - service_principal_client_id: - type: string - description: The service principal client ID for the app space. - service_principal_id: - type: integer - description: The service principal ID for the app space. - service_principal_name: - type: string - description: The service principal name for the app space. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - SPACE_ACTIVE - - SPACE_CREATING - - SPACE_DELETED - - SPACE_DELETING - - SPACE_ERROR - - SPACE_UPDATING - description: The state of the app space. - description: The status of the app space. - telemetry_export_destinations: - type: array - items: - type: object - properties: - unity_catalog: - type: object - properties: - logs_table: - type: string - description: Unity Catalog table for OTEL logs. - metrics_table: - type: string - description: Unity Catalog table for OTEL metrics. - traces_table: - type: string - description: Unity Catalog table for OTEL traces (spans). - required: - - logs_table - - metrics_table - - traces_table - description: Unity Catalog Destinations for OTEL telemetry export. - description: A single telemetry export destination with its configuration and status. - description: Telemetry export destinations for all apps in this space. When configured, all apps in - the space export OTEL telemetry (logs, metrics, traces) to the specified Unity Catalog tables. - update_time: - type: string - format: date-time - description: The update time of the app space. Formatted timestamp in ISO 6801. - updater: + - securable_full_name + - securable_type + - permission + required: + - name + description: Resources for the app space. Resources configured at the space level are available to all apps + in the space. + service_principal_client_id: + type: string + description: The service principal client ID for the app space. + service_principal_id: + type: integer + description: The service principal ID for the app space. + service_principal_name: + type: string + description: The service principal name for the app space. + status: + type: object + properties: + message: type: string - description: The email of the user that last updated the app space. - usage_policy_id: + state: type: string - description: The usage policy ID for managing cost at the space level. - user_api_scopes: - type: array - items: - type: string - description: OAuth scopes for apps in the space. - required: - - name + x-enum: + - SPACE_ACTIVE + - SPACE_CREATING + - SPACE_DELETED + - SPACE_DELETING + - SPACE_ERROR + - SPACE_UPDATING + description: The state of the app space. + description: The status of the app space. + update_time: + type: string + format: date-time + description: The update time of the app space. Formatted timestamp in ISO 6801. + updater: + type: string + description: The email of the user that last updated the app space. + usage_policy_id: + type: string + description: The usage policy ID for managing cost at the space level. + user_api_scopes: + type: array + items: + type: string + description: OAuth scopes for apps in the space. required: - - space + - name responses: '200': description: Success @@ -6001,122 +4674,127 @@ paths: schema: type: object properties: - app_deployment: + command: + type: array + items: + type: string + create_time: + type: string + description: The creation time of the deployment. Formatted timestamp in ISO 6801. + creator: + type: string + description: The email of the user creates the deployment. + deployment_artifacts: type: object properties: - command: - type: array - items: - type: string - create_time: + source_code_path: type: string - description: The creation time of the deployment. Formatted timestamp in ISO 6801. - creator: + description: The deployment artifacts for an app. + deployment_id: + type: string + description: The unique id of the deployment. + env_vars: + type: array + items: + type: object + properties: + name: + type: string + value: + type: string + description: The value for the environment variable. + value_from: + type: string + description: The name of an external Databricks resource that contains the value, such as a secret + or a database table. + description: The environment variables to set in the app runtime environment. This will override the environment + variables specified in the app.yaml file. + git_source: + type: object + properties: + branch: type: string - description: The email of the user creates the deployment. - deployment_artifacts: - type: object - properties: - source_code_path: - type: string - description: The deployment artifacts for an app. - deployment_id: + description: Git branch to checkout. + commit: type: string - description: The unique id of the deployment. - env_vars: - type: array - items: - type: object - properties: - name: - type: string - value: - type: string - description: The value for the environment variable. - value_from: - type: string - description: The name of an external Databricks resource that contains the value, such as a secret - or a database table. - description: The environment variables to set in the app runtime environment. This will override the - environment variables specified in the app.yaml file. - git_source: + description: Git commit SHA to checkout. + git_repository: type: object properties: - branch: - type: string - description: Git branch to checkout. - commit: - type: string - description: Git commit SHA to checkout. - git_repository: - type: object - properties: - url: - type: string - description: URL of the Git repository. - provider: - type: string - description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, - bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' - auto_deploy: - type: boolean - description: When true, automatically deploys the app on push events to the branch configured - in the app's deployment_source.git_source. - caller_credential_id: - type: integer - description: ID of a personal access token Git credential owned by the caller, used to grant - the app's service principal access to this repository. - required: - - url - - provider - description: Git repository configuration. Populated from the app's git_repository configuration. - resolved_commit: - type: string - description: The resolved commit SHA that was actually used for the deployment. This is populated - by the system after resolving the reference (branch, tag, or commit). If commit is specified directly, - this will match commit. If a branch or tag is specified, this contains the commit SHA that the - branch or tag pointed to at deployment time. - source_code_path: + url: type: string - description: Relative path to the app source code within the Git repository. If not specified, the - root of the repository is used. - tag: + description: URL of the Git repository. + provider: type: string - description: Git tag to checkout. - description: Git repository to use as the source for the app deployment. - mode: + description: 'Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, + bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.' + auto_deploy: + type: boolean + description: When true, automatically deploys the app on push events to the branch configured in + the app's deployment_source.git_source. + caller_credential_id: + type: integer + description: ID of a personal access token Git credential owned by the caller, used to grant the + app's service principal access to this repository. + required: + - url + - provider + description: Git repository configuration. Populated from the app's git_repository configuration. + resolved_commit: type: string - x-enum: - - AUTO_SYNC - - SNAPSHOT - description: The mode of which the deployment will manage the source code. + description: The resolved commit SHA that was actually used for the deployment. This is populated by + the system after resolving the reference (branch, tag, or commit). If commit is specified directly, + this will match commit. If a branch or tag is specified, this contains the commit SHA that the branch + or tag pointed to at deployment time. source_code_path: type: string - description: The workspace file system path of the source code used to create the app deployment. This - is different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed - app. The former refers to the original source code location of the app in the workspace during deployment - creation, whereas the latter provides a system generated stable snapshotted source code path used - by the deployment. - status: - type: object - properties: - message: - type: string - state: - type: string - x-enum: - - CANCELLED - - FAILED - - IN_PROGRESS - - SUCCEEDED - description: State of the deployment. - description: Status and status message of the deployment - update_time: + description: Relative path to the app source code within the Git repository. If not specified, the root + of the repository is used. + tag: type: string - description: The update time of the deployment. Formatted timestamp in ISO 6801. - description: The app deployment configuration. - required: - - app_deployment + description: Git tag to checkout. + description: Git repository to use as the source for the app deployment. + health_check: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If not set, + a default timeout is used. + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before + considering the deployment successful. + mode: + type: string + x-enum: + - AUTO_SYNC + - SNAPSHOT + description: The mode of which the deployment will manage the source code. + source_code_path: + type: string + description: The workspace file system path of the source code used to create the app deployment. This is + different from ``deployment_artifacts.source_code_path``, which is the path used by the deployed app. + The former refers to the original source code location of the app in the workspace during deployment creation, + whereas the latter provides a system generated stable snapshotted source code path used by the deployment. + status: + type: object + properties: + message: + type: string + state: + type: string + x-enum: + - CANCELLED + - FAILED + - IN_PROGRESS + - SUCCEEDED + description: State of the deployment. + description: Status and status message of the deployment + update_time: + type: string + description: The update time of the deployment. Formatted timestamp in ISO 6801. responses: '200': description: Success @@ -6584,427 +5262,363 @@ paths: schema: type: object properties: - template: + name: + type: string + git_repo: + type: string + description: The Git repository URL that the template resides in. + path: + type: string + description: The path to the template within the Git repository. + manifest: type: object properties: + version: + type: integer + description: The manifest schema version, for now only 1 is allowed name: type: string - git_repo: - type: string - description: The Git repository URL that the template resides in. - path: + description: Name of the app defined by manifest author / publisher + description: type: string - description: The path to the template within the Git repository. - manifest: - type: object - properties: - version: - type: integer - description: The manifest schema version, for now only 1 is allowed - name: - type: string - description: Name of the app defined by manifest author / publisher - description: - type: string - description: Description of the app defined by manifest author / publisher - resource_specs: - type: array - items: + description: Description of the app defined by manifest author / publisher + resource_specs: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the App Resource. + description: + type: string + description: Description of the App Resource. + experiment_spec: type: object properties: - name: - type: string - description: Name of the App Resource. - app_spec: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: 'Permission to grant on the app. Supported permission: "CAN_USE".' - description: + permission: type: string - description: Description of the App Resource. - experiment_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - job_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - postgres_spec: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + job_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret_spec: - type: object - properties: - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. Supported permissions are: "READ", - "WRITE", "MANAGE".' - required: - - permission - serving_endpoint_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + secret_spec: + type: object + properties: + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. Supported permissions are: "READ", + "WRITE", "MANAGE".' + required: + - permission + serving_endpoint_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - sql_warehouse_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + sql_warehouse_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - uc_securable_spec: - type: object - properties: - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + uc_securable_spec: + type: object + properties: + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MANAGE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MANAGE + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - securable_type - - permission + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. required: - - name - description: |- - AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. - name, id, key, scope, etc.) - required: - - version - - name - description: The manifest of the template. It defines fields and default values when installing the - template. - git_provider: - type: string - description: The Git provider of the template. - creator: - type: string - description: - type: string - description: The description of the template. + - securable_type + - permission + required: + - name + description: |- + AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. + name, id, key, scope, etc.) required: + - version - name - - git_repo - - path - - manifest - - git_provider + description: The manifest of the template. It defines fields and default values when installing the template. + git_provider: + type: string + description: The Git provider of the template. + creator: + type: string + description: + type: string + description: The description of the template. required: - - template + - name + - git_repo + - path + - manifest + - git_provider responses: '200': description: Success @@ -7179,427 +5793,363 @@ paths: schema: type: object properties: - template: + name: + type: string + git_repo: + type: string + description: The Git repository URL that the template resides in. + path: + type: string + description: The path to the template within the Git repository. + manifest: type: object properties: + version: + type: integer + description: The manifest schema version, for now only 1 is allowed name: type: string - git_repo: - type: string - description: The Git repository URL that the template resides in. - path: + description: Name of the app defined by manifest author / publisher + description: type: string - description: The path to the template within the Git repository. - manifest: - type: object - properties: - version: - type: integer - description: The manifest schema version, for now only 1 is allowed - name: - type: string - description: Name of the app defined by manifest author / publisher - description: - type: string - description: Description of the app defined by manifest author / publisher - resource_specs: - type: array - items: + description: Description of the app defined by manifest author / publisher + resource_specs: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the App Resource. + description: + type: string + description: Description of the App Resource. + experiment_spec: type: object properties: - name: - type: string - description: Name of the App Resource. - app_spec: - type: object - properties: - name: - type: string - permission: - type: string - x-enum: - - CAN_USE - description: 'Permission to grant on the app. Supported permission: "CAN_USE".' - description: + permission: type: string - description: Description of the App Resource. - experiment_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_EDIT - - CAN_MANAGE - - CAN_READ - description: |- - Create a collection of name/value pairs. - - Example enumeration: + x-enum: + - CAN_EDIT + - CAN_MANAGE + - CAN_READ + description: |- + Create a collection of name/value pairs. - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: + Example enumeration: - - attribute access: + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - >>> Color.RED - + Access them by: - - value lookup: + - attribute access: - >>> Color(1) - + >>> Color.RED + - - name lookup: + - value lookup: - >>> Color['RED'] - + >>> Color(1) + - Enumerations can be iterated over, and know how many members they have: + - name lookup: - >>> len(Color) - 3 + >>> Color['RED'] + - >>> list(Color) - [, , ] + Enumerations can be iterated over, and know how many members they have: - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - job_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_MANAGE_RUN - - CAN_VIEW - - IS_OWNER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - postgres_spec: - type: object - properties: - branch: - type: string - database: - type: string - permission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + job_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_MANAGE_RUN + - CAN_VIEW + - IS_OWNER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - secret_spec: - type: object - properties: - permission: - type: string - x-enum: - - MANAGE - - READ - - WRITE - description: 'Permission to grant on the secret scope. Supported permissions are: "READ", - "WRITE", "MANAGE".' - required: - - permission - serving_endpoint_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_QUERY - - CAN_VIEW - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + secret_spec: + type: object + properties: + permission: + type: string + x-enum: + - MANAGE + - READ + - WRITE + description: 'Permission to grant on the secret scope. Supported permissions are: "READ", + "WRITE", "MANAGE".' + required: + - permission + serving_endpoint_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + - CAN_VIEW + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - sql_warehouse_spec: - type: object - properties: - permission: - type: string - x-enum: - - CAN_MANAGE - - CAN_USE - - IS_OWNER - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + sql_warehouse_spec: + type: object + properties: + permission: + type: string + x-enum: + - CAN_MANAGE + - CAN_USE + - IS_OWNER + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - permission - uc_securable_spec: - type: object - properties: - securable_type: - type: string - x-enum: - - CONNECTION - - FUNCTION - - TABLE - - VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + required: + - permission + uc_securable_spec: + type: object + properties: + securable_type: + type: string + x-enum: + - CONNECTION + - FUNCTION + - MODEL_SERVICE + - TABLE + - VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - permission: - type: string - x-enum: - - EXECUTE - - MANAGE - - MODIFY - - READ_VOLUME - - SELECT - - USE_CONNECTION - - WRITE_VOLUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + permission: + type: string + x-enum: + - EXECUTE + - MANAGE + - READ_VOLUME + - SELECT + - USE_CONNECTION + - WRITE_VOLUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - required: - - securable_type - - permission + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. required: - - name - description: |- - AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. - name, id, key, scope, etc.) - required: - - version - - name - description: The manifest of the template. It defines fields and default values when installing the - template. - git_provider: - type: string - description: The Git provider of the template. - creator: - type: string - description: - type: string - description: The description of the template. + - securable_type + - permission + required: + - name + description: |- + AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. + name, id, key, scope, etc.) required: + - version - name - - git_repo - - path - - manifest - - git_provider + description: The manifest of the template. It defines fields and default values when installing the template. + git_provider: + type: string + description: The Git provider of the template. + creator: + type: string + description: + type: string + description: The description of the template. required: - - template + - name + - git_repo + - path + - manifest + - git_provider responses: '200': description: Success @@ -7634,19 +6184,12 @@ components: $ref: '#/components/schemas/ApplicationStatus' budget_policy_id: type: string - compatibility_flags: - type: array - items: - type: string - description: 'Compatibility flags the customer is requesting for the app''s runtime environment. On update, the - submitted set must be a subset of ``effective_compatibility_flags`` (flags may only be removed, never added). - Supported flags: "PREINSTALLED_PACKAGES_LEGACY".' compute_max_instances: type: integer - description: Maximum number of app instances. Must be set together with ``compute_min_instances``. + description: Maximum number of app instances the app is configured to run. Must be set together with ``compute_min_instances``. compute_min_instances: type: integer - description: Minimum number of app instances. Must be set together with ``compute_max_instances``. + description: Minimum number of app instances the app is configured to run. Must be set together with ``compute_max_instances``. compute_size: $ref: '#/components/schemas/ComputeSize' compute_status: @@ -7659,6 +6202,9 @@ components: description: The email of the user that created the app. default_git_source: $ref: '#/components/schemas/GitSource' + description: The Git source of the app's most recent active deployment, including the repository configuration and + the resolved reference. Populated by the system after a Git-based deployment and used as the default reference + when automatic deployments are enabled. default_source_code_path: type: string description: The default workspace file system path of the source code from which app deployment are created. This @@ -7668,17 +6214,6 @@ components: description: The description of the app. effective_budget_policy_id: type: string - effective_compatibility_flags: - type: array - items: - type: string - description: The compatibility flags currently applied to the app. - effective_resources: - type: array - items: - $ref: '#/components/schemas/AppResource' - description: Union of the app's own resources and the resources inherited from its space. Only populated when the - app belongs to a space that uses the group identity model. effective_usage_policy_id: type: string effective_user_api_scopes: @@ -7686,18 +6221,20 @@ components: items: type: string description: The effective api scopes granted to the user access token. + forward_user_access_token: + type: boolean + description: Forward the user's access token to the app. Requires stopping and starting app compute to take effect. git_repository: $ref: '#/components/schemas/GitRepository' description: Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit). git_source: $ref: '#/components/schemas/GitSource' + description: The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an + optional path to the app source code within the repository configured in git_repository. id: type: string description: The unique identifier of the app. - last_deployment_id: - type: string - description: The ID of the last deployment created for this app. oauth2_app_client_id: type: string oauth2_app_integration_id: @@ -7722,9 +6259,6 @@ components: space: type: string description: Name of the space this app belongs to. - space_id: - type: string - description: The ID of the app space this app belongs to. None if app does not belong to a space. telemetry_export_destinations: type: array items: @@ -7809,6 +6343,10 @@ components: git_source: $ref: '#/components/schemas/GitSource' description: Git repository to use as the source for the app deployment. + health_check: + $ref: '#/components/schemas/AppHealthCheck' + description: Deploy-time health check for the app. Verifies the app is responding to HTTP requests before considering + the deployment successful. mode: $ref: '#/components/schemas/AppDeploymentMode' description: The mode of which the deployment will manage the source code. @@ -7837,6 +6375,17 @@ components: state: $ref: '#/components/schemas/AppDeploymentState' description: State of the deployment. + AppHealthCheck: + type: object + properties: + path: + type: string + description: HTTP path to probe, e.g. "/health" or "/api/status". + timeout: + type: string + description: Timeout to wait for the health check to pass before failing the deployment. If not set, a default timeout + is used. + description: Deploy-time HTTP health check configuration for an app deployment. AppManifest: type: object properties: @@ -7857,14 +6406,6 @@ components: - version - name description: App manifest definition - AppManifestAppResourceAppSpec: - type: object - properties: - name: - type: string - permission: - $ref: '#/components/schemas/AppManifestAppResourceAppSpecAppPermission' - description: 'Permission to grant on the app. Supported permission: "CAN_USE".' AppManifestAppResourceExperimentSpec: type: object properties: @@ -7879,15 +6420,6 @@ components: $ref: '#/components/schemas/AppManifestAppResourceJobSpecJobPermission' required: - permission - AppManifestAppResourcePostgresSpec: - type: object - properties: - branch: - type: string - database: - type: string - permission: - $ref: '#/components/schemas/AppManifestAppResourcePostgresSpecPostgresPermission' AppManifestAppResourceSecretSpec: type: object properties: @@ -7908,8 +6440,6 @@ components: name: type: string description: Name of the App Resource. - app_spec: - $ref: '#/components/schemas/AppManifestAppResourceAppSpec' description: type: string description: Description of the App Resource. @@ -7917,8 +6447,6 @@ components: $ref: '#/components/schemas/AppManifestAppResourceExperimentSpec' job_spec: $ref: '#/components/schemas/AppManifestAppResourceJobSpec' - postgres_spec: - $ref: '#/components/schemas/AppManifestAppResourcePostgresSpec' secret_spec: $ref: '#/components/schemas/AppManifestAppResourceSecretSpec' serving_endpoint_spec: @@ -8139,22 +6667,19 @@ components: properties: budget_policy_id: type: string - compatibility_flags: - type: array - items: - type: string - description: Echoes the compatibility flags submitted on the most recent update (the input set from ``App.compatibility_flags``). - To see the flags currently in effect on the app, read ``App.effective_compatibility_flags`` via GetApp. compute_max_instances: type: integer - description: Maximum number of app instances. Must be set together with ``compute_min_instances``. + description: Maximum number of app instances the app is configured to run. Must be set together with ``compute_min_instances``. compute_min_instances: type: integer - description: Minimum number of app instances. Must be set together with ``compute_max_instances``. + description: Minimum number of app instances the app is configured to run. Must be set together with ``compute_max_instances``. compute_size: $ref: '#/components/schemas/ComputeSize' description: type: string + forward_user_access_token: + type: boolean + description: Forward the user's access token to the app. Requires stopping and starting app compute to take effect. git_repository: $ref: '#/components/schemas/GitRepository' resources: @@ -8187,7 +6712,7 @@ components: type: string running_instances: type: integer - description: The number of running instances of this application. + description: The number of app instances whose application process is running. state: $ref: '#/components/schemas/ApplicationState' description: State of the application. @@ -8375,6 +6900,10 @@ components: properties: name: type: string + assume_group_id: + type: string + description: The group whose permissions users assume via Role Authorization for apps in this space. When set, user + tokens assume the role of this group instead of doing regular obo token downscoping. Set only at space creation. create_time: type: string format: date-time @@ -8393,10 +6922,6 @@ components: items: type: string description: The effective api scopes granted to the user access token. - group_id: - type: string - description: The ID of the group attached to the app space. ASPs minted for apps in this space are added as members - of this group at create time, so the group's resource permissions flow through to every app in the space. id: type: string description: The unique identifier of the app space. @@ -8418,12 +6943,6 @@ components: status: $ref: '#/components/schemas/SpaceStatus' description: The status of the app space. - telemetry_export_destinations: - type: array - items: - $ref: '#/components/schemas/TelemetryExportDestination' - description: Telemetry export destinations for all apps in this space. When configured, all apps in the space export - OTEL telemetry (logs, metrics, traces) to the specified Unity Catalog tables. update_time: type: string format: date-time @@ -8454,8 +6973,6 @@ components: properties: description: type: string - group_id: - type: string resources: type: array items: @@ -8584,47 +7101,6 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - AppManifestAppResourceAppSpecAppPermission: - type: string - x-enum: - - CAN_USE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. AppManifestAppResourceExperimentSpecExperimentPermission: @@ -8712,47 +7188,6 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - AppManifestAppResourcePostgresSpecPostgresPermission: - type: string - x-enum: - - CAN_CONNECT_AND_CREATE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. AppManifestAppResourceSecretSpecSecretPermission: @@ -8853,7 +7288,6 @@ components: x-enum: - EXECUTE - MANAGE - - MODIFY - READ_VOLUME - SELECT - USE_CONNECTION @@ -8900,6 +7334,7 @@ components: x-enum: - CONNECTION - FUNCTION + - MODEL_SERVICE - TABLE - VOLUME description: |- @@ -9343,6 +7778,7 @@ components: x-enum: - CONNECTION - FUNCTION + - MODEL_SERVICE - TABLE - VOLUME description: |- @@ -9474,7 +7910,6 @@ components: type: string x-enum: - LARGE - - LIQUID - MEDIUM - XLARGE description: |- @@ -10222,7 +8657,6 @@ components: JSON_EXTRACT(a.pending_deployment, '$.status.state') AS pending_deployment_state, JSON_EXTRACT(a.pending_deployment, '$.status.message') AS pending_deployment_message FROM databricks_workspace.apps.apps a - WHERE deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -10261,7 +8695,6 @@ components: a.pending_deployment->'status'->>'state' AS pending_deployment_state, a.pending_deployment->'status'->>'message' AS pending_deployment_message FROM databricks_workspace.apps.apps a - WHERE deployment_name = '{{ deployment_name }}' vw_app_resources: name: vw_app_resources id: databricks_workspace.apps.vw_app_resources @@ -10390,7 +8823,6 @@ components: JSON_EXTRACT(r.value, '$.uc_securable.permission') AS uc_securable_permission FROM databricks_workspace.apps.apps a, JSON_EACH(a.resources) r - WHERE deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -10432,7 +8864,6 @@ components: r.value->'uc_securable'->>'permission' AS uc_securable_permission FROM databricks_workspace.apps.apps a, jsonb_array_elements(a.resources::jsonb) AS r - WHERE deployment_name = '{{ deployment_name }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/bundledeployments.yaml b/providers/src/databricks_workspace/v00.00.00000/services/bundledeployments.yaml index 9cb6f498..8c3061c3 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/bundledeployments.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/bundledeployments.yaml @@ -6,16 +6,33 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.bundledeployments servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: - /api/2.0/bundle/{name}/complete: + /api/2.0/bundle/deployments/{deployment_id}/versions/{version_id}/complete: post: operationId: bundle_deployments_complete_version summary: Marks a version as complete and releases the deployment lock. @@ -35,21 +52,31 @@ paths: :param name: str The name of the version to complete. Format: deployments/{deployment_id}/versions/{version_id} :param completion_reason: :class:`VersionComplete` - The reason for completing the version. Must be a terminal reason: VERSION_COMPLETE_SUCCESS, - VERSION_COMPLETE_FAILURE, or VERSION_COMPLETE_FORCE_ABORT. + The reason for completing the version. Must be VERSION_COMPLETE_SUCCESS or VERSION_COMPLETE_FAILURE. :param force: bool (optional) - If true, force-completes the version even if the caller is not the original creator. The - completion_reason must be VERSION_COMPLETE_FORCE_ABORT when force is true. + If true, force-completes the version even if the caller is not the original creator. :returns: :class:`Version` parameters: - - name: name + - name: deployment_id in: path required: true schema: type: string description: >- - The name of the version to complete. Format: + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The name of + the version to complete. Format: + deployments/{deployment_id}/versions/{version_id} + - name: version_id + in: path + required: true + schema: + type: string + description: >- + The `version_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The name of + the version to complete. Format: deployments/{deployment_id}/versions/{version_id} requestBody: content: @@ -65,15 +92,13 @@ paths: - VERSION_COMPLETE_LEASE_EXPIRED - VERSION_COMPLETE_SUCCESS description: >- - The reason for completing the version. Must be a terminal - reason: VERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, - or VERSION_COMPLETE_FORCE_ABORT. + The reason for completing the version. Must be + VERSION_COMPLETE_SUCCESS or VERSION_COMPLETE_FAILURE. force: type: boolean description: >- If true, force-completes the version even if the caller is - not the original creator. The completion_reason must be - VERSION_COMPLETE_FORCE_ABORT when force is true. + not the original creator. required: - completion_reason responses: @@ -106,8 +131,9 @@ paths: Creates a new deployment in the workspace. :param deployment: :class:`Deployment` - The deployment to create. The caller must set ``initial_parent_path``. Other fields are ignored on - input and populated by the service. + The deployment to create. ``initial_parent_path`` is required. ``display_name``, ``target_name``, + ``deployment_mode``, and ``workspace_info`` may be set; every other field is assigned by the service + and ignored on input. :returns: :class:`Deployment` requestBody: @@ -116,157 +142,138 @@ paths: schema: type: object properties: - deployment: + create_time: + type: string + format: date-time + description: When the deployment was created. + created_by: + type: string + description: >- + The user who created the deployment (email or principal + name). Empty if authoritative deployment metadata does not + identify a creator or the principal cannot be resolved. + deployment_mode: + type: string + x-enum: + - DEPLOYMENT_MODE_DEVELOPMENT + - DEPLOYMENT_MODE_PRODUCTION + description: Bundle target deployment mode (development or production). + destroy_time: + type: string + format: date-time + description: >- + When deletion was recorded. Unset if deletion has not been + recorded. This response metadata does not determine the + deployment's lifecycle status. + destroyed_by: + type: string + description: >- + The user who destroyed the deployment (email or principal + name). Unset if the deployment has not been destroyed. + display_name: + type: string + description: >- + Human-readable name for the deployment, up to 256 + characters. + git_info: type: object properties: - create_time: - type: string - format: date-time - description: When the deployment was created. - created_by: + branch: type: string - description: >- - The user who created the deployment (email or principal - name). - deployment_mode: - type: string - x-enum: - - DEPLOYMENT_MODE_DEVELOPMENT - - DEPLOYMENT_MODE_PRODUCTION - description: >- - Bundle target deployment mode (development or - production), derived from the most recent version's - mode. - destroy_time: + description: Branch the source was deployed from. + commit: type: string - format: date-time - description: >- - When deletion was recorded. Unset if deletion has not - been recorded. This response metadata does not determine - the deployment's lifecycle status. - destroyed_by: + description: Commit SHA of the deployed source. + origin_url: type: string - description: >- - The user who destroyed the deployment (email or - principal name). Unset if the deployment has not been - destroyed. - display_name: - type: string - description: >- - Human-readable name for the deployment, up to 256 - characters. Output only: clients update it by setting - ``display_name`` when creating a version. - git_info: - type: object - properties: - branch: - type: string - description: Branch the source was deployed from. - commit: - type: string - description: Commit SHA of the deployed source. - origin_url: - type: string - description: URL of the git remote the source was deployed from. - description: >- - Git provenance of the deployment's source, derived from - the latest version. - initial_parent_path: - type: string - description: >- - The workspace path of the existing folder where the - deployment is initially created. Must be absolute and - canonical, with single separators, no ``.`` or ``..`` - segments, and no trailing slash unless the path is - ``/``. It may contain at most 24 path segments, - excluding an optional leading ``/Workspace`` segment. - The complete path may contain up to 1,024 characters, - and each segment may contain up to 511 characters. This - field is input only and is not returned in create, get, - or list responses. - last_successful_version_id: + description: URL of the git remote the source was deployed from. + description: >- + Git provenance of the deployment's source, derived from the + latest version. + initial_parent_path: + type: string + description: >- + The workspace path of the existing folder where the + deployment is initially created. Must be absolute and + canonical, with single separators, no ``.`` or ``..`` + segments, and no trailing slash unless the path is ``/``. It + may contain at most 24 path segments, excluding an optional + leading ``/Workspace`` segment. The complete path may + contain up to 1,024 characters, and each segment may contain + up to 511 characters. This field is input only and is not + returned in create, get, or list responses. + last_successful_version_id: + type: string + description: >- + The version_id of the most recent version that completed + successfully. Unset until a version has completed + successfully. Unlike last_version_id, it is not advanced + when a version fails, so it always points at the last + known-good deployment state (or is unset if there has never + been one). + last_version_id: + type: string + description: The version_id of the most recent deployment version. + name: + type: string + description: >- + Resource name of the deployment. Format: + deployments/{deployment_id} + status: + type: string + x-enum: + - DEPLOYMENT_STATUS_ACTIVE + - DEPLOYMENT_STATUS_DELETED + - DEPLOYMENT_STATUS_FAILED + - DEPLOYMENT_STATUS_IN_PROGRESS + description: Current status of the deployment. + target_name: + type: string + description: The bundle target name associated with this deployment. + update_time: + type: string + format: date-time + description: When the deployment was last updated. + updated_by: + type: string + description: >- + The user who most recently updated the deployment (email or + principal name). Empty if authoritative deployment metadata + does not identify a modifier or the principal cannot be + resolved. + workspace_info: + type: object + properties: + bundle_root_path: type: string description: >- - The version_id of the most recent version that completed - successfully. Unset until a version has completed - successfully. Unlike last_version_id, it is not advanced - when a version fails, so it always points at the last - known-good deployment state (or is unset if there has - never been one). - last_version_id: - type: string - description: The version_id of the most recent deployment version. - name: + Path of the bundle root (the directory containing + databricks.yml) relative to git_folder_path. Empty when + the deployment is not from a Databricks Git folder. + file_path: type: string description: >- - Resource name of the deployment. Format: - deployments/{deployment_id} - status: - type: string - x-enum: - - DEPLOYMENT_STATUS_ACTIVE - - DEPLOYMENT_STATUS_DELETED - - DEPLOYMENT_STATUS_FAILED - - DEPLOYMENT_STATUS_IN_PROGRESS - description: Current status of the deployment. - target_name: + Absolute workspace path where the deployed bundle files + live. Mirrors the workspace.file_path field in DABs + bundle config. + git_folder_path: type: string description: >- - The bundle target name associated with this deployment. - Output only: it is denormalized from the latest version, - not set directly on the deployment. - update_time: - type: string - format: date-time - description: When the deployment was last updated. - updated_by: + When deployed from a Databricks Git folder, the absolute + workspace path of that folder; empty for local deploys. + root_path: type: string description: >- - The user who most recently updated the deployment (email - or principal name). - workspace_info: - type: object - properties: - bundle_root_path: - type: string - description: >- - Path of the bundle root (the directory containing - databricks.yml) relative to git_folder_path. Empty - when the deployment is not from a Databricks Git - folder. - file_path: - type: string - description: >- - Absolute workspace path where the deployed bundle - files live. Mirrors the workspace.file_path field in - DABs bundle config. - git_folder_path: - type: string - description: >- - When deployed from a Databricks Git folder, the - absolute workspace path of that folder; empty for - local deploys. - root_path: - type: string - description: >- - Absolute workspace path of the deployment root — the - base path the deployed files live under. Mirrors - workspace.root_path in the DABs bundle config; - file_path is its files subdirectory. - source_linked: - type: boolean - description: >- - Whether files are served directly from the source - sync root instead of being copied into file_path. + Absolute workspace path of the deployment root — the + base path the deployed files live under. Mirrors + workspace.root_path in the DABs bundle config; file_path + is its files subdirectory. + source_linked: + type: boolean description: >- - Workspace location of the deployment, derived from the - latest version. - description: >- - The deployment to create. The caller must set - ``initial_parent_path``. Other fields are ignored on input - and populated by the service. - required: - - deployment + Whether files are served directly from the source sync + root instead of being copied into file_path. + description: Workspace location of the deployment. responses: '200': description: Success @@ -295,61 +302,20 @@ paths: description: |- Lists deployments in the workspace. - :param filter: str (optional) - A filter expression restricting which deployments are returned, in the style of AIP-160 - (https://google.aip.dev/160). The expression is a conjunction of one or more ``field operator - value`` terms joined by ``AND`` (case-insensitive); a deployment is returned only when it matches - every term. Whitespace around terms is ignored, and a value containing spaces must be wrapped in - double quotes. An unset or empty filter returns all deployments. Filtering applies only to live - deployments; deleted deployments are never returned regardless of the filter. - - Supported terms: - - - ``status = ``: exact match on the deployment status. The value is a ``DeploymentStatus`` - enum value, with or without the ``DEPLOYMENT_STATUS_`` prefix and case-insensitive (e.g. ``status - = ACTIVE``). - - ``deployment_mode = ``: exact match on the deployment mode. The value is a - ``DeploymentMode`` enum value, with or without the ``DEPLOYMENT_MODE_`` prefix and - case-insensitive (e.g. ``deployment_mode = DEVELOPMENT``). - - ``display_name = ""``: exact match on the display name. - - ``display_name : ""``: case-insensitive substring match on the display name. - - For example: ``status = ACTIVE AND display_name : "etl"``. :param page_size: int (optional) The maximum number of deployments to return. The service may return fewer than this value. If - unspecified, at most 20 deployments will be returned. The maximum value is 100; values above 100 - will be coerced to 100. + unspecified, at most 20 deployments will be returned. The maximum value is 1000; values above 1000 + will be coerced to 1000. :param page_token: str (optional) A page token, received from a previous ``ListDeployments`` call. Provide this to retrieve the subsequent page. + :param show_deleted: bool (optional) + Whether to include soft-deleted deployments in the response. Defaults to false. When true, returns + both live and soft-deleted deployments visible to the caller, subject to the filter. Soft-deleted + deployments have status ``DEPLOYMENT_STATUS_DELETED``. :returns: Iterator over :class:`Deployment` parameters: - - name: filter - in: query - required: false - schema: - type: string - description: >- - A filter expression restricting which deployments are returned, in - the style of AIP-160 (https://google.aip.dev/160). The expression is - a conjunction of one or more ``field operator value`` terms joined - by ``AND`` (case-insensitive); a deployment is returned only when it - matches every term. Whitespace around terms is ignored, and a value - containing spaces must be wrapped in double quotes. An unset or - empty filter returns all deployments. Filtering applies only to live - deployments; deleted deployments are never returned regardless of - the filter. Supported terms: - ``status = ``: exact match on - the deployment status. The value is a ``DeploymentStatus`` enum - value, with or without the ``DEPLOYMENT_STATUS_`` prefix and - case-insensitive (e.g. ``status = ACTIVE``). - ``deployment_mode = - ``: exact match on the deployment mode. The value is a - ``DeploymentMode`` enum value, with or without the - ``DEPLOYMENT_MODE_`` prefix and case-insensitive (e.g. - ``deployment_mode = DEVELOPMENT``). - ``display_name = ""``: - exact match on the display name. - ``display_name : ""``: - case-insensitive substring match on the display name. For example: - ``status = ACTIVE AND display_name : "etl"``. - name: page_size in: query required: false @@ -358,8 +324,8 @@ paths: description: >- The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 20 deployments will - be returned. The maximum value is 100; values above 100 will be - coerced to 100. + be returned. The maximum value is 1000; values above 1000 will be + coerced to 1000. - name: page_token in: query required: false @@ -368,6 +334,16 @@ paths: description: >- A page token, received from a previous ``ListDeployments`` call. Provide this to retrieve the subsequent page. + - name: show_deleted + in: query + required: false + schema: + type: boolean + description: >- + Whether to include soft-deleted deployments in the response. + Defaults to false. When true, returns both live and soft-deleted + deployments visible to the caller, subject to the filter. + Soft-deleted deployments have status ``DEPLOYMENT_STATUS_DELETED``. responses: '200': description: Success @@ -387,231 +363,280 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - /api/2.0/bundle/{parent}/operations: + /api/2.0/bundle/deployments/{deployment_id}/versions: post: - operationId: bundle_deployments_create_operation - summary: Creates a resource operation under a version. + operationId: bundle_deployments_create_version + summary: Creates a new version under a deployment. tags: - bundledeployments - bundle_deployments description: >- - Creates a resource operation under a version. + Creates a new version under a deployment. + + + Creating a version acquires an exclusive lock on the deployment, + preventing concurrent deploys. The + + caller provides a ``version_id``, a numeric string that must be + numerically greater than the + + deployment's most recent version, and sets the version's + ``previous_version_id`` to the deployment's + + most recent version (leaving it unset for the first version), which the + server validates to detect + concurrent deploys. - The caller must provide a ``resource_key`` which becomes the final - component of the operation's name. - If an operation with the same key already exists under the version, the - server returns + The caller also provides the full set of ``operations`` planned for this + version, each identified by a - ``ALREADY_EXISTS``. + ``resource_key`` and an ``action_type``. The server records one + operation per resource in + ``OPERATION_STATUS_PENDING`` in the same transaction as the version, so + the plan is captured - On success the server also updates the corresponding deployment-level - Resource (creating it if this is + atomically. The outcome of each operation is recorded later via + UpdateOperation as the resource is - the first operation for that resource_key, or removing it if action_type - is DELETE). + applied; the set of operations cannot be changed after the version is + created. :param parent: str - The parent version where this operation will be recorded. Format: - deployments/{deployment_id}/versions/{version_id} - :param operation: :class:`Operation` - The resource operation to create. - :param resource_key: str - The key identifying the resource this operation applies to. Becomes the final component of the - operation's name. + The parent deployment where this version will be created. Format: deployments/{deployment_id} + :param version: :class:`Version` + The version to create. + :param version_id: str + The ID to use for the version, which becomes the final component of the version's resource name. A + numeric string (base-10, fits in a signed 64-bit integer) chosen by the caller; must be greater than + or equal to 1. Must be numerically greater than the deployment's most recent version (see + ``version.previous_version_id``); it does not need to start at 1 or increase by exactly 1. If the + value is not numerically greater, the server returns ``INVALID_PARAMETER_VALUE``. - :returns: :class:`Operation` + :returns: :class:`Version` parameters: - - name: parent + - name: deployment_id in: path required: true schema: type: string description: >- - The parent version where this operation will be recorded. Format: - deployments/{deployment_id}/versions/{version_id} - - name: resource_key + The `deployment_id` segment of the `parent` resource name + (`deployments/{deployment_id}`). The parent deployment where this + version will be created. Format: deployments/{deployment_id} + - name: version_id in: query required: true schema: type: string description: >- - The key identifying the resource this operation applies to. Becomes - the final component of the operation's name. + The ID to use for the version, which becomes the final component of + the version's resource name. A numeric string (base-10, fits in a + signed 64-bit integer) chosen by the caller; must be greater than or + equal to 1. Must be numerically greater than the deployment's most + recent version (see ``version.previous_version_id``); it does not + need to start at 1 or increase by exactly 1. If the value is not + numerically greater, the server returns ``INVALID_PARAMETER_VALUE``. requestBody: content: application/json: schema: type: object properties: - operation: + cli_version: + type: string + description: CLI version used to initiate the version. + version_type: + type: string + x-enum: + - VERSION_TYPE_DEPLOY + - VERSION_TYPE_DESTROY + description: Type of version (deploy or destroy). + complete_time: + type: string + format: date-time + description: >- + When the version completed. Unset while the version is in + progress. + completed_by: + type: string + description: >- + The user who completed the version (email or principal + name). May differ from ``created_by`` when another user + force-completes the version. + completion_reason: + type: string + x-enum: + - VERSION_COMPLETE_FAILURE + - VERSION_COMPLETE_FORCE_ABORT + - VERSION_COMPLETE_LEASE_EXPIRED + - VERSION_COMPLETE_SUCCESS + description: >- + Why the version was completed. Unset while in progress. Set + when status transitions to COMPLETED. + create_time: + type: string + format: date-time + description: When the version was created. + created_by: + type: string + description: The user who created the version (email or principal name). + deployment_mode: + type: string + x-enum: + - DEPLOYMENT_MODE_DEVELOPMENT + - DEPLOYMENT_MODE_PRODUCTION + description: >- + Bundle target deployment mode (development or production), + captured at the time of this version. + display_name: + type: string + description: >- + Display name for the deployment, captured at the time of + this version. Up to 256 characters. When present, creating + the version updates the deployment display name. An empty + value clears it; an absent value leaves the current + deployment display name unchanged. + git_info: type: object properties: - action_type: - type: string - x-enum: - - OPERATION_ACTION_TYPE_BIND - - OPERATION_ACTION_TYPE_BIND_AND_UPDATE - - OPERATION_ACTION_TYPE_CREATE - - OPERATION_ACTION_TYPE_DELETE - - OPERATION_ACTION_TYPE_INITIAL_REGISTER - - OPERATION_ACTION_TYPE_RECREATE - - OPERATION_ACTION_TYPE_RESIZE - - OPERATION_ACTION_TYPE_UPDATE - - OPERATION_ACTION_TYPE_UPDATE_WITH_ID - description: The type of operation performed on this resource. - status: + branch: type: string - x-enum: - - OPERATION_STATUS_FAILED - - OPERATION_STATUS_SUCCEEDED - description: >- - Whether the operation succeeded or failed. Mutable: may - be updated after creation via UpdateOperation, e.g. when - an operation recorded as failed is retried and - eventually succeeds. A succeeded operation cannot carry - an ``error_message``. - create_time: + description: Branch the source was deployed from. + commit: type: string - format: date-time - description: When the operation was recorded. - dashboard_metadata: - type: object - properties: - definition_path: - type: string - description: >- - Path of the file that declares this dashboard, - relative to the bundle's workspace.file_path - (Version.workspace_info.file_path) — join the two to - get the file's absolute workspace path. For now this - lives only on the dashboard metadata, and is a - single string because it was a single string - (``relative_path``) in the legacy bundle - metadata.json. We may generalize it in the future: - lifting it to a top-level field on - Resource/Operation (every resource type has a - definition location) and converting it to a repeated - field, since a resource can be declared across - multiple files/locations. - source_path: - type: string - description: >- - Path of the dashboard's source artifact (its - ``.lvdash.json``), relative to the deployment root. - description: >- - Dashboard-specific metadata; set only for dashboard - resources. - error_message: + description: Commit SHA of the deployed source. + origin_url: type: string - description: >- - Error message if the operation failed. Set when status - is OPERATION_STATUS_FAILED. Captures the error - encountered while applying the resource to the - workspace. Mutable: may be updated after creation via - UpdateOperation; setting it to an empty string clears - it. After an update is applied, an operation whose - status is OPERATION_STATUS_SUCCEEDED cannot carry an - error_message. - name: + description: URL of the git remote the source was deployed from. + description: >- + Git provenance of the source, captured at the time of this + version. + name: + type: string + description: >- + Resource name of the version. Format: + deployments/{deployment_id}/versions/{version_id} + operations: + type: array + items: + type: object + properties: + resource_key: + type: string + description: >- + The key identifying the resource this operation + applies to (e.g. "jobs.foo", "pipelines.bar"). Becomes + the final component of the operation's name and must + be unique among the operations in the version. + action_type: + type: string + x-enum: + - OPERATION_ACTION_TYPE_BIND + - OPERATION_ACTION_TYPE_BIND_AND_UPDATE + - OPERATION_ACTION_TYPE_CREATE + - OPERATION_ACTION_TYPE_DELETE + - OPERATION_ACTION_TYPE_INITIAL_REGISTER + - OPERATION_ACTION_TYPE_RECREATE + - OPERATION_ACTION_TYPE_RESIZE + - OPERATION_ACTION_TYPE_UNBIND + - OPERATION_ACTION_TYPE_UPDATE + - OPERATION_ACTION_TYPE_UPDATE_WITH_ID + description: The type of operation planned for this resource. + required: + - resource_key + - action_type + description: >- + A resource operation to record when a version is created. + Each staged operation identifies the + resource it applies to and the action planned for it; the server records the operation in + ``OPERATION_STATUS_PENDING``, and its outcome is filled in later via UpdateOperation. + description: >- + The full operation plan for this version: one PENDING + operation per entry, recorded in the same transaction. Input + only -- supplied on create and never returned by + create/get/list; read the recorded operations via + ListOperations. + previous_version_id: + type: string + description: >- + The version_id this version was created on top of — the + deployment's most recent version at creation time. Leave + unset when creating the first version (the deployment has no + prior versions). Set by the client on creation and immutable + thereafter. Acts as an optimistic-concurrency precondition: + the server requires it to equal the deployment's current + most-recent version (and to be unset when the deployment has + no versions) and returns ``INVALID_PARAMETER_VALUE`` on + mismatch, so a deploy racing against a concurrent deploy is + rejected rather than silently overwriting it. + status: + type: string + x-enum: + - VERSION_STATUS_COMPLETED + - VERSION_STATUS_IN_PROGRESS + description: 'Status of the version: IN_PROGRESS or COMPLETED.' + target_name: + type: string + description: >- + Target name of the deployment, captured at the time of this + version. + version_id: + type: string + description: >- + Version identifier within the parent deployment, assigned by + the client on creation. A numeric string (base-10, fits in a + signed 64-bit integer) that is greater than or equal to 1. + Version IDs are strictly increasing within a deployment but + are not required to start at 1 or to be contiguous. + workspace_info: + type: object + properties: + bundle_root_path: type: string description: >- - Resource name of the operation. Format: - deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} - resource_id: + Path of the bundle root (the directory containing + databricks.yml) relative to git_folder_path. Empty when + the deployment is not from a Databricks Git folder. + file_path: type: string description: >- - ID of the actual resource in the workspace (e.g. the job - ID, pipeline ID). Optional at creation: CREATE and - RECREATE operations produce a new resource whose ID is - not yet known when the operation is recorded. Mutable: - may be filled in (or corrected) later via - UpdateOperation once the ID is known. - resource_key: + Absolute workspace path where the deployed bundle files + live. Mirrors the workspace.file_path field in DABs + bundle config. + git_folder_path: type: string description: >- - Resource identifier within the bundle (e.g. "jobs.foo", - "pipelines.bar", "jobs.foo.permissions", - "files."). Can be an arbitrary UTF-8 encoded - string key. This key links the operation to the - corresponding deployment-level Resource. - resource_type: + When deployed from a Databricks Git folder, the absolute + workspace path of that folder; empty for local deploys. + root_path: type: string - x-enum: - - DEPLOYMENT_RESOURCE_TYPE_ALERT - - DEPLOYMENT_RESOURCE_TYPE_APP - - DEPLOYMENT_RESOURCE_TYPE_CATALOG - - DEPLOYMENT_RESOURCE_TYPE_CLUSTER - - DEPLOYMENT_RESOURCE_TYPE_DASHBOARD - - DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG - - DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE - - DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT - - DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION - - DEPLOYMENT_RESOURCE_TYPE_JOB - - DEPLOYMENT_RESOURCE_TYPE_MODEL - - DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT - - DEPLOYMENT_RESOURCE_TYPE_PIPELINE - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT - - DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR - - DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL - - DEPLOYMENT_RESOURCE_TYPE_SCHEMA - - DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE - - DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE - - DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE - - DEPLOYMENT_RESOURCE_TYPE_VOLUME description: >- - The type of the deployment resource this operation - applies to. Derived from the ``resource_key`` prefix - (e.g. "jobs" → JOB); the caller does not set this field. - sequence_id: - type: integer + Absolute workspace path of the deployment root — the + base path the deployed files live under. Mirrors + workspace.root_path in the DABs bundle config; file_path + is its files subdirectory. + source_linked: + type: boolean description: >- - Monotonically increasing revision used for optimistic - concurrency control (the AIP-154 concurrency token for - this resource, realized as a sequence number rather than - an opaque etag). The server assigns 1 on creation and - increments it on every successful UpdateOperation. It is - OPTIONAL rather than OUTPUT_ONLY because it is - dual-purpose: CreateOperation/GetOperation return the - current value, and UpdateOperation reads the - caller-supplied value as a precondition. The caller must - echo the value it last observed; if it no longer matches - the server's value, the update is rejected with ABORTED - so the caller can re-read and retry. Ignored on - CreateOperation. - state: - type: object - description: >- - Serialized local config state after the operation. - Should be unset for delete operations. Mutable: may be - updated after creation via UpdateOperation. When - updating, the caller must echo the last-observed - ``sequence_id`` as a concurrency precondition. - update_time: - type: string - format: date-time - description: >- - When the operation was last updated. Set to - ``create_time`` when the operation is created and to the - server timestamp on each successful UpdateOperation. - required: - - action_type - - status - description: The resource operation to create. + Whether files are served directly from the source sync + root instead of being copied into file_path. + description: >- + Workspace location of the deployment, captured at the time + of this version. required: - - operation + - cli_version + - version_type responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Version' default: description: Error response content: @@ -625,51 +650,56 @@ paths: type: string x-stackql-sdk-source: BundleDeploymentsAPI get: - operationId: bundle_deployments_list_operations - summary: Lists resource operations under a version. + operationId: bundle_deployments_list_versions + summary: >- + Lists versions under a deployment, ordered numerically by version_id + descending (most recent first). tags: - bundledeployments - bundle_deployments - description: |- - Lists resource operations under a version. + description: >- + Lists versions under a deployment, ordered numerically by version_id + descending (most recent first). + :param parent: str - The parent version. Format: deployments/{deployment_id}/versions/{version_id} + The parent deployment. Format: deployments/{deployment_id} :param page_size: int (optional) - The maximum number of operations to return. The service may return fewer than this value. If - unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 - will be coerced to 1000. + The maximum number of versions to return. The service may return fewer than this value. If + unspecified, at most 20 versions will be returned. The maximum value is 100; values above 100 will + be coerced to 100. :param page_token: str (optional) - A page token, received from a previous ``ListOperations`` call. Provide this to retrieve the + A page token, received from a previous ``ListVersions`` call. Provide this to retrieve the subsequent page. - :returns: Iterator over :class:`Operation` + :returns: Iterator over :class:`Version` parameters: - - name: parent + - name: deployment_id in: path required: true schema: type: string description: >- - The parent version. Format: - deployments/{deployment_id}/versions/{version_id} + The `deployment_id` segment of the `parent` resource name + (`deployments/{deployment_id}`). The parent deployment. Format: + deployments/{deployment_id} - name: page_size in: query required: false schema: type: integer description: >- - The maximum number of operations to return. The service may return - fewer than this value. If unspecified, at most 50 operations will be - returned. The maximum value is 1000; values above 1000 will be - coerced to 1000. + The maximum number of versions to return. The service may return + fewer than this value. If unspecified, at most 20 versions will be + returned. The maximum value is 100; values above 100 will be coerced + to 100. - name: page_token in: query required: false schema: type: string description: >- - A page token, received from a previous ``ListOperations`` call. + A page token, received from a previous ``ListVersions`` call. Provide this to retrieve the subsequent page. responses: '200': @@ -677,7 +707,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/ListVersionsResponse' default: description: Error response content: @@ -690,235 +720,268 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - /api/2.0/bundle/{parent}/versions: - post: - operationId: bundle_deployments_create_version - summary: Creates a new version under a deployment. + /api/2.0/bundle/deployments/{deployment_id}: + delete: + operationId: bundle_deployments_delete_deployment + summary: Deletes a deployment. tags: - bundledeployments - bundle_deployments - description: >- - Creates a new version under a deployment. - - - Creating a version acquires an exclusive lock on the deployment, - preventing concurrent deploys. The - - caller provides a ``version_id``, a numeric string that must be - numerically greater than the - - deployment's most recent version, and sets the version's - ``previous_version_id`` to the deployment's + description: |- + Deletes a deployment. - most recent version (leaving it unset for the first version), which the - server validates to detect + :param name: str + Resource name of the deployment to delete. Format: deployments/{deployment_id} + parameters: + - name: deployment_id + in: path + required: true + schema: + type: string + description: >- + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}`). Resource name of the deployment to + delete. Format: deployments/{deployment_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: BundleDeploymentsAPI + get: + operationId: bundle_deployments_get_deployment + summary: Retrieves a deployment by its resource name. + tags: + - bundledeployments + - bundle_deployments + description: |- + Retrieves a deployment by its resource name. - concurrent deploys. + :param name: str + Resource name of the deployment to retrieve. Format: deployments/{deployment_id} + :returns: :class:`Deployment` + parameters: + - name: deployment_id + in: path + required: true + schema: + type: string + description: >- + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}`). Resource name of the deployment to + retrieve. Format: deployments/{deployment_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Deployment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: BundleDeploymentsAPI + patch: + operationId: bundle_deployments_update_deployment + summary: Updates a deployment. + tags: + - bundledeployments + - bundle_deployments + description: |- + Updates a deployment. - :param parent: str - The parent deployment where this version will be created. Format: deployments/{deployment_id} - :param version: :class:`Version` - The version to create. - :param version_id: str - The ID to use for the version, which becomes the final component of the version's resource name. A - numeric string (base-10, fits in a signed 64-bit integer) chosen by the caller; must be greater than - or equal to 1. Must be numerically greater than the deployment's most recent version (see - ``version.previous_version_id``); it does not need to start at 1 or increase by exactly 1. If the - value is not numerically greater, the server returns ``INVALID_PARAMETER_VALUE``. + :param name: str + Resource name of the deployment. Format: deployments/{deployment_id} + :param deployment: :class:`Deployment` + The deployment to update. Its ``name`` selects the deployment; the fields named in ``update_mask`` + carry the new values. All other fields are ignored. + :param update_mask: FieldMask + The fields to update; supported paths are ``display_name``, ``deployment_mode``, ``target_name``, + and ``workspace_info``. An empty mask or any other path returns INVALID_PARAMETER_VALUE. - :returns: :class:`Version` + :returns: :class:`Deployment` parameters: - - name: parent + - name: deployment_id in: path required: true schema: type: string description: >- - The parent deployment where this version will be created. Format: - deployments/{deployment_id} - - name: version_id + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}`). Resource name of the deployment. + Format: deployments/{deployment_id} + - name: update_mask in: query required: true schema: - type: string + type: object description: >- - The ID to use for the version, which becomes the final component of - the version's resource name. A numeric string (base-10, fits in a - signed 64-bit integer) chosen by the caller; must be greater than or - equal to 1. Must be numerically greater than the deployment's most - recent version (see ``version.previous_version_id``); it does not - need to start at 1 or increase by exactly 1. If the value is not - numerically greater, the server returns ``INVALID_PARAMETER_VALUE``. + The fields to update; supported paths are ``display_name``, + ``deployment_mode``, ``target_name``, and ``workspace_info``. An + empty mask or any other path returns INVALID_PARAMETER_VALUE. requestBody: content: application/json: schema: type: object properties: - version: + create_time: + type: string + format: date-time + description: When the deployment was created. + created_by: + type: string + description: >- + The user who created the deployment (email or principal + name). Empty if authoritative deployment metadata does not + identify a creator or the principal cannot be resolved. + deployment_mode: + type: string + x-enum: + - DEPLOYMENT_MODE_DEVELOPMENT + - DEPLOYMENT_MODE_PRODUCTION + description: Bundle target deployment mode (development or production). + destroy_time: + type: string + format: date-time + description: >- + When deletion was recorded. Unset if deletion has not been + recorded. This response metadata does not determine the + deployment's lifecycle status. + destroyed_by: + type: string + description: >- + The user who destroyed the deployment (email or principal + name). Unset if the deployment has not been destroyed. + display_name: + type: string + description: >- + Human-readable name for the deployment, up to 256 + characters. + git_info: type: object properties: - cli_version: - type: string - description: CLI version used to initiate the version. - version_type: - type: string - x-enum: - - VERSION_TYPE_DEPLOY - - VERSION_TYPE_DESTROY - description: Type of version (deploy or destroy). - complete_time: - type: string - format: date-time - description: >- - When the version completed. Unset while the version is - in progress. - completed_by: - type: string - description: >- - The user who completed the version (email or principal - name). May differ from ``created_by`` when another user - force-completes the version. - completion_reason: - type: string - x-enum: - - VERSION_COMPLETE_FAILURE - - VERSION_COMPLETE_FORCE_ABORT - - VERSION_COMPLETE_LEASE_EXPIRED - - VERSION_COMPLETE_SUCCESS - description: >- - Why the version was completed. Unset while in progress. - Set when status transitions to COMPLETED. - create_time: - type: string - format: date-time - description: When the version was created. - created_by: + branch: type: string - description: >- - The user who created the version (email or principal - name). - deployment_mode: + description: Branch the source was deployed from. + commit: type: string - x-enum: - - DEPLOYMENT_MODE_DEVELOPMENT - - DEPLOYMENT_MODE_PRODUCTION - description: >- - Bundle target deployment mode (development or - production), captured at the time of this version. - display_name: + description: Commit SHA of the deployed source. + origin_url: type: string - description: >- - Display name for the deployment, captured at the time of - this version. Up to 256 characters. When present, - creating the version updates the deployment display - name. An empty value clears it; an absent value leaves - the current deployment display name unchanged. - git_info: - type: object - properties: - branch: - type: string - description: Branch the source was deployed from. - commit: - type: string - description: Commit SHA of the deployed source. - origin_url: - type: string - description: URL of the git remote the source was deployed from. - description: >- - Git provenance of the source, captured at the time of - this version. - name: + description: URL of the git remote the source was deployed from. + description: >- + Git provenance of the deployment's source, derived from the + latest version. + initial_parent_path: + type: string + description: >- + The workspace path of the existing folder where the + deployment is initially created. Must be absolute and + canonical, with single separators, no ``.`` or ``..`` + segments, and no trailing slash unless the path is ``/``. It + may contain at most 24 path segments, excluding an optional + leading ``/Workspace`` segment. The complete path may + contain up to 1,024 characters, and each segment may contain + up to 511 characters. This field is input only and is not + returned in create, get, or list responses. + last_successful_version_id: + type: string + description: >- + The version_id of the most recent version that completed + successfully. Unset until a version has completed + successfully. Unlike last_version_id, it is not advanced + when a version fails, so it always points at the last + known-good deployment state (or is unset if there has never + been one). + last_version_id: + type: string + description: The version_id of the most recent deployment version. + name: + type: string + description: >- + Resource name of the deployment. Format: + deployments/{deployment_id} + status: + type: string + x-enum: + - DEPLOYMENT_STATUS_ACTIVE + - DEPLOYMENT_STATUS_DELETED + - DEPLOYMENT_STATUS_FAILED + - DEPLOYMENT_STATUS_IN_PROGRESS + description: Current status of the deployment. + target_name: + type: string + description: The bundle target name associated with this deployment. + update_time: + type: string + format: date-time + description: When the deployment was last updated. + updated_by: + type: string + description: >- + The user who most recently updated the deployment (email or + principal name). Empty if authoritative deployment metadata + does not identify a modifier or the principal cannot be + resolved. + workspace_info: + type: object + properties: + bundle_root_path: type: string description: >- - Resource name of the version. Format: - deployments/{deployment_id}/versions/{version_id} - previous_version_id: + Path of the bundle root (the directory containing + databricks.yml) relative to git_folder_path. Empty when + the deployment is not from a Databricks Git folder. + file_path: type: string description: >- - The version_id this version was created on top of — the - deployment's most recent version at creation time. Leave - unset when creating the first version (the deployment - has no prior versions). Set by the client on creation - and immutable thereafter. Acts as an - optimistic-concurrency precondition: the server requires - it to equal the deployment's current most-recent version - (and to be unset when the deployment has no versions) - and returns ``INVALID_PARAMETER_VALUE`` on mismatch, so - a deploy racing against a concurrent deploy is rejected - rather than silently overwriting it. - status: - type: string - x-enum: - - VERSION_STATUS_COMPLETED - - VERSION_STATUS_IN_PROGRESS - description: 'Status of the version: IN_PROGRESS or COMPLETED.' - target_name: + Absolute workspace path where the deployed bundle files + live. Mirrors the workspace.file_path field in DABs + bundle config. + git_folder_path: type: string description: >- - Target name of the deployment, captured at the time of - this version. - version_id: + When deployed from a Databricks Git folder, the absolute + workspace path of that folder; empty for local deploys. + root_path: type: string description: >- - Version identifier within the parent deployment, - assigned by the client on creation. A numeric string - (base-10, fits in a signed 64-bit integer) that is - greater than or equal to 1. Version IDs are strictly - increasing within a deployment but are not required to - start at 1 or to be contiguous. - workspace_info: - type: object - properties: - bundle_root_path: - type: string - description: >- - Path of the bundle root (the directory containing - databricks.yml) relative to git_folder_path. Empty - when the deployment is not from a Databricks Git - folder. - file_path: - type: string - description: >- - Absolute workspace path where the deployed bundle - files live. Mirrors the workspace.file_path field in - DABs bundle config. - git_folder_path: - type: string - description: >- - When deployed from a Databricks Git folder, the - absolute workspace path of that folder; empty for - local deploys. - root_path: - type: string - description: >- - Absolute workspace path of the deployment root — the - base path the deployed files live under. Mirrors - workspace.root_path in the DABs bundle config; - file_path is its files subdirectory. - source_linked: - type: boolean - description: >- - Whether files are served directly from the source - sync root instead of being copied into file_path. + Absolute workspace path of the deployment root — the + base path the deployed files live under. Mirrors + workspace.root_path in the DABs bundle config; file_path + is its files subdirectory. + source_linked: + type: boolean description: >- - Workspace location of the deployment, captured at the - time of this version. - required: - - cli_version - - version_type - description: The version to create. - required: - - version + Whether files are served directly from the source sync + root instead of being copied into file_path. + description: Workspace location of the deployment. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Version' + $ref: '#/components/schemas/Deployment' default: description: Error response content: @@ -931,62 +994,361 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI + /api/2.0/bundle/deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}: get: - operationId: bundle_deployments_list_versions - summary: >- - Lists versions under a deployment, ordered numerically by version_id - descending (most recent first). + operationId: bundle_deployments_get_operation + summary: Retrieves a resource operation by its resource name. + tags: + - bundledeployments + - bundle_deployments + description: |- + Retrieves a resource operation by its resource name. + + :param name: str + The name of the resource operation to retrieve. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + + :returns: :class:`Operation` + parameters: + - name: deployment_id + in: path + required: true + schema: + type: string + description: >- + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + The name of the resource operation to retrieve. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + - name: version_id + in: path + required: true + schema: + type: string + description: >- + The `version_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + The name of the resource operation to retrieve. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + - name: resource_key + in: path + required: true + schema: + type: string + description: >- + The `resource_key` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + The name of the resource operation to retrieve. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: BundleDeploymentsAPI + patch: + operationId: bundle_deployments_update_operation + summary: Updates a resource operation's mutable fields. tags: - bundledeployments - bundle_deployments description: >- - Lists versions under a deployment, ordered numerically by version_id - descending (most recent first). + Updates a resource operation's mutable fields. - :param parent: str - The parent deployment. Format: deployments/{deployment_id} - :param page_size: int (optional) - The maximum number of versions to return. The service may return fewer than this value. If - unspecified, at most 20 versions will be returned. The maximum value is 100; values above 100 will - be coerced to 100. - :param page_token: str (optional) - A page token, received from a previous ``ListVersions`` call. Provide this to retrieve the - subsequent page. + ``state``, ``error_message``, ``resource_id``, ``status``, and + ``dashboard_metadata`` may be updated, - :returns: Iterator over :class:`Version` + independently; ``update_mask`` must contain only those paths. All other + fields are immutable. The + + update is guarded by an optimistic-concurrency check: the caller sets + ``operation.sequence_id`` to the + + value it last observed, and the server rejects the update with + ``ABORTED`` if the operation has been + + modified since. On success the server increments ``sequence_id``; + updates to ``state``, + + ``resource_id``, and ``dashboard_metadata`` are mirrored onto the + corresponding deployment-level + + resource. Listing ``state`` in ``update_mask`` with no value clears it, + which removes the tracked + + resource, so a delete or unbind that succeeds must clear ``state``. The + parent version must be in + + progress, and after the update is applied a succeeded operation cannot + carry an ``error_message``. See + + the ``state`` and ``resource_id`` fields for the rest. + + + :param name: str + Resource name of the operation. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + :param operation: :class:`Operation` + The operation to update. Its ``name`` selects the operation; the fields named in ``update_mask`` + carry the new values; and ``sequence_id`` carries the optimistic-concurrency precondition (see the + field docs on Operation). All other fields are ignored. + :param update_mask: FieldMask + The set of fields to update. Required; supported paths are ``state``, ``error_message``, + ``resource_id``, ``status``, and ``dashboard_metadata``. An empty mask or any other path is rejected + with INVALID_PARAMETER_VALUE. + + :returns: :class:`Operation` parameters: - - name: parent + - name: deployment_id in: path required: true schema: type: string - description: 'The parent deployment. Format: deployments/{deployment_id}' - - name: page_size - in: query - required: false + description: >- + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + Resource name of the operation. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + - name: version_id + in: path + required: true schema: - type: integer + type: string description: >- - The maximum number of versions to return. The service may return - fewer than this value. If unspecified, at most 20 versions will be - returned. The maximum value is 100; values above 100 will be coerced - to 100. - - name: page_token - in: query - required: false + The `version_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + Resource name of the operation. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + - name: resource_key + in: path + required: true schema: type: string description: >- - A page token, received from a previous ``ListVersions`` call. - Provide this to retrieve the subsequent page. + The `resource_key` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}`). + Resource name of the operation. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + The set of fields to update. Required; supported paths are + ``state``, ``error_message``, ``resource_id``, ``status``, and + ``dashboard_metadata``. An empty mask or any other path is rejected + with INVALID_PARAMETER_VALUE. + requestBody: + content: + application/json: + schema: + type: object + properties: + action_type: + type: string + x-enum: + - OPERATION_ACTION_TYPE_BIND + - OPERATION_ACTION_TYPE_BIND_AND_UPDATE + - OPERATION_ACTION_TYPE_CREATE + - OPERATION_ACTION_TYPE_DELETE + - OPERATION_ACTION_TYPE_INITIAL_REGISTER + - OPERATION_ACTION_TYPE_RECREATE + - OPERATION_ACTION_TYPE_RESIZE + - OPERATION_ACTION_TYPE_UNBIND + - OPERATION_ACTION_TYPE_UPDATE + - OPERATION_ACTION_TYPE_UPDATE_WITH_ID + description: >- + The type of operation performed on this resource. Set when + the version is created and immutable thereafter. + create_time: + type: string + format: date-time + description: When the operation was recorded. + dashboard_metadata: + type: object + properties: + definition_path: + type: string + description: >- + Path of the file that declares this dashboard, relative + to the bundle's workspace.file_path + (Deployment.workspace_info.file_path) — join the two to + get the file's absolute workspace path. For now this + lives only on the dashboard metadata, and is a single + string because it was a single string + (``relative_path``) in the legacy bundle metadata.json. + We may generalize it in the future: lifting it to a + top-level field on Resource/Operation (every resource + type has a definition location) and converting it to a + repeated field, since a resource can be declared across + multiple files/locations. + source_path: + type: string + description: >- + Path of the dashboard's source artifact (its + ``.lvdash.json``), relative to the deployment root. + description: >- + Dashboard-specific metadata; set only for dashboard + resources. Mutable: may be set or updated via + UpdateOperation as the resource is applied, and is mirrored + onto the corresponding deployment-level resource. + error_message: + type: string + description: >- + Error message if the operation failed. Set when status is + OPERATION_STATUS_FAILED. Captures the error encountered + while applying the resource to the workspace. Mutable: may + be updated after creation via UpdateOperation; setting it to + an empty string clears it. After an update is applied, an + operation whose status is OPERATION_STATUS_SUCCEEDED cannot + carry an error_message. + name: + type: string + description: >- + Resource name of the operation. Format: + deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} + resource_id: + type: string + description: >- + ID of the actual resource in the workspace (e.g. the job ID, + pipeline ID). Required whenever ``state`` is set, because + state records a resource that exists. A CREATE or RECREATE + that has not produced its resource yet records neither. + Mutable: may be filled in (or corrected) later via + UpdateOperation once the ID is known. + resource_key: + type: string + description: >- + Resource identifier within the bundle (e.g. "jobs.foo", + "pipelines.bar", "jobs.foo.permissions", + "files."). Can be an arbitrary UTF-8 encoded + string key. This key links the operation to the + corresponding deployment-level Resource. Set when the + version is created and immutable thereafter. + resource_type: + type: string + x-enum: + - DEPLOYMENT_RESOURCE_TYPE_ALERT + - DEPLOYMENT_RESOURCE_TYPE_APP + - DEPLOYMENT_RESOURCE_TYPE_CATALOG + - DEPLOYMENT_RESOURCE_TYPE_CLUSTER + - DEPLOYMENT_RESOURCE_TYPE_CLUSTER_POLICY + - DEPLOYMENT_RESOURCE_TYPE_DASHBOARD + - DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG + - DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE + - DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT + - DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION + - DEPLOYMENT_RESOURCE_TYPE_GENIE_SPACE + - DEPLOYMENT_RESOURCE_TYPE_INSTANCE_POOL + - DEPLOYMENT_RESOURCE_TYPE_JOB + - DEPLOYMENT_RESOURCE_TYPE_JOB_RUN + - DEPLOYMENT_RESOURCE_TYPE_MODEL + - DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT + - DEPLOYMENT_RESOURCE_TYPE_PIPELINE + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_CATALOG + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_DATABASE + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ROLE + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_SYNCED_TABLE + - DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR + - DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL + - DEPLOYMENT_RESOURCE_TYPE_SCHEMA + - DEPLOYMENT_RESOURCE_TYPE_SECRET + - DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE + - DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE + - DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE + - DEPLOYMENT_RESOURCE_TYPE_VECTOR_SEARCH_ENDPOINT + - DEPLOYMENT_RESOURCE_TYPE_VECTOR_SEARCH_INDEX + - DEPLOYMENT_RESOURCE_TYPE_VOLUME + description: >- + The type of the deployment resource this operation applies + to. Derived from the ``resource_key`` prefix (e.g. "jobs" → + JOB); the caller does not set this field. + sequence_id: + type: integer + description: >- + Monotonically increasing revision used for optimistic + concurrency control (the AIP-154 concurrency token for this + resource, realized as a sequence number rather than an + opaque etag). The server assigns 0 when the operation is + created and increments it on every successful + UpdateOperation, so a never-updated operation is at 0 and + the first successful update makes it 1. It is OPTIONAL + rather than OUTPUT_ONLY because it is dual-purpose: + GetOperation returns the current value, and UpdateOperation + reads the caller-supplied value as a precondition. The + caller must echo the value it last observed; if it no longer + matches the server's value, the update is rejected with + ABORTED so the caller can re-read and retry. + state: + type: string + description: >- + Serialized local config state after the operation. Its + presence records whether the resource is still tracked by + the deployment. Explicitly clearing state removes the + resource from the deployment; omitting it from the update + mask leaves resource state unchanged. State is stored only + on Resources. UpdateOperation accepts state but omits it + from its response, as do subsequent GetOperation and + ListOperations. Mutable: may be updated after creation via + UpdateOperation. When updating, the caller must echo the + last-observed ``sequence_id`` as a concurrency precondition. + The string is not parsed; it is projected onto the + corresponding Resource's state. It is deliberately not + google.protobuf.Value, whose only numeric case is ``double + number_value``, so parsing the client's JSON into it + rewrites every integer as a double - ``1`` reads back as + ``1.0``, which no longer deserializes into an integer field + - and silently loses precision above 2^53, which is within + range for IDs the client records. A string rather than + bytes: the payload is always UTF-8 JSON, and proto3 JSON + maps bytes to base64, which inflates every request and + response by a third and makes state unreadable in logs and + API responses. Both generate the same OpenAPI schema + ("type": "string"), so the SDKs are identical either way. + status: + type: string + x-enum: + - OPERATION_STATUS_FAILED + - OPERATION_STATUS_PENDING + - OPERATION_STATUS_SUCCEEDED + description: >- + Status of the operation. Starts as OPERATION_STATUS_PENDING + when the version is created and moves to a terminal status + once the resource is applied. Mutable: updated via + UpdateOperation, e.g. when an operation recorded as failed + is retried and eventually succeeds. + update_time: + type: string + format: date-time + description: >- + When the operation was last updated. Set to ``create_time`` + when the operation is created and to the server timestamp on + each successful UpdateOperation. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListVersionsResponse' + $ref: '#/components/schemas/Operation' default: description: Error response content: @@ -999,30 +1361,48 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - /api/2.0/bundle/{name}: - delete: - operationId: bundle_deployments_delete_deployment - summary: Deletes a deployment. + /api/2.0/bundle/deployments/{deployment_id}/resources/{resource_key}: + get: + operationId: bundle_deployments_get_resource + summary: Retrieves a deployment resource by its resource name. tags: - bundledeployments - bundle_deployments description: |- - Deletes a deployment. + Retrieves a deployment resource by its resource name. :param name: str - Resource name of the deployment to delete. Format: deployments/{deployment_id} + The name of the resource to retrieve. Format: deployments/{deployment_id}/resources/{resource_key} + + :returns: :class:`Resource` parameters: - - name: name + - name: deployment_id in: path required: true schema: type: string description: >- - Resource name of the deployment to delete. Format: - deployments/{deployment_id} + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/resources/{resource_key}`). The name + of the resource to retrieve. Format: + deployments/{deployment_id}/resources/{resource_key} + - name: resource_key + in: path + required: true + schema: + type: string + description: >- + The `resource_key` segment of the `name` resource name + (`deployments/{deployment_id}/resources/{resource_key}`). The name + of the resource to retrieve. Format: + deployments/{deployment_id}/resources/{resource_key} responses: '200': description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' default: description: Error response content: @@ -1035,6 +1415,7 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI + /api/2.0/bundle/deployments/{deployment_id}/versions/{version_id}: get: operationId: bundle_deployments_get_version summary: Retrieves a version by its resource name. @@ -1049,13 +1430,25 @@ paths: :returns: :class:`Version` parameters: - - name: name + - name: deployment_id + in: path + required: true + schema: + type: string + description: >- + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The name of + the version to retrieve. Format: + deployments/{deployment_id}/versions/{version_id} + - name: version_id in: path required: true schema: type: string description: >- - The name of the version to retrieve. Format: + The `version_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The name of + the version to retrieve. Format: deployments/{deployment_id}/versions/{version_id} responses: '200': @@ -1076,248 +1469,58 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - patch: - operationId: bundle_deployments_update_operation - summary: Updates a resource operation's mutable fields. + /api/2.0/bundle/deployments/{deployment_id}/versions/{version_id}/heartbeat: + post: + operationId: bundle_deployments_heartbeat + summary: Sends a heartbeat to renew the lock held by a version. tags: - bundledeployments - bundle_deployments description: >- - Updates a resource operation's mutable fields. - - - ``state``, ``error_message``, ``resource_id``, and ``status`` may be - updated, independently; - - ``update_mask`` must contain only those paths. All other fields are - immutable. The update is guarded - - by an optimistic-concurrency check: the caller sets - ``operation.sequence_id`` to the value it last - - observed, and the server rejects the update with ``ABORTED`` if the - operation has been modified since. + Sends a heartbeat to renew the lock held by a version. - On success the server increments ``sequence_id``; updates to ``state`` - and ``resource_id`` are - mirrored onto the corresponding deployment-level Resource projection. - The parent version must be in + The server validates that the version is the active (non-terminal) + version on the parent deployment - progress, delete operations cannot be updated, and after the update is - applied a succeeded operation + and resets the lock expiry. If the lock has already expired or the + version is no longer active, the - cannot carry an ``error_message``. + server returns ``ABORTED``. :param name: str - Resource name of the operation. Format: - deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} - :param operation: :class:`Operation` - The operation to update. Its ``name`` selects the operation; the fields named in ``update_mask`` - carry the new values; and ``sequence_id`` carries the optimistic-concurrency precondition (see the - field docs on Operation). All other fields are ignored. - :param update_mask: FieldMask - The set of fields to update. Required; supported paths are ``state``, ``error_message``, - ``resource_id``, and ``status``. An empty mask or any other path is rejected with - INVALID_PARAMETER_VALUE. + The version whose lock to renew. Format: deployments/{deployment_id}/versions/{version_id} - :returns: :class:`Operation` + :returns: :class:`HeartbeatResponse` parameters: - - name: name + - name: deployment_id in: path required: true schema: type: string description: >- - Resource name of the operation. Format: - deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} - - name: update_mask - in: query + The `deployment_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The version + whose lock to renew. Format: + deployments/{deployment_id}/versions/{version_id} + - name: version_id + in: path required: true schema: - type: object + type: string description: >- - The set of fields to update. Required; supported paths are - ``state``, ``error_message``, ``resource_id``, and ``status``. An - empty mask or any other path is rejected with - INVALID_PARAMETER_VALUE. - requestBody: - content: - application/json: - schema: - type: object - properties: - operation: - type: object - properties: - action_type: - type: string - x-enum: - - OPERATION_ACTION_TYPE_BIND - - OPERATION_ACTION_TYPE_BIND_AND_UPDATE - - OPERATION_ACTION_TYPE_CREATE - - OPERATION_ACTION_TYPE_DELETE - - OPERATION_ACTION_TYPE_INITIAL_REGISTER - - OPERATION_ACTION_TYPE_RECREATE - - OPERATION_ACTION_TYPE_RESIZE - - OPERATION_ACTION_TYPE_UPDATE - - OPERATION_ACTION_TYPE_UPDATE_WITH_ID - description: The type of operation performed on this resource. - status: - type: string - x-enum: - - OPERATION_STATUS_FAILED - - OPERATION_STATUS_SUCCEEDED - description: >- - Whether the operation succeeded or failed. Mutable: may - be updated after creation via UpdateOperation, e.g. when - an operation recorded as failed is retried and - eventually succeeds. A succeeded operation cannot carry - an ``error_message``. - create_time: - type: string - format: date-time - description: When the operation was recorded. - dashboard_metadata: - type: object - properties: - definition_path: - type: string - description: >- - Path of the file that declares this dashboard, - relative to the bundle's workspace.file_path - (Version.workspace_info.file_path) — join the two to - get the file's absolute workspace path. For now this - lives only on the dashboard metadata, and is a - single string because it was a single string - (``relative_path``) in the legacy bundle - metadata.json. We may generalize it in the future: - lifting it to a top-level field on - Resource/Operation (every resource type has a - definition location) and converting it to a repeated - field, since a resource can be declared across - multiple files/locations. - source_path: - type: string - description: >- - Path of the dashboard's source artifact (its - ``.lvdash.json``), relative to the deployment root. - description: >- - Dashboard-specific metadata; set only for dashboard - resources. - error_message: - type: string - description: >- - Error message if the operation failed. Set when status - is OPERATION_STATUS_FAILED. Captures the error - encountered while applying the resource to the - workspace. Mutable: may be updated after creation via - UpdateOperation; setting it to an empty string clears - it. After an update is applied, an operation whose - status is OPERATION_STATUS_SUCCEEDED cannot carry an - error_message. - name: - type: string - description: >- - Resource name of the operation. Format: - deployments/{deployment_id}/versions/{version_id}/operations/{resource_key} - resource_id: - type: string - description: >- - ID of the actual resource in the workspace (e.g. the job - ID, pipeline ID). Optional at creation: CREATE and - RECREATE operations produce a new resource whose ID is - not yet known when the operation is recorded. Mutable: - may be filled in (or corrected) later via - UpdateOperation once the ID is known. - resource_key: - type: string - description: >- - Resource identifier within the bundle (e.g. "jobs.foo", - "pipelines.bar", "jobs.foo.permissions", - "files."). Can be an arbitrary UTF-8 encoded - string key. This key links the operation to the - corresponding deployment-level Resource. - resource_type: - type: string - x-enum: - - DEPLOYMENT_RESOURCE_TYPE_ALERT - - DEPLOYMENT_RESOURCE_TYPE_APP - - DEPLOYMENT_RESOURCE_TYPE_CATALOG - - DEPLOYMENT_RESOURCE_TYPE_CLUSTER - - DEPLOYMENT_RESOURCE_TYPE_DASHBOARD - - DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG - - DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE - - DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT - - DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION - - DEPLOYMENT_RESOURCE_TYPE_JOB - - DEPLOYMENT_RESOURCE_TYPE_MODEL - - DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT - - DEPLOYMENT_RESOURCE_TYPE_PIPELINE - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT - - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT - - DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR - - DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL - - DEPLOYMENT_RESOURCE_TYPE_SCHEMA - - DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE - - DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE - - DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE - - DEPLOYMENT_RESOURCE_TYPE_VOLUME - description: >- - The type of the deployment resource this operation - applies to. Derived from the ``resource_key`` prefix - (e.g. "jobs" → JOB); the caller does not set this field. - sequence_id: - type: integer - description: >- - Monotonically increasing revision used for optimistic - concurrency control (the AIP-154 concurrency token for - this resource, realized as a sequence number rather than - an opaque etag). The server assigns 1 on creation and - increments it on every successful UpdateOperation. It is - OPTIONAL rather than OUTPUT_ONLY because it is - dual-purpose: CreateOperation/GetOperation return the - current value, and UpdateOperation reads the - caller-supplied value as a precondition. The caller must - echo the value it last observed; if it no longer matches - the server's value, the update is rejected with ABORTED - so the caller can re-read and retry. Ignored on - CreateOperation. - state: - type: object - description: >- - Serialized local config state after the operation. - Should be unset for delete operations. Mutable: may be - updated after creation via UpdateOperation. When - updating, the caller must echo the last-observed - ``sequence_id`` as a concurrency precondition. - update_time: - type: string - format: date-time - description: >- - When the operation was last updated. Set to - ``create_time`` when the operation is created and to the - server timestamp on each successful UpdateOperation. - required: - - action_type - - status - description: >- - The operation to update. Its ``name`` selects the operation; - the fields named in ``update_mask`` carry the new values; - and ``sequence_id`` carries the optimistic-concurrency - precondition (see the field docs on Operation). All other - fields are ignored. - required: - - operation + The `version_id` segment of the `name` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The version + whose lock to renew. Format: + deployments/{deployment_id}/versions/{version_id} responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/HeartbeatResponse' default: description: Error response content: @@ -1330,46 +1533,71 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - /api/2.0/bundle/{name}/heartbeat: - post: - operationId: bundle_deployments_heartbeat - summary: Sends a heartbeat to renew the lock held by a version. + /api/2.0/bundle/deployments/{deployment_id}/versions/{version_id}/operations: + get: + operationId: bundle_deployments_list_operations + summary: Lists resource operations under a version. tags: - bundledeployments - bundle_deployments - description: >- - Sends a heartbeat to renew the lock held by a version. - - - The server validates that the version is the active (non-terminal) - version on the parent deployment - - and resets the lock expiry. If the lock has already expired or the - version is no longer active, the - - server returns ``ABORTED``. - + description: |- + Lists resource operations under a version. - :param name: str - The version whose lock to renew. Format: deployments/{deployment_id}/versions/{version_id} + :param parent: str + The parent version. Format: deployments/{deployment_id}/versions/{version_id} + :param page_size: int (optional) + The maximum number of operations to return. The service may return fewer than this value. If + unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 + will be coerced to 1000. + :param page_token: str (optional) + A page token, received from a previous ``ListOperations`` call. Provide this to retrieve the + subsequent page. - :returns: :class:`HeartbeatResponse` + :returns: Iterator over :class:`Operation` parameters: - - name: name + - name: deployment_id in: path required: true schema: type: string description: >- - The version whose lock to renew. Format: - deployments/{deployment_id}/versions/{version_id} + The `deployment_id` segment of the `parent` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The parent + version. Format: deployments/{deployment_id}/versions/{version_id} + - name: version_id + in: path + required: true + schema: + type: string + description: >- + The `version_id` segment of the `parent` resource name + (`deployments/{deployment_id}/versions/{version_id}`). The parent + version. Format: deployments/{deployment_id}/versions/{version_id} + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + The maximum number of operations to return. The service may return + fewer than this value. If unspecified, at most 50 operations will be + returned. The maximum value is 1000; values above 1000 will be + coerced to 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + A page token, received from a previous ``ListOperations`` call. + Provide this to retrieve the subsequent page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/HeartbeatResponse' + $ref: '#/components/schemas/ListOperationsResponse' default: description: Error response content: @@ -1382,7 +1610,7 @@ paths: message: type: string x-stackql-sdk-source: BundleDeploymentsAPI - /api/2.0/bundle/{parent}/resources: + /api/2.0/bundle/deployments/{deployment_id}/resources: get: operationId: bundle_deployments_list_resources summary: Lists resources under a deployment. @@ -1404,12 +1632,15 @@ paths: :returns: Iterator over :class:`Resource` parameters: - - name: parent + - name: deployment_id in: path required: true schema: type: string - description: 'The parent deployment. Format: deployments/{deployment_id}' + description: >- + The `deployment_id` segment of the `parent` resource name + (`deployments/{deployment_id}`). The parent deployment. Format: + deployments/{deployment_id} - name: page_size in: query required: false @@ -1456,7 +1687,7 @@ components: type: string description: >- Path of the file that declares this dashboard, relative to the - bundle's workspace.file_path (Version.workspace_info.file_path) — + bundle's workspace.file_path (Deployment.workspace_info.file_path) — join the two to get the file's absolute workspace path. For now this lives only on the dashboard metadata, and is a single string because it was a single string (``relative_path``) in the legacy bundle @@ -1481,12 +1712,13 @@ components: description: When the deployment was created. created_by: type: string - description: The user who created the deployment (email or principal name). + description: >- + The user who created the deployment (email or principal name). Empty + if authoritative deployment metadata does not identify a creator or + the principal cannot be resolved. deployment_mode: $ref: '#/components/schemas/DeploymentMode' - description: >- - Bundle target deployment mode (development or production), derived - from the most recent version's mode. + description: Bundle target deployment mode (development or production). destroy_time: type: string format: date-time @@ -1501,10 +1733,7 @@ components: Unset if the deployment has not been destroyed. display_name: type: string - description: >- - Human-readable name for the deployment, up to 256 characters. Output - only: clients update it by setting ``display_name`` when creating a - version. + description: Human-readable name for the deployment, up to 256 characters. git_info: $ref: '#/components/schemas/GitInfo' description: >- @@ -1540,10 +1769,7 @@ components: description: Current status of the deployment. target_name: type: string - description: >- - The bundle target name associated with this deployment. Output only: - it is denormalized from the latest version, not set directly on the - deployment. + description: The bundle target name associated with this deployment. update_time: type: string format: date-time @@ -1552,12 +1778,11 @@ components: type: string description: >- The user who most recently updated the deployment (email or - principal name). + principal name). Empty if authoritative deployment metadata does not + identify a modifier or the principal cannot be resolved. workspace_info: $ref: '#/components/schemas/WorkspaceInfo' - description: >- - Workspace location of the deployment, derived from the latest - version. + description: Workspace location of the deployment. description: A bundle deployment registered with the control plane. GitInfo: type: object @@ -1644,21 +1869,20 @@ components: properties: action_type: $ref: '#/components/schemas/OperationActionType' - description: The type of operation performed on this resource. - status: - $ref: '#/components/schemas/OperationStatus' description: >- - Whether the operation succeeded or failed. Mutable: may be updated - after creation via UpdateOperation, e.g. when an operation recorded - as failed is retried and eventually succeeds. A succeeded operation - cannot carry an ``error_message``. + The type of operation performed on this resource. Set when the + version is created and immutable thereafter. create_time: type: string format: date-time description: When the operation was recorded. dashboard_metadata: $ref: '#/components/schemas/DashboardMetadata' - description: Dashboard-specific metadata; set only for dashboard resources. + description: >- + Dashboard-specific metadata; set only for dashboard resources. + Mutable: may be set or updated via UpdateOperation as the resource + is applied, and is mirrored onto the corresponding deployment-level + resource. error_message: type: string description: >- @@ -1677,17 +1901,18 @@ components: type: string description: >- ID of the actual resource in the workspace (e.g. the job ID, - pipeline ID). Optional at creation: CREATE and RECREATE operations - produce a new resource whose ID is not yet known when the operation - is recorded. Mutable: may be filled in (or corrected) later via - UpdateOperation once the ID is known. + pipeline ID). Required whenever ``state`` is set, because state + records a resource that exists. A CREATE or RECREATE that has not + produced its resource yet records neither. Mutable: may be filled in + (or corrected) later via UpdateOperation once the ID is known. resource_key: type: string description: >- Resource identifier within the bundle (e.g. "jobs.foo", "pipelines.bar", "jobs.foo.permissions", "files."). Can be an arbitrary UTF-8 encoded string key. This key links the operation - to the corresponding deployment-level Resource. + to the corresponding deployment-level Resource. Set when the version + is created and immutable thereafter. resource_type: $ref: '#/components/schemas/DeploymentResourceType' description: >- @@ -1700,20 +1925,44 @@ components: Monotonically increasing revision used for optimistic concurrency control (the AIP-154 concurrency token for this resource, realized as a sequence number rather than an opaque etag). The server assigns - 1 on creation and increments it on every successful UpdateOperation. - It is OPTIONAL rather than OUTPUT_ONLY because it is dual-purpose: - CreateOperation/GetOperation return the current value, and - UpdateOperation reads the caller-supplied value as a precondition. - The caller must echo the value it last observed; if it no longer - matches the server's value, the update is rejected with ABORTED so - the caller can re-read and retry. Ignored on CreateOperation. + 0 when the operation is created and increments it on every + successful UpdateOperation, so a never-updated operation is at 0 and + the first successful update makes it 1. It is OPTIONAL rather than + OUTPUT_ONLY because it is dual-purpose: GetOperation returns the + current value, and UpdateOperation reads the caller-supplied value + as a precondition. The caller must echo the value it last observed; + if it no longer matches the server's value, the update is rejected + with ABORTED so the caller can re-read and retry. state: - type: object + type: string description: >- - Serialized local config state after the operation. Should be unset - for delete operations. Mutable: may be updated after creation via + Serialized local config state after the operation. Its presence + records whether the resource is still tracked by the deployment. + Explicitly clearing state removes the resource from the deployment; + omitting it from the update mask leaves resource state unchanged. + State is stored only on Resources. UpdateOperation accepts state but + omits it from its response, as do subsequent GetOperation and + ListOperations. Mutable: may be updated after creation via UpdateOperation. When updating, the caller must echo the - last-observed ``sequence_id`` as a concurrency precondition. + last-observed ``sequence_id`` as a concurrency precondition. The + string is not parsed; it is projected onto the corresponding + Resource's state. It is deliberately not google.protobuf.Value, + whose only numeric case is ``double number_value``, so parsing the + client's JSON into it rewrites every integer as a double - ``1`` + reads back as ``1.0``, which no longer deserializes into an integer + field - and silently loses precision above 2^53, which is within + range for IDs the client records. A string rather than bytes: the + payload is always UTF-8 JSON, and proto3 JSON maps bytes to base64, + which inflates every request and response by a third and makes state + unreadable in logs and API responses. Both generate the same OpenAPI + schema ("type": "string"), so the SDKs are identical either way. + status: + $ref: '#/components/schemas/OperationStatus' + description: >- + Status of the operation. Starts as OPERATION_STATUS_PENDING when the + version is created and moves to a terminal status once the resource + is applied. Mutable: updated via UpdateOperation, e.g. when an + operation recorded as failed is retried and eventually succeeds. update_time: type: string format: date-time @@ -1721,15 +1970,15 @@ components: When the operation was last updated. Set to ``create_time`` when the operation is created and to the server timestamp on each successful UpdateOperation. - required: - - action_type - - status description: >- - An operation on a single resource performed during a version. Operations - record the result of - applying a resource change to the workspace. Most fields are immutable once recorded; ``state``, - ``error_message``, ``resource_id``, and ``status`` may be updated afterwards (via - UpdateOperation), guarded by ``sequence_id`` for optimistic concurrency control. + An operation on a single resource performed during a version. The full + set of operations for a + version is recorded when the version is created: each carries its ``resource_key`` and + ``action_type`` and starts in ``OPERATION_STATUS_PENDING``. As each resource is applied, its + operation is updated (via UpdateOperation) to record the result of applying the change to the + workspace. ``state``, ``error_message``, ``resource_id``, ``status``, and ``dashboard_metadata`` + may be updated afterwards, guarded by ``sequence_id`` for optimistic concurrency control; all + other fields are immutable once recorded. Resource: type: object properties: @@ -1761,8 +2010,11 @@ components: Resource identifier within the bundle (e.g. "jobs.foo", "pipelines.bar", "jobs.foo.permissions"). state: - type: object - description: Serialized local config state (what the CLI deployed). + type: string + description: >- + Serialized local config state (what the CLI deployed). Opaque to + this service; see Operation.state for why this is a string and not + google.protobuf.Value. update_time: type: string format: date-time @@ -1776,6 +2028,27 @@ components: A resource managed by a deployment. Resources are implicitly created, updated, or deleted when operations are recorded on a version. + StagedOperation: + type: object + properties: + resource_key: + type: string + description: >- + The key identifying the resource this operation applies to (e.g. + "jobs.foo", "pipelines.bar"). Becomes the final component of the + operation's name and must be unique among the operations in the + version. + action_type: + $ref: '#/components/schemas/OperationActionType' + description: The type of operation planned for this resource. + required: + - resource_key + - action_type + description: >- + A resource operation to record when a version is created. Each staged + operation identifies the + resource it applies to and the action planned for it; the server records the operation in + ``OPERATION_STATUS_PENDING``, and its outcome is filled in later via UpdateOperation. Version: type: object properties: @@ -1827,6 +2100,15 @@ components: description: >- Resource name of the version. Format: deployments/{deployment_id}/versions/{version_id} + operations: + type: array + items: + $ref: '#/components/schemas/StagedOperation' + description: >- + The full operation plan for this version: one PENDING operation per + entry, recorded in the same transaction. Input only -- supplied on + create and never returned by create/get/list; read the recorded + operations via ListOperations. previous_version_id: type: string description: >- @@ -1914,24 +2196,35 @@ components: - DEPLOYMENT_RESOURCE_TYPE_APP - DEPLOYMENT_RESOURCE_TYPE_CATALOG - DEPLOYMENT_RESOURCE_TYPE_CLUSTER + - DEPLOYMENT_RESOURCE_TYPE_CLUSTER_POLICY - DEPLOYMENT_RESOURCE_TYPE_DASHBOARD - DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG - DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE - DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT - DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION + - DEPLOYMENT_RESOURCE_TYPE_GENIE_SPACE + - DEPLOYMENT_RESOURCE_TYPE_INSTANCE_POOL - DEPLOYMENT_RESOURCE_TYPE_JOB + - DEPLOYMENT_RESOURCE_TYPE_JOB_RUN - DEPLOYMENT_RESOURCE_TYPE_MODEL - DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT - DEPLOYMENT_RESOURCE_TYPE_PIPELINE - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_CATALOG + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_DATABASE - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ROLE + - DEPLOYMENT_RESOURCE_TYPE_POSTGRES_SYNCED_TABLE - DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR - DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL - DEPLOYMENT_RESOURCE_TYPE_SCHEMA + - DEPLOYMENT_RESOURCE_TYPE_SECRET - DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE - DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE - DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE + - DEPLOYMENT_RESOURCE_TYPE_VECTOR_SEARCH_ENDPOINT + - DEPLOYMENT_RESOURCE_TYPE_VECTOR_SEARCH_INDEX - DEPLOYMENT_RESOURCE_TYPE_VOLUME description: Type of a deployment resource. DeploymentStatus: @@ -1952,6 +2245,7 @@ components: - OPERATION_ACTION_TYPE_INITIAL_REGISTER - OPERATION_ACTION_TYPE_RECREATE - OPERATION_ACTION_TYPE_RESIZE + - OPERATION_ACTION_TYPE_UNBIND - OPERATION_ACTION_TYPE_UPDATE - OPERATION_ACTION_TYPE_UPDATE_WITH_ID description: Type of action performed on a resource during a deployment. @@ -1959,6 +2253,7 @@ components: type: string x-enum: - OPERATION_STATUS_FAILED + - OPERATION_STATUS_PENDING - OPERATION_STATUS_SUCCEEDED description: Status of a resource operation. VersionComplete: @@ -1992,7 +2287,8 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1bundle~1{name}~1complete/post' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}~1complete/post response: mediaType: application/json openAPIDocKey: '200' @@ -2001,27 +2297,30 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1bundle~1{parent}~1versions/post' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{parent}~1versions/get' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions get: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{name}/get' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/versions/methods/list' - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/versions/methods/create' update: [] @@ -2050,22 +2349,40 @@ components: objectKey: $.deployments delete: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{name}/delete' + $ref: '#/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}/patch' response: mediaType: application/json openAPIDocKey: '200' heartbeat: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{name}~1heartbeat/post' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}~1heartbeat/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/get' - $ref: '#/components/x-stackQL-resources/deployments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/deployments/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update' delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' replace: [] @@ -2074,36 +2391,36 @@ components: name: operations title: Operations methods: - create: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}~1operations~1{resource_key}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1bundle~1{parent}~1operations/post' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}~1operations~1{resource_key}/patch response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{parent}~1operations/get' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1versions~1{version_id}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1bundle~1{name}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/operations/methods/create' + insert: [] update: - $ref: '#/components/x-stackQL-resources/operations/methods/update' delete: [] @@ -2113,15 +2430,24 @@ components: name: deployment_resources title: Deployment Resources methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1resources~1{resource_key}/get + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1bundle~1{parent}~1resources/get' + $ref: >- + #/paths/~1api~12.0~1bundle~1deployments~1{deployment_id}~1resources/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resources sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/deployment_resources/methods/get' - $ref: '#/components/x-stackQL-resources/deployment_resources/methods/list' insert: [] update: [] diff --git a/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml b/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml index 05e05cf9..26b7c623 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml @@ -6,53 +6,70 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.catalog servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: - /api/2.1/unity-catalog/agent-services: + /api/2.1/unity-catalog/mcp-services: post: - operationId: ai_gateway_create_agent_service + operationId: ai_gateway_create_mcp_service summary: >- - Creates an agent service in a Unity Catalog schema. An agent service is - a governed securable that + Creates an MCP service in a Unity Catalog schema. An MCP (Model Context + Protocol) service is a tags: - catalog - ai_gateway description: >- - Creates an agent service in a Unity Catalog schema. An agent service is - a governed securable that + Creates an MCP service in a Unity Catalog schema. An MCP (Model Context + Protocol) service is a - registers an AI agent and exposes it for discovery, access control, and - auditing. The caller supplies + governed securable that registers an MCP server and exposes its tools + for discovery, access control, - the leaf name in ``agent_service_id`` and the agent service type, which - is immutable after creation. + and invocation. Specify its name in ``mcp_service_id``. You must be the owner of the parent schema or have the ``CREATE_SERVICE`` and ``USE_SCHEMA`` privileges on the parent schema and ``USE_CATALOG`` on the parent - catalog. + catalog. You also need + + ``USE_CONNECTION`` on the connection the MCP service references. - :param agent_service: :class:`AgentService` - The agent service to create. The server populates ``name`` from ``parent`` + ``agent_service_id``; - clients should leave it unset. + :param mcp_service: :class:`McpService` + The MCP service to create. Do not set ``name``; the server derives it from ``parent`` and + ``mcp_service_id``. ``source_connection`` is required. :param parent: str - Resource name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component - is capped at 255 characters individually. - :param agent_service_id: str - Leaf identifier for the agent service (the unqualified name within the parent schema, e.g. - "support_agent"). + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component is + capped at 255 characters individually. + :param mcp_service_id: str + Name for the MCP service, e.g. "my_mcp_service". - :returns: :class:`AgentService` + :returns: :class:`McpService` parameters: - name: parent in: query @@ -60,267 +77,169 @@ paths: schema: type: string description: >- - Resource name of the parent schema. Format: - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. - - name: agent_service_id + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. + Each ``{...}`` component is capped at 255 characters individually. + - name: mcp_service_id in: query required: true schema: type: string - description: >- - Leaf identifier for the agent service (the unqualified name within - the parent schema, e.g. "support_agent"). + description: Name for the MCP service, e.g. "my_mcp_service". requestBody: content: application/json: schema: type: object properties: - agent_service: + comment: + type: string + description: User-provided description. + config: type: object properties: - agent_service_type: - type: string - x-enum: - - AGENT_SERVICE_TYPE_EXTERNAL + include_tool_selectors: + type: array + items: + type: string description: >- - Type of agent service. Required on create. Immutable - after creation. For future internal / genie / app kinds, - determines how the backing agent surface is provisioned. - browse_only: - type: boolean + Tool names or prefix patterns to expose from the MCP + server. Use exact tool names or prefix patterns such as + ``read_*``. An empty list exposes all tools. At most + 1,024 selectors are allowed, and each selector can + contain at most 256 characters. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. description: >- - Whether the caller sees only metadata available through - the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: + Rate limits for tool invocations. Supported scopes are + user, group, service principal, the service as a whole, + and each user by default. Request and token limits are + supported. Empty when no rate limit is configured. + source_connection: type: object properties: - base_path: - type: string - description: >- - Vendor base path appended to the connection url at - invocation time. Bedrock example: - ``/agents/AGENT123/agentAliases/ALIAS1/sessions``. - Empty when the agent platform does not require a - per-agent suffix. - inference_table: - type: object - properties: - parent: - type: string - description: >- - Parent UC schema where the inference table is - created. Format: ``schemas/{catalog}.{schema}``. - Set at create time and immutable thereafter; - changing it on an existing service is rejected. - disabled: - type: boolean - description: >- - Indicates whether payload logging is disabled - (opt-out). Unset means that payload logging is - active (the on-by-default state coincides with - the proto zero-value, so the server never fills - this field for a client that leaves it unset). - Set ``disabled = true`` to pause runtime logging - while keeping the sub-message attached - (preserving ``parent`` and ``table_name_prefix`` - for a later flip back to active). ``parent`` - remains required either way. - is_deleted: - type: boolean - description: >- - True when the bound inference TABLE has been - deleted but the parent service still references - it. The dangling reference is surfaced (not - silently dropped) so callers can see the broken - dependency. AI Gateway payload logging fails - closed in this state. - table: - type: string - description: >- - Resolved UC table for payload logs. Format: - ``tables/{catalog}.{schema}.{table}``. - table_name_prefix: - type: string - description: >- - Prefix for the inference-table's UC-registered - name. The actual leaf name UC stores is - ``_payload``; the - ``_payload`` suffix is appended automatically. - To find the actual UC table after Create, read - the ``table`` field on the response. Defaults to - ``_payload`` when unset. Set - at create time and immutable thereafter; - changing it on an existing service is rejected. - required: - - parent - description: >- - Inference table config for invocation payload - logging. Reuses the shared InferenceTableConfig - (same as ModelServiceConfig.inference_table). - model_service: + name: type: string description: >- - Resource name of the model service backing this - agent. Empty when the agent platform manages its own - model selection (e.g. Bedrock Agents). Format: - ``model-services/{catalog}.{schema}.{model_service}``. - rate_limits: - type: array - items: - type: object - properties: - key: - type: string - x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - - RATE_LIMIT_KEY_SERVICE - - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - - RATE_LIMIT_KEY_USER - - RATE_LIMIT_KEY_USER_DEFAULT - - RATE_LIMIT_KEY_USER_GROUP - description: >- - Scope key. Determines whether ``principal`` is - required. - renewal_period: - type: string - x-enum: - - RATE_LIMIT_RENEWAL_PERIOD_HOUR - - RATE_LIMIT_RENEWAL_PERIOD_MINUTE - description: Renewal period. - principal: - type: string - description: >- - Principal this limit applies to: user email, - group name, or service principal application - ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, - ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not - set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. - Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only - valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to - apply the limit to every value of - ``request_tag_key`` (an any-value default); a - set value is a specific override for that - value. - requests: - type: integer - description: >- - Max requests allowed within a renewal period. - Leave unset for no request limit. - tokens: - type: integer - description: >- - Max tokens allowed within a renewal period. - Leave unset for no token limit. - required: - - key - - renewal_period - description: >- - A rate limit applied to service requests. Leave - ``requests`` or ``tokens`` unset to impose no - limit on that dimension; set a value to cap that dimension within the renewal period. + Resource name of the Unity Catalog connection used + to access the MCP server, in the form + ``connections/{catalog}.{schema}.{connection}``. + is_deleted: + type: boolean description: >- - Per-principal rate limits applied to invocations - routed through this agent service. Repeated to - support per-USER / USER_GROUP / SERVICE_PRINCIPAL / - SERVICE / USER_DEFAULT scopes simultaneously, - mirroring McpServiceConfig.rate_limits. Empty when - no rate limit is configured. - source_connection: + Whether the referenced connection has been deleted. + The MCP service keeps the reference so callers can + identify the broken dependency; tool invocation + fails until the source connection is updated. + options: type: object - properties: - name: - type: string - is_deleted: - type: boolean - required: - - name - description: External agent referenced via a UC Connection. - system_prompt: - type: string - description: System prompt prepended to invocations. Max 8 KB. - description: >- - Operational configuration: connection, base_path, - system_prompt, model_service, optional inference table, - optional rate limits. Required on CreateAgentService; on - UpdateAgentService it is required only when ``config`` - (or a ``config.*`` subpath) appears in ``update_mask``. - create_time: - type: string - format: date-time - description: When the agent service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: >- - The resolved owner of the agent service. Falls back to - the caller's identity when ``owner`` is not explicitly - set on creation. - etag: - type: string - description: >- - Optimistic concurrency control token. Server-generated - from the entity's state and returned on every read. To - use it as an if-match precondition on a mutation, echo - the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects - the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the agent service. - name: - type: string - description: >- - Resource name of the agent service. Format: - ``agent-services/{catalog}.{schema}.{agent_service}``. - Each ``{...}`` component is capped at 255 characters - individually. Server-derived on Create from ``parent`` + - ``agent_service_id``; required and immutable on - Update/Get/Delete. - owner: - type: string + description: >- + Options needed to build the U2M authorize request, + returned as a flat map. When set, it includes: + ``authorization_endpoint`` (OAuth authorize URL), + ``token_endpoint`` (token-exchange URL), + ``oauth_scope`` (space-separated scopes to request), + ``client_id`` (OAuth client id), and + ``oauth_provider`` (the OAuth provider). + required: + - name description: >- - The owner of the agent service. Write-only; read owner - via effective_owner. - update_time: - type: string - format: date-time - description: When the agent service was last modified. - updated_by: - type: string - description: Identity of the last updater. + Unity Catalog connection referencing the MCP server. + Required on Create. description: >- - The agent service to create. The server populates ``name`` - from ``parent`` + ``agent_service_id``; clients should leave - it unset. - required: - - agent_service + Connection, tool selectors, and rate limits. Required on + Create. On Update, provide this field when ``update_mask`` + contains ``config`` or one of its subpaths. + create_time: + type: string + format: date-time + description: Time the MCP service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the MCP service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the MCP service. + name: + type: string + description: >- + 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. + update_time: + type: string + format: date-time + description: Time the MCP service was last modified. + updated_by: + type: string + description: Identity of the last updater. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AgentService' + $ref: '#/components/schemas/McpService' default: description: Error response content: @@ -334,16 +253,13 @@ paths: type: string x-stackql-sdk-source: AiGatewayAPI get: - operationId: ai_gateway_list_agent_services - summary: >- - Lists the agent services in a Unity Catalog schema. Provide ``parent`` - as + operationId: ai_gateway_list_mcp_services + summary: Lists the MCP services in a Unity Catalog schema. Provide ``parent`` as tags: - catalog - ai_gateway description: >- - Lists the agent services in a Unity Catalog schema. Provide ``parent`` - as + Lists the MCP services in a Unity Catalog schema. Provide ``parent`` as ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned ``next_page_token`` to fetch @@ -352,7 +268,7 @@ paths: Requires ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the - parent schema. Only agent + parent schema. Only MCP services the caller can access (as owner or through ``EXECUTE``, ``READ_METADATA``, or ``MANAGE``) are @@ -360,58 +276,62 @@ paths: returned. - :param include_browse: bool (optional) - Whether to include agent services for which the principal can only access selective metadata. :param page_size: int (optional) - Maximum number of agent services to return. Defaults to 100 when unset or 0; the maximum is 1000. - Use ``next_page_token`` to retrieve additional pages. + Maximum number of MCP services to return. Defaults to 200 when unset or 0; the maximum is 1000 for + ``view = BASIC`` and 200 for ``view = FULL``. Use ``page_token`` to retrieve additional pages. :param page_token: str (optional) - Opaque pagination token from a previous request. + Opaque pagination token from the previous response. :param parent: str (optional) - Resource name of the parent schema to list within, as ``schemas/{catalog}.{schema}``. Each ``{...}`` + Parent schema to list within, in the form ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component is capped at 255 characters individually. + :param view: :class:`ListMcpServicesRequestView` (optional) + Fields to return for each service. ``FULL`` includes source-connection details and rate-limit + principal names. ``BASIC`` omits the source connection and omits principal names from rate limits. + Defaults to ``BASIC`` when unset. - :returns: Iterator over :class:`AgentService` + :returns: Iterator over :class:`McpService` parameters: - - name: include_browse - in: query - required: false - schema: - type: boolean - description: >- - Whether to include agent services for which the principal can only - access selective metadata. - name: page_size in: query required: false schema: type: integer description: >- - Maximum number of agent services to return. Defaults to 100 when - unset or 0; the maximum is 1000. Use ``next_page_token`` to retrieve - additional pages. + Maximum number of MCP services to return. Defaults to 200 when unset + or 0; the maximum is 1000 for ``view = BASIC`` and 200 for ``view = + FULL``. Use ``page_token`` to retrieve additional pages. - name: page_token in: query required: false schema: type: string - description: Opaque pagination token from a previous request. + description: Opaque pagination token from the previous response. - name: parent in: query required: false schema: type: string description: >- - Resource name of the parent schema to list within, as - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. + Parent schema to list within, in the form + ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component + is capped at 255 characters individually. + - name: view + in: query + required: false + schema: + $ref: '#/components/schemas/ListMcpServicesRequestView' + description: >- + Fields to return for each service. ``FULL`` includes + source-connection details and rate-limit principal names. ``BASIC`` + omits the source connection and omits principal names from rate + limits. Defaults to ``BASIC`` when unset. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListAgentServicesResponse' + $ref: '#/components/schemas/ListMcpServicesResponse' default: description: Error response content: @@ -424,242 +344,63 @@ paths: message: type: string x-stackql-sdk-source: AiGatewayAPI - /api/2.1/unity-catalog/mcp-services: + /api/2.1/unity-catalog/mcp-services/{full_name}/user-credentials: post: - operationId: ai_gateway_create_mcp_service + operationId: ai_gateway_create_mcp_service_user_mapped_credential summary: >- - Creates an MCP service in a Unity Catalog schema. An MCP (Model Context - Protocol) service is a + Logs the caller in to an MCP service: creates their per-user OAuth + credential, or re-authenticates it tags: - catalog - ai_gateway description: >- - Creates an MCP service in a Unity Catalog schema. An MCP (Model Context - Protocol) service is a - - governed securable that registers an MCP server and exposes its tools - for discovery, access control, + Logs the caller in to an MCP service: creates their per-user OAuth + credential, or re-authenticates it - and invocation. The caller supplies the leaf name in ``mcp_service_id``. + if one already exists. The request body carries the OAuth exchange + fields. - You must be the owner of the parent schema or have the - ``CREATE_SERVICE`` and ``USE_SCHEMA`` + You must be the owner of the MCP service or have ``EXECUTE`` on it, plus + ``USE_CATALOG`` on the parent - privileges on the parent schema and ``USE_CATALOG`` on the parent - catalog. You also need + catalog and ``USE_SCHEMA`` on the parent schema. - ``USE_CONNECTION`` on the connection the MCP service references. + :param name: str + Resource name of the MCP service. Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. + :param login: :class:`McpServiceUserMappedCredentialLogin` - :param mcp_service: :class:`McpService` - The MCP service to create. The server populates ``name`` from ``parent`` + ``mcp_service_id``; - clients should leave it unset. - :param parent: str - Resource name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component - is capped at 255 characters individually. - :param mcp_service_id: str - Leaf identifier for the MCP service (the unqualified name within the parent schema, e.g. - "my_mcp_service"). - :returns: :class:`McpService` + :returns: :class:`McpServiceUserMappedCredential` parameters: - - name: parent - in: query - required: true - schema: - type: string - description: >- - Resource name of the parent schema. Format: - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. - - name: mcp_service_id - in: query + - name: full_name + in: path required: true schema: type: string description: >- - Leaf identifier for the MCP service (the unqualified name within the - parent schema, e.g. "my_mcp_service"). + The `full_name` segment of the `name` resource name + (`mcp-services/{full_name}`). Resource name of the MCP service. + Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. requestBody: content: application/json: schema: type: object properties: - mcp_service: + options: type: object - properties: - browse_only: - type: boolean - description: >- - Whether the caller sees only metadata available through - the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: - type: object - properties: - include_tool_selectors: - type: array - items: - type: string - description: >- - Glob or exact-match patterns selecting which tools - from the MCP server to expose. Prefix match for - patterns with ``*``, exact match otherwise. An empty - list means all tools are included. Per-element max - 256 chars. - rate_limits: - type: array - items: - type: object - properties: - key: - type: string - x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - - RATE_LIMIT_KEY_SERVICE - - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - - RATE_LIMIT_KEY_USER - - RATE_LIMIT_KEY_USER_DEFAULT - - RATE_LIMIT_KEY_USER_GROUP - description: >- - Scope key. Determines whether ``principal`` is - required. - renewal_period: - type: string - x-enum: - - RATE_LIMIT_RENEWAL_PERIOD_HOUR - - RATE_LIMIT_RENEWAL_PERIOD_MINUTE - description: Renewal period. - principal: - type: string - description: >- - Principal this limit applies to: user email, - group name, or service principal application - ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, - ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not - set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. - Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only - valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to - apply the limit to every value of - ``request_tag_key`` (an any-value default); a - set value is a specific override for that - value. - requests: - type: integer - description: >- - Max requests allowed within a renewal period. - Leave unset for no request limit. - tokens: - type: integer - description: >- - Max tokens allowed within a renewal period. - Leave unset for no token limit. - required: - - key - - renewal_period - description: >- - A rate limit applied to service requests. Leave - ``requests`` or ``tokens`` unset to impose no - limit on that dimension; set a value to cap that dimension within the renewal period. - description: >- - Per-principal rate limits applied to tool - invocations routed through this MCP service. - Repeated to support per-USER / USER_GROUP / - SERVICE_PRINCIPAL / SERVICE / USER_DEFAULT scopes - simultaneously, mirroring the - ``ModelServiceConfig.rate_limits`` shape. Empty when - no rate limit is configured. - source_connection: - type: object - properties: - name: - type: string - is_deleted: - type: boolean - required: - - name - description: UC Connection referencing the MCP server. - description: >- - Operational configuration: connection, tool selectors, - rate limit. Required on CreateMcpService; on - UpdateMcpService it is required only when ``config`` (or - a ``config.*`` subpath) appears in ``update_mask``. - create_time: - type: string - format: date-time - description: When the MCP service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: >- - The resolved owner of the MCP service. Falls back to the - caller's identity when ``owner`` is not explicitly set - on creation. - etag: - type: string - description: >- - Optimistic concurrency control token. Server-generated - from the entity's state and returned on every read. To - use it as an if-match precondition on a mutation, echo - the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects - the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the MCP service. - name: - type: string - description: >- - 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. - owner: - type: string - description: >- - The owner of the MCP service. Write-only; read owner via - effective_owner. - update_time: - type: string - format: date-time - description: When the MCP service was last modified. - updated_by: - type: string - description: Identity of the last updater. description: >- - The MCP service to create. The server populates ``name`` - from ``parent`` + ``mcp_service_id``; clients should leave - it unset. - required: - - mcp_service + OAuth exchange fields: ``pkce_verifier``, + ``authorization_code``, and ``oauth_redirect_uri``. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/McpService' + $ref: '#/components/schemas/McpServiceUserMappedCredential' default: description: Error response content: @@ -672,90 +413,108 @@ paths: message: type: string x-stackql-sdk-source: AiGatewayAPI - get: - operationId: ai_gateway_list_mcp_services - summary: Lists the MCP services in a Unity Catalog schema. Provide ``parent`` as + delete: + operationId: ai_gateway_delete_mcp_service_user_mapped_credential + summary: >- + Revokes (deletes) the caller's per-user OAuth credential for an MCP + service (logout). tags: - catalog - ai_gateway description: >- - Lists the MCP services in a Unity Catalog schema. Provide ``parent`` as - - ``schemas/{catalog}.{schema}``. Results are paginated; pass the returned - ``next_page_token`` to fetch - - subsequent pages. - + Revokes (deletes) the caller's per-user OAuth credential for an MCP + service (logout). - Requires ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the - parent schema. Only MCP - services the caller can access (as owner or through ``EXECUTE``, - ``READ_METADATA``, or ``MANAGE``) are + You must be the owner of the MCP service or have ``EXECUTE`` on it, plus + ``USE_CATALOG`` on the parent - returned. + catalog and ``USE_SCHEMA`` on the parent schema. - :param include_browse: bool (optional) - Whether to include MCP services for which the principal can only access selective metadata. - :param page_size: int (optional) - Maximum number of MCP services to return. Defaults to 100 when unset or 0; the maximum is 1000. Use - ``next_page_token`` to retrieve additional pages. - :param page_token: str (optional) - Opaque pagination token from a previous request. - :param parent: str (optional) - Resource name of the parent schema to list within, as ``schemas/{catalog}.{schema}``. Each ``{...}`` - component is capped at 255 characters individually. - :param view: :class:`ListMcpServicesRequestView` (optional) - View selector controlling which fields are populated per row. + :param name: str + Resource name of the MCP service. Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. - :returns: Iterator over :class:`McpService` + :returns: :class:`DeleteMcpServiceUserMappedCredentialResponse` parameters: - - name: include_browse - in: query - required: false + - name: full_name + in: path + required: true schema: - type: boolean + type: string description: >- - Whether to include MCP services for which the principal can only - access selective metadata. - - name: page_size - in: query - required: false - schema: - type: integer - description: >- - Maximum number of MCP services to return. Defaults to 100 when unset - or 0; the maximum is 1000. Use ``next_page_token`` to retrieve - additional pages. - - name: page_token - in: query - required: false - schema: - type: string - description: Opaque pagination token from a previous request. - - name: parent - in: query - required: false + The `full_name` segment of the `name` resource name + (`mcp-services/{full_name}`). Resource name of the MCP service. + Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/DeleteMcpServiceUserMappedCredentialResponse + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + get: + operationId: ai_gateway_get_mcp_service_user_mapped_credential + summary: >- + Returns the caller's per-user OAuth login state for an MCP service. Read + ``provisioning_info.state``: + tags: + - catalog + - ai_gateway + description: >- + Returns the caller's per-user OAuth login state for an MCP service. Read + ``provisioning_info.state``: + + ``ACTIVE`` means the caller is logged in and the credential is usable; + any other state (for example a + + failed or still-provisioning login) means the login has not completed + and the caller should log in + + again. If the caller has no credential yet, the RPC returns + ``NOT_FOUND``. + + + You must be the owner of the MCP service or have ``EXECUTE`` on it, plus + ``USE_CATALOG`` on the parent + + catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the MCP service. Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. + + :returns: :class:`McpServiceUserMappedCredential` + parameters: + - name: full_name + in: path + required: true schema: type: string description: >- - Resource name of the parent schema to list within, as - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. - - name: view - in: query - required: false - schema: - $ref: '#/components/schemas/ListMcpServicesRequestView' - description: View selector controlling which fields are populated per row. + The `full_name` segment of the `name` resource name + (`mcp-services/{full_name}`). Resource name of the MCP service. + Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListMcpServicesResponse' + $ref: '#/components/schemas/McpServiceUserMappedCredential' default: description: Error response content: @@ -773,19 +532,19 @@ paths: operationId: ai_gateway_create_model_provider_service summary: >- Creates a model provider service in a Unity Catalog schema. A model - provider service is a governed + provider service stores tags: - catalog - ai_gateway description: >- Creates a model provider service in a Unity Catalog schema. A model - provider service is a governed + provider service stores - connection to an external model provider (for example OpenAI, Azure - OpenAI, or Amazon Bedrock) that + authentication and request configuration for an external model provider, + such as OpenAI, Azure OpenAI, - model services reference to invoke that provider. The caller supplies - the leaf name in + or Amazon Bedrock. Model services reference it to invoke the provider. + Specify its name in ``model_provider_service_id``. @@ -794,18 +553,22 @@ paths: ``CREATE_SERVICE`` and ``USE_SCHEMA`` privileges on the parent schema and ``USE_CATALOG`` on the parent - catalog. + catalog. Inline credentials + + additionally require ``CREATE_CONNECTION`` on the parent schema. When + using a Unity Catalog service + + credential, you must have ``ACCESS`` on that credential. :param model_provider_service: :class:`ModelProviderService` - The model provider service to create. The server populates ``name`` from ``parent`` + - ``model_provider_service_id``; clients should leave it unset. + The model provider service to create. Do not set ``name``; the server derives it from ``parent`` and + ``model_provider_service_id``. :param parent: str - Resource name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component - is capped at 255 characters individually. + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component is + capped at 255 characters individually. :param model_provider_service_id: str - Leaf identifier for the provider service (the unqualified name within the parent schema, e.g. - "openai_prod"). + Name for the model provider service, e.g. "openai_prod". :returns: :class:`ModelProviderService` parameters: @@ -815,96 +578,53 @@ paths: schema: type: string description: >- - Resource name of the parent schema. Format: - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. + Each ``{...}`` component is capped at 255 characters individually. - name: model_provider_service_id in: query required: true schema: type: string - description: >- - Leaf identifier for the provider service (the unqualified name - within the parent schema, e.g. "openai_prod"). + description: Name for the model provider service, e.g. "openai_prod". requestBody: content: application/json: schema: type: object properties: - model_provider_service: + comment: + type: string + description: User-provided description. + config: type: object properties: - browse_only: + allow_all_targets: type: boolean description: >- - Whether the caller sees only metadata available through - the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: + When true, allows models from the provider's built-in + model catalog in addition to explicit ``targets``. When + false, only models listed in ``targets`` are routable. + Defaults to false. CUSTOM providers have no built-in + model catalog and must leave this false and list their + models in ``targets``. + amazon_bedrock: type: object properties: - allow_all_targets: - type: boolean - description: >- - When true, accepts any model exposed by the upstream - provider; ``targets`` is not required and does not - restrict routability. When false, only models listed - in ``targets`` are routable. - amazon_bedrock: + direct: type: object properties: - direct: + aws_access_key: type: object properties: - aws_access_key: - type: object - properties: - access_key_id: - type: string - description: >- - AWS access key ID. Required on Create - when using access-key auth. Treated as - username-equivalent (not a secret - value): round-trips on reads and is - scrubbed from audit logs. - secret_access_key: - type: object - properties: - plaintext: - type: string - description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - AWS secret access key paired with - ``access_key_id``. Required on Create - when using access-key auth. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - description: >- - AWS access-key-pair auth. Mutually exclusive - with ``service_credential``. Supersedes the - flat ``aws_access_key_id`` / - ``aws_secret_access_key`` fields. - aws_access_key_id: + access_key_id: type: string description: >- - Deprecated flat AWS access key ID. - Superseded by - ``aws_access_key.access_key_id``. Kept for - one migration cycle; the handler mirrors it - to/from ``aws_access_key``. Treated as + AWS access key ID. Required on Create when + using access-key auth. Treated as username-equivalent (not a secret value): round-trips on reads and is scrubbed from audit logs. - aws_secret_access_key: + secret_access_key: type: object properties: plaintext: @@ -913,156 +633,199 @@ paths: Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. + ``plaintext``; the enclosing secret + object remains present to indicate that + a secret is configured. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- - Deprecated flat AWS secret access key. - Superseded by - ``aws_access_key.secret_access_key``. Kept - for one migration cycle; the handler mirrors - it to/from ``aws_access_key``. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - region: + AWS secret access key paired with + ``access_key_id``. Required when creating a + service with access-key authentication. + Supply the value in + ``secret_access_key.plaintext``. + description: >- + AWS access-key-pair authentication. Set + ``access_key_id`` and + ``secret_access_key.plaintext``. Mutually + exclusive with ``service_credential``. + region: + type: string + description: >- + AWS region where the Bedrock endpoint is hosted + (e.g., ``us-east-1``). Required on Create. + service_credential: + type: object + properties: + name: type: string description: >- - AWS region where the Bedrock endpoint is - hosted (e.g., ``us-east-1``). Required on - Create. - service_credential: + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Bedrock requests. On Create, supply + ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``aws_access_key``. The + credential is referenced by name; its value is + not carried here. Only supported on AWS-hosted + workspaces. + description: >- + Amazon Bedrock region and authentication + configuration. + description: Amazon Bedrock provider configuration. + anthropic: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: type: object properties: name: type: string description: >- - Resource name of the bound UC service - credential, in the AIP-122 form - ``credentials/{name}`` (a - metastore-level single-part credential - name). On create the caller supplies the - name here. On read it reflects the - credential's current name at read time. + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. required: - name description: >- - Reference to a UC service credential - authorizing Bedrock requests. On Create the - caller supplies ``service_credential.name`` - in the AIP-122 resource-name form - ``credentials/{name}``. Required on Create - when using UC-service-credential auth; - mutually exclusive with ``aws_access_key``. - The credential is referenced by name; its - value is not carried here. On read the - resolved ``id`` and ``is_deleted`` are also - populated. Only supported on AWS-hosted - workspaces; Create requests from other - clouds are rejected with - INVALID_PARAMETER_VALUE. - description: |- - Direct form of Amazon Bedrock provider config. - - Authentication is one of two mutually exclusive modes, exactly one of which must be supplied on - Create: - - - Access keys: set ``aws_access_key``, leave ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form - ``credentials/{name}``, leave ``aws_access_key`` unset. The credential value lives in UC and - is referenced by name, not held on this message. Setting more than one mode is rejected. - description: Amazon Bedrock provider configuration. - anthropic: + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Anthropic API key. Required when creating the + service. Supply the value in + ``api_key.plaintext``. + description: >- + Direct authentication with an API key supplied in + ``direct.api_key.plaintext``. Required unless + ``relayed`` is set. + relayed: + type: object + properties: {} + description: >- + Relayed authentication. Each inference request + supplies the caller's OAuth token, which is + forwarded to Anthropic. No Anthropic credential is + stored. Mutually exclusive with ``direct``. + description: >- + Anthropic provider configuration. Exactly one of + ``direct`` or ``relayed`` must be set on + Create; the two are mutually exclusive. + azure_openai: + type: object + properties: + direct: type: object properties: - direct: + api_key: type: object properties: - api_key: + plaintext: + type: string + description: >- + 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. + secret_reference: type: object properties: - plaintext: + name: type: string description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name description: >- - Anthropic API key. Required on Create. Sent - as the ``x-api-key`` header on outbound - requests. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- - Direct (inline-credentials) form: caller - supplies the API key in the request body. - Required on Create unless ``relayed`` is set. - relayed: - type: object - properties: - plan_type: - type: string - x-enum: - - ANTHROPIC_RELAYED_PLAN_TYPE_MAX - - >- - ANTHROPIC_RELAYED_PLAN_TYPE_TEAM_ENTERPRISE - description: >- - Which Anthropic subscription tier the - relayed token belongs to. Optional; when - unset the MPS gets the full governance - surface (see TEAM_ENTERPRISE). Immutable - after Create, so the tier cannot be flipped - in place. + Azure OpenAI API key. Supply the value in + ``api_key.plaintext``. Mutually exclusive with + Entra ID and Unity Catalog service credential + authentication. + base_url: + type: string description: >- - Relayed (credential-less) form: no Anthropic - credential is stored. Each inference request - instead carries the caller's own OAuth token, - which the platform forwards to Anthropic on - outbound requests. Mutually exclusive with - ``direct``; no ``api_key`` is required or - persisted. - description: >- - Anthropic provider configuration. Exactly one of - ``direct`` or ``relayed`` must be set on - Create; the two are mutually exclusive. - azure_openai: - type: object - properties: - direct: + Full Azure OpenAI endpoint base URL, e.g. + ``https://myresource.openai.azure.com``. + Required on Create. + entra_service_principal: type: object properties: - api_key: - type: object - properties: - plaintext: - type: string - description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Azure OpenAI API key. Mutually exclusive - with the Entra and service-credential modes. - Supplied as inline plaintext via - ``ProviderSecret.plaintext``. - base_url: - type: string - description: >- - Full Azure OpenAI endpoint base URL, e.g. - ``https://myresource.openai.azure.com``. - Required on Create. client_id: type: string description: >- - Deprecated flat Entra client ID. Superseded - by ``entra_service_principal.client_id``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. + Entra ID client (application) ID. Required + on Create. client_secret: type: object properties: @@ -1072,185 +835,93 @@ paths: Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Deprecated flat Entra client secret. - Superseded by - ``entra_service_principal.client_secret``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - entra_service_principal: - type: object - properties: - client_id: - type: string - description: >- - Entra ID client (application) ID. - Required on Create. - client_secret: + ``plaintext``; the enclosing secret + object remains present to indicate that + a secret is configured. + secret_reference: type: object properties: - plaintext: + name: type: string description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Entra ID client secret. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - tenant_id: - type: string - description: >- - Entra ID (Azure AD) tenant ID. Required - on Create. - description: >- - Entra ID (service principal) auth. Mutually - exclusive with ``api_key`` and - ``service_credential``. Supersedes the flat - ``tenant_id`` / ``client_id`` / - ``client_secret`` fields. - service_credential: - type: object - properties: - name: - type: string + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name description: >- - Resource name of the bound UC service - credential, in the AIP-122 form - ``credentials/{name}`` (a - metastore-level single-part credential - name). On create the caller supplies the - name here. On read it reflects the - credential's current name at read time. - required: - - name + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- - Reference to a UC service credential - authorizing Azure OpenAI requests. On Create - the caller supplies - ``service_credential.name`` in the AIP-122 - resource-name form ``credentials/{name}``. - Required on Create when using - UC-service-credential auth; mutually - exclusive with ``api_key`` and - ``entra_service_principal``. The credential - is referenced by name; its value is not - carried here. On read the resolved ``id`` - and ``is_deleted`` are also populated. Only - supported on Azure-hosted workspaces; Create - requests from other clouds are rejected with - INVALID_PARAMETER_VALUE. + Entra ID client secret. Supply the value in + ``client_secret.plaintext``. tenant_id: type: string description: >- - Deprecated flat Entra tenant ID. Superseded - by ``entra_service_principal.tenant_id``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. + Entra ID (Azure AD) tenant ID. Required on + Create. description: >- - Direct form of Azure OpenAI provider config. - Exactly one of three mutually-exclusive auth - modes - must be supplied on Create: - - - API key: set ``api_key``, leave ``entra_service_principal`` and ``service_credential`` unset. - - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and - ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form - ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. - description: Azure OpenAI provider configuration. - custom: - type: object - properties: - direct: + Entra ID service-principal authentication. Set + ``tenant_id``, ``client_id``, and + ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. + service_credential: type: object properties: - api_key: - type: object - properties: - plaintext: - type: string - description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Bearer token forwarded as the - ``Authorization: Bearer ...`` header on - outbound requests. Supplied as inline - plaintext via ``ProviderSecret.plaintext``. - Set this for bearer-token auth. - base_url: + name: type: string description: >- - Endpoint URL of the OpenAI-compatible - service (e.g., - ``https://api.example.com/v1``). Required on - Create. - description: |- - Direct form of custom provider config. - - Authentication is one of two mutually exclusive modes, exactly one of which must be supplied on - Create: - - - Bearer: set ``api_key``, leave ``header_auth`` unset. The secret is forwarded as - ``Authorization: Bearer ``. - - Header: set ``header_auth``, leave ``api_key`` unset. The secret is forwarded as - ``: ``. Setting both modes or neither mode is rejected. - description: >- - Custom provider configuration: arbitrary HTTP - endpoint with bearer-token auth. - forward_headers: - type: boolean - description: >- - Whether to forward incoming request headers to the - upstream provider. Applies to managed (multi-model) - requests as well as passthrough requests served by - this provider service. Governance-level decision by - the provider service owner; not selectable per - inference call. - forward_query_parameters: - type: boolean - description: >- - Whether to forward incoming request query parameters - to the upstream provider. Same trust-boundary - semantics as ``forward_headers``. - forward_unmanaged_paths: - type: boolean + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Azure OpenAI requests. On Create, + supply ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``api_key`` and + ``entra_service_principal``. The credential is + referenced by name; its value is not carried + here. Only supported on Azure-hosted workspaces. description: >- - Whether to forward request paths that fall outside - this service's managed API set to the upstream - provider as opaque passthrough. When true, requests - addressed to subpaths not recognized by the managed - API surface are proxied to the upstream provider - over the same provider connection. When false, only - managed-API paths are served. Governance-level - decision by the provider service owner; expanding - this expands the trust boundary that the - ModelProviderService exposes. - gemini_enterprise: + Azure OpenAI endpoint and authentication + configuration. + description: Azure OpenAI provider configuration. + bedrock_mantle: + type: object + properties: + direct: type: object properties: - direct: + aws_access_key: type: object properties: - api_key: + access_key_id: + type: string + description: >- + AWS access key ID. Required on Create when + using access-key auth. Treated as + username-equivalent (not a secret value): + round-trips on reads and is scrubbed from + audit logs. + secret_access_key: type: object properties: plaintext: @@ -1259,123 +930,141 @@ paths: Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Google Gemini Enterprise API key. Required - on Create. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. - project_id: - type: string - description: >- - GCP project ID hosting the Gemini Enterprise - endpoint. Required on Create. - region: - type: string + ``plaintext``; the enclosing secret + object remains present to indicate that + a secret is configured. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- - GCP region of the Gemini Enterprise endpoint - (e.g., ``us-central1``). Required on Create. - description: >- - Direct form of Gemini Enterprise provider - config. - description: Gemini Enterprise provider configuration. - inference_table: - type: object - properties: - parent: - type: string - description: >- - Parent UC schema where the inference table is - created. Format: ``schemas/{catalog}.{schema}``. - Set at create time and immutable thereafter; - changing it on an existing service is rejected. - disabled: - type: boolean - description: >- - Indicates whether payload logging is disabled - (opt-out). Unset means that payload logging is - active (the on-by-default state coincides with - the proto zero-value, so the server never fills - this field for a client that leaves it unset). - Set ``disabled = true`` to pause runtime logging - while keeping the sub-message attached - (preserving ``parent`` and ``table_name_prefix`` - for a later flip back to active). ``parent`` - remains required either way. - is_deleted: - type: boolean + AWS secret access key paired with + ``access_key_id``. Required when creating a + service with access-key authentication. + Supply the value in + ``secret_access_key.plaintext``. description: >- - True when the bound inference TABLE has been - deleted but the parent service still references - it. The dangling reference is surfaced (not - silently dropped) so callers can see the broken - dependency. AI Gateway payload logging fails - closed in this state. - table: + AWS access-key-pair authentication. Set + ``access_key_id`` and + ``secret_access_key.plaintext``. Mutually + exclusive with ``service_credential``. + region: type: string description: >- - Resolved UC table for payload logs. Format: - ``tables/{catalog}.{schema}.{table}``. - table_name_prefix: - type: string + AWS region where the Bedrock endpoint is hosted + (e.g., ``us-east-1``). Required on Create. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name description: >- - Prefix for the inference-table's UC-registered - name. The actual leaf name UC stores is - ``_payload``; the - ``_payload`` suffix is appended automatically. - To find the actual UC table after Create, read - the ``table`` field on the response. Defaults to - ``_payload`` when unset. Set - at create time and immutable thereafter; - changing it on an existing service is rejected. - required: - - parent + Reference to a Unity Catalog service credential + authorizing Bedrock requests. On Create, supply + ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``aws_access_key``. The + credential is referenced by name; its value is + not carried here. Only supported on AWS-hosted + workspaces. description: >- - Inference table configuration for payload logging - when this provider service is invoked directly. When - it is invoked through a model service, the model - service's own inference table captures the - invocation instead. Mirrors - ``ModelServiceConfig.inference_table`` / - ``AgentServiceConfig.inference_table``. - microsoft_foundry: + Amazon Bedrock region and authentication + configuration. + description: Amazon Bedrock provider configuration. + custom: + type: object + properties: + direct: type: object properties: - direct: + api_key: type: object properties: - api_key: + plaintext: + type: string + description: >- + 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. + secret_reference: type: object properties: - plaintext: + name: type: string description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Microsoft AI Foundry API key. Mutually - exclusive with the Entra and - service-credential modes. Supplied as inline - plaintext via ``ProviderSecret.plaintext``. - base_url: - type: string + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name description: >- - Microsoft AI Foundry endpoint URL. Required - on Create. - client_id: + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Bearer token forwarded in the ``Authorization`` + header. Supply the value in + ``api_key.plaintext``. + base_url: + type: string + description: >- + Endpoint URL of the OpenAI-compatible service + (e.g., ``https://api.example.com/v1``). Required + on Create. + header_auth: + type: object + properties: + api_key_name: type: string description: >- - Deprecated flat Entra client ID. Superseded - by ``entra_service_principal.client_id``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. - client_secret: + HTTP header name that carries the API key on + outbound requests (e.g., + ``Ocp-Apim-Subscription-Key``). The value + forwarded under this header is supplied via + ``api_key_value``. + api_key_value: type: object properties: plaintext: @@ -1384,115 +1073,261 @@ paths: Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. - description: >- - Deprecated flat Entra client secret. - Superseded by - ``entra_service_principal.client_secret``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - entra_service_principal: - type: object - properties: - client_id: - type: string - description: >- - Entra ID client (application) ID. - Required on Create. - client_secret: + ``plaintext``; the enclosing secret + object remains present to indicate that + a secret is configured. + secret_reference: type: object properties: - plaintext: + name: type: string description: >- - Inline plaintext credential. INPUT_ONLY: - the value never round-trips on reads. - Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name description: >- - Entra ID client secret. Supplied as - inline plaintext via - ``ProviderSecret.plaintext``. - tenant_id: - type: string - description: >- - Entra ID (Azure AD) tenant ID. Required - on Create. + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Secret value forwarded under the + ``api_key_name`` header on outbound + requests. Supplied as inline plaintext via + ``ProviderSecret.plaintext``. + description: >- + Header-based API-key auth: the secret is + forwarded on outbound requests under a + caller-chosen HTTP header rather than as an + ``Authorization`` bearer token. Set this instead + of ``api_key`` for header auth. + description: >- + Endpoint and authentication configuration for the + custom provider. + description: Custom OpenAI-compatible provider configuration. + forward_headers: + type: boolean + description: >- + Whether to forward incoming HTTP headers to the upstream + provider. Defaults to false and is configured for the + entire provider service, not per request. Upstream + authentication is configured separately in the + provider-specific configuration. + forward_query_parameters: + type: boolean + description: >- + Whether to forward incoming query parameters to the + upstream provider. Defaults to false and is configured + for the entire provider service, not per request. + forward_unmanaged_paths: + type: boolean + description: >- + Whether to proxy paths that AI Gateway does not + recognize as configured provider-native API types. + Defaults to false. When true, these paths are forwarded + unchanged to the upstream provider. When false, only + recognized API paths are served. Enabling this broadens + the upstream API surface exposed through the provider + service. AI Gateway cannot evaluate Service Policies on + opaque unmanaged requests, so unmanaged requests are + rejected whenever Service Policies are attached to this + securable. + gemini_enterprise: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string description: >- - Entra ID (service principal) auth. Mutually - exclusive with ``api_key`` and - ``service_credential``. Supersedes the flat - ``tenant_id`` / ``client_id`` / - ``client_secret`` fields. - service_credential: + 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. + secret_reference: type: object properties: name: type: string description: >- - Resource name of the bound UC service - credential, in the AIP-122 form - ``credentials/{name}`` (a - metastore-level single-part credential - name). On create the caller supplies the - name here. On read it reflects the - credential's current name at read time. + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. required: - name description: >- - Reference to a UC service credential - authorizing Microsoft Foundry requests. On - Create the caller supplies - ``service_credential.name`` in the AIP-122 - resource-name form ``credentials/{name}``. - Required on Create when using - UC-service-credential auth; mutually - exclusive with ``api_key`` and - ``entra_service_principal``. The credential - is referenced by name; its value is not - carried here. On read the resolved ``id`` - and ``is_deleted`` are also populated. Only - supported on Azure-hosted workspaces; Create - requests from other clouds are rejected with - INVALID_PARAMETER_VALUE. - tenant_id: + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Google Gemini Enterprise API key. Required when + creating the service. Supply the value in + ``api_key.plaintext``. + project_id: + type: string + description: >- + GCP project ID hosting the Gemini Enterprise + endpoint. Required on Create. + region: + type: string + description: >- + GCP region of the Gemini Enterprise endpoint + (e.g., ``us-central1``). Required on Create. + service_credential: + type: object + properties: + name: type: string description: >- - Deprecated flat Entra tenant ID. Superseded - by ``entra_service_principal.tenant_id``. - Kept for one migration cycle; the handler - mirrors it to/from - ``entra_service_principal``. + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name description: >- - Direct form of Microsoft Foundry provider - config. - - Authentication is one of three mutually exclusive modes, exactly one of which must be supplied - on Create: - - - API key: set ``api_key``, leave ``entra_service_principal`` and ``service_credential`` unset. - - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and - ``service_credential`` unset. AI Gateway exchanges these for an Entra bearer token on outbound - requests via the OAuth2 client-credentials grant. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form - ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. - description: Microsoft Foundry provider configuration. - openai: + Reference to a Unity Catalog service credential + authorizing Gemini Enterprise requests. On + Create, supply ``service_credential.name`` as + ``credentials/{name}``; required when using + service-credential authentication and mutually + exclusive with ``api_key``. The credential is + referenced by name; its value is not carried + here. On read, the resolved ``id`` and + ``is_deleted`` are also populated. Supported + only on GCP-hosted workspaces. + description: >- + Gemini Enterprise project, region, and + authentication configuration. + description: Gemini Enterprise provider configuration. + inference_table: + type: object + properties: + parent: + type: string + description: >- + Parent Unity Catalog schema where the inference + table is created, in the form + ``schemas/{catalog}.{schema}``. Required when + configuring an inference table. After the inference + table is created, this field cannot be changed. + is_deleted: + type: boolean + description: >- + Whether the referenced inference table has been + deleted. The configuration remains visible so you + can identify the broken dependency. Payload logging + cannot continue until the table is restored or the + configuration is updated. + table: + type: string + description: >- + Resolved UC table for payload logs. Format: + ``tables/{catalog}.{schema}.{table}``. + table_name_prefix: + type: string + description: >- + Prefix used to form the inference table's registered + name. AI Gateway appends ``_payload``; for example, + ``table_name_prefix = "orders"`` creates + ``orders_payload``. If unset, the prefix defaults to + the service name. Read ``table`` from the response + for the resulting resource name. After the inference + table is created, this field cannot be changed. + required: + - parent + description: >- + Payload logging configuration for requests sent directly + to this provider service. Requests routed through a + model service are captured by that model service's + inference table instead. + microsoft_foundry: + type: object + properties: + direct: type: object properties: - direct: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Microsoft Foundry API key. Supply the value in + ``api_key.plaintext``. Mutually exclusive with + Entra ID and Unity Catalog service credential + authentication. + base_url: + type: string + description: >- + Microsoft Foundry endpoint URL. Required on + Create. + entra_service_principal: type: object properties: - api_key: + client_id: + type: string + description: >- + Entra ID client (application) ID. Required + on Create. + client_secret: type: object properties: plaintext: @@ -1501,222 +1336,317 @@ paths: Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List responses omit - ``plaintext``; the field's presence in - the read shape only indicates that a - secret is configured. + ``plaintext``; the enclosing secret + object remains present to indicate that + a secret is configured. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- - OpenAI API key. Required on Create. Supplied - as inline plaintext via - ``ProviderSecret.plaintext``. - base_url: + Entra ID client secret. Supply the value in + ``client_secret.plaintext``. + tenant_id: type: string description: >- - Optional custom base URL. Defaults to - ``https://api.openai.com/v1``. Use for - OpenAI-API-compatible third-party endpoints - or in-network proxies. - organization: + Entra ID (Azure AD) tenant ID. Required on + Create. + description: >- + Entra ID service-principal authentication. Set + ``tenant_id``, ``client_id``, and + ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. + service_credential: + type: object + properties: + name: type: string description: >- - Optional OpenAI organization ID. When set, - the platform forwards it as the - ``OpenAI-Organization`` header. + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name description: >- - Direct (inline-credentials) form of the OpenAI - provider config. - description: OpenAI provider configuration. - provider_type: - type: string - x-enum: - - EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK - - EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC - - EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI - - EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM - - EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE - - EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY - - EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI - description: >- - Provider type discriminator. Required at create - time; immutable after. Determines which variant of - the ``provider`` oneof must be set. May not be - changed via Update; attempts to include - ``config.provider_type`` in - ``UpdateModelProviderServiceRequest.update_mask`` - are rejected. Required on CreateModelProviderService - and immutable thereafter. - rate_limits: - type: array - items: - type: object - properties: - key: - type: string - x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - - RATE_LIMIT_KEY_SERVICE - - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - - RATE_LIMIT_KEY_USER - - RATE_LIMIT_KEY_USER_DEFAULT - - RATE_LIMIT_KEY_USER_GROUP - description: >- - Scope key. Determines whether ``principal`` is - required. - renewal_period: - type: string - x-enum: - - RATE_LIMIT_RENEWAL_PERIOD_HOUR - - RATE_LIMIT_RENEWAL_PERIOD_MINUTE - description: Renewal period. - principal: - type: string - description: >- - Principal this limit applies to: user email, - group name, or service principal application - ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, - ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not - set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. - Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only - valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to - apply the limit to every value of - ``request_tag_key`` (an any-value default); a - set value is a specific override for that - value. - requests: - type: integer - description: >- - Max requests allowed within a renewal period. - Leave unset for no request limit. - tokens: - type: integer - description: >- - Max tokens allowed within a renewal period. - Leave unset for no token limit. - required: - - key - - renewal_period - description: >- - A rate limit applied to service requests. Leave - ``requests`` or ``tokens`` unset to impose no - limit on that dimension; set a value to cap that dimension within the renewal period. + Reference to a Unity Catalog service credential + authorizing Microsoft Foundry requests. On + Create, supply ``service_credential.name`` in + the form ``credentials/{name}``. Required on + Create when using service-credential + authentication; mutually exclusive with + ``api_key`` and ``entra_service_principal``. The + credential is referenced by name; its value is + not carried here. Only supported on Azure-hosted + workspaces. description: >- - Rate limits applied when this provider service is - invoked directly. When it is invoked through a model - service, the model service's own ``rate_limits`` - apply instead. Mirrors - ``ModelServiceConfig.rate_limits`` / - ``McpServiceConfig.rate_limits``. - targets: - type: array - items: - type: object - properties: - model: - type: string - description: >- - Provider-side model identifier (e.g. "gpt-5", - "claude-opus-4-7"). This is a string on the - LLM provider's side, not a UC entity. The UC - governance hook for external destinations is - the ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, - not the model itself. - native_api_types: - type: array - items: + Microsoft Foundry endpoint and authentication + configuration. + description: Microsoft Foundry provider configuration. + openai: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: type: string - description: >- - Provider-native API types the model supports - (e.g. "openai/v1/chat/completions"). Used by - the platform for request/response translation - from the unified API type. At most 64 entries - of at most 256 characters each; the list is - persisted into the destination binding's - bounded storage envelope. - required: - - model - description: >- - Model target configuration for an external model - destination. + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + OpenAI API key. Required when creating the + service. Supply the value in + ``api_key.plaintext``. + base_url: + type: string + description: >- + Optional custom base URL. Defaults to + ``https://api.openai.com/v1``. Use for + OpenAI-API-compatible third-party endpoints or + in-network proxies. + organization: + type: string + description: >- + Optional OpenAI organization ID. When set, the + platform forwards it as the + ``OpenAI-Organization`` header. description: >- - Routing targets this provider service exposes - (provider-side model identifier + unified API types - per entry). Required (>=1) when ``allow_all_targets - = false``; optional and additive when - ``allow_all_targets = true``. References from - ``ExternalModelConfig.target`` must match an entry - here unless ``allow_all_targets = true``. - description: >- - Behavioral configuration: provider connection, model - catalog, and passthrough policy. See - ``ModelProviderServiceConfig`` for the per-field - contract. Required on CreateModelProviderService; on - Update it is required only when ``config`` (or a - ``config.*`` subpath) appears in ``update_mask``. - create_time: - type: string - format: date-time - description: When the provider service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string + OpenAI configuration with an API key supplied in the + request. + description: OpenAI provider configuration. + pricing: + type: object + properties: + default_discount_basis_points: + type: integer + description: >- + Provider-wide adjustment to external-model spend + estimates in basis points: 2000 = 20% off; -2000 = a + 20% markup. Negative values have no lower bound + beyond the int32 range. Values cannot exceed 10000 + (100% off). An omitted value or zero leaves the + estimate unchanged. description: >- - The resolved owner of the model provider service. Falls - back to the caller's identity when ``owner`` is not - explicitly set on creation. - etag: + Pricing configuration for this provider service. An + explicitly empty configuration is retained on Create and + Update and applies no adjustment. + provider_type: type: string + x-enum: + - EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK + - EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC + - EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI + - EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE + - EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM + - EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE + - EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY + - EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI description: >- - Optimistic concurrency control token. Server-generated - from the entity's state and returned on every read. To - use it as an if-match precondition on a mutation, echo - the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects - the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the provider service. - name: - type: string + External model provider. Required on Create and + immutable thereafter. Set the matching provider-specific + configuration, such as ``openai``, ``azure_openai``, or + ``amazon_bedrock``. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. description: >- - 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. - owner: - type: string + Rate limits for requests sent directly to this provider + service. Requests routed through a model service use + that model service's rate limits instead. + targets: + type: array + items: + type: object + properties: + model: + type: string + description: >- + Provider-side model identifier, such as ``gpt-5`` + or ``claude-opus-4-7``. This identifies a model at + the upstream provider; it is not a Unity Catalog + model resource. + endpoint_route: + type: string + description: >- + Relative path appended to a custom provider's + ``base_url`` for this model, such as + ``serve/openai/chat``. Nonempty values are only + supported for custom model provider service + targets; other provider types reject them. Model + service destinations do not support this field. Do + not include URI templates, queries, or fragments. + When empty, ``base_url`` is used unchanged. + native_api_types: + type: array + items: + type: string + description: >- + Provider-native API types supported by this model, + such as ``openai/v1/chat/completions``. A model + provider service target requires at least one + value. A model service destination may omit the + list to use the matching provider service target's + types when available. AI Gateway uses the selected + types for translation. At most 64 entries of 256 + characters each are allowed. + required: + - model + description: >- + Model target configuration shared by model provider + service targets and external model + destinations on model services. description: >- - The owner of the model provider service. Write-only; - read owner via effective_owner. - update_time: - type: string - format: date-time - description: When the provider service was last modified. - updated_by: - type: string - description: Identity of the last updater. + Models and provider-native API types exposed by this + provider service. Each entry must include at least one + ``native_api_types`` value. When ``allow_all_targets`` + is false, at least one entry is required and model + service destinations can reference only listed models. + When ``allow_all_targets`` is true, models from the + provider's built-in model catalog are also routable. + CUSTOM providers must explicitly list their models here + and cannot enable ``allow_all_targets``. description: >- - The model provider service to create. The server populates - ``name`` from ``parent`` + ``model_provider_service_id``; - clients should leave it unset. - required: - - model_provider_service + Provider authentication, exposed models, request-forwarding + controls, rate limits, and payload logging. Required on + Create. On Update, it is required only when ``config`` or + one of its subpaths appears in ``update_mask``. + create_time: + type: string + format: date-time + description: Time the provider service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the model provider service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the provider service. + name: + type: string + description: >- + 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. + update_time: + type: string + format: date-time + description: Time the provider service was last modified. + updated_by: + type: string + description: Identity of the last updater. responses: '200': description: Success @@ -1763,59 +1693,55 @@ paths: ``MANAGE``) are returned. - :param include_browse: bool (optional) - Whether to include provider services for which the principal can only access selective metadata. :param page_size: int (optional) - Maximum number of provider services to return. Defaults to 100 when unset or 0; the maximum is 1000. - Use ``next_page_token`` to retrieve additional pages. + Maximum number of provider services to return. Defaults to 200 when unset or 0; the maximum is 1000 + for ``view = BASIC`` and 200 for ``view = FULL``. Use ``page_token`` to retrieve additional pages. :param page_token: str (optional) - Opaque pagination token from a previous request. + Opaque pagination token from the previous response. :param parent: str (optional) - Resource name of the parent schema to list within, as ``schemas/{catalog}.{schema}``. Each ``{...}`` + Parent schema to list within, in the form ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component is capped at 255 characters individually. :param view: :class:`ListModelProviderServicesRequestView` (optional) - View selector controlling which fields are populated per row. + Fields to return for each service. ``FULL`` includes resolved service-credential and inference-table + details and rate-limit principal names. ``BASIC`` omits those details and principal names from rate + limits. Defaults to ``BASIC`` when unset. :returns: Iterator over :class:`ModelProviderService` parameters: - - name: include_browse - in: query - required: false - schema: - type: boolean - description: >- - Whether to include provider services for which the principal can - only access selective metadata. - name: page_size in: query required: false schema: type: integer description: >- - Maximum number of provider services to return. Defaults to 100 when - unset or 0; the maximum is 1000. Use ``next_page_token`` to retrieve - additional pages. + Maximum number of provider services to return. Defaults to 200 when + unset or 0; the maximum is 1000 for ``view = BASIC`` and 200 for + ``view = FULL``. Use ``page_token`` to retrieve additional pages. - name: page_token in: query required: false schema: type: string - description: Opaque pagination token from a previous request. + description: Opaque pagination token from the previous response. - name: parent in: query required: false schema: type: string description: >- - Resource name of the parent schema to list within, as - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. + Parent schema to list within, in the form + ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component + is capped at 255 characters individually. - name: view in: query required: false schema: $ref: '#/components/schemas/ListModelProviderServicesRequestView' - description: View selector controlling which fields are populated per row. + description: >- + Fields to return for each service. ``FULL`` includes resolved + service-credential and inference-table details and rate-limit + principal names. ``BASIC`` omits those details and principal names + from rate limits. Defaults to ``BASIC`` when unset. responses: '200': description: Success @@ -1848,8 +1774,8 @@ paths: Creates a model service in a Unity Catalog schema. A model service is a governed AI Gateway endpoint - that routes inference requests to one or more model destinations. The - caller supplies the leaf name in + that routes inference requests to one or more model destinations. + Specify its name in ``model_service_id``. @@ -1858,18 +1784,28 @@ paths: ``CREATE_SERVICE`` and ``USE_SCHEMA`` privileges on the parent schema and ``USE_CATALOG`` on the parent - catalog. + catalog. For every destination, you + + also need ``USE_CATALOG`` and ``USE_SCHEMA`` on its parent and + ``EXECUTE`` on the referenced Unity + + Catalog model or model provider service. A provisioned-throughput + destination additionally requires + + ``CAN_MANAGE`` on its Model Serving endpoint. Configuring an inference + table additionally requires + + ``CREATE_TABLE``. :param model_service: :class:`ModelService` - The model service to create. The server populates ``name`` from ``parent`` + ``model_service_id``; - clients should leave it unset. + The model service to create. Do not set ``name``; the server derives it from ``parent`` and + ``model_service_id``. :param parent: str - Resource name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component - is capped at 255 characters individually. + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component is + capped at 255 characters individually. :param model_service_id: str - Leaf identifier for the model service (the unqualified name within the parent schema, e.g. - "my_model_service"). + Name for the model service, e.g. "my_model_service". :returns: :class:`ModelService` parameters: @@ -1879,188 +1815,320 @@ paths: schema: type: string description: >- - Resource name of the parent schema. Format: - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. + Each ``{...}`` component is capped at 255 characters individually. - name: model_service_id in: query required: true schema: type: string - description: >- - Leaf identifier for the model service (the unqualified name within - the parent schema, e.g. "my_model_service"). + description: Name for the model service, e.g. "my_model_service". requestBody: content: application/json: schema: type: object properties: - model_service: + comment: + type: string + description: User-provided description. + config: type: object properties: - browse_only: - type: boolean + inference_table: + type: object + properties: + parent: + type: string + description: >- + Parent Unity Catalog schema where the inference + table is created, in the form + ``schemas/{catalog}.{schema}``. Required when + configuring an inference table. After the inference + table is created, this field cannot be changed. + is_deleted: + type: boolean + description: >- + Whether the referenced inference table has been + deleted. The configuration remains visible so you + can identify the broken dependency. Payload logging + cannot continue until the table is restored or the + configuration is updated. + table: + type: string + description: >- + Resolved UC table for payload logs. Format: + ``tables/{catalog}.{schema}.{table}``. + table_name_prefix: + type: string + description: >- + Prefix used to form the inference table's registered + name. AI Gateway appends ``_payload``; for example, + ``table_name_prefix = "orders"`` creates + ``orders_payload``. If unset, the prefix defaults to + the service name. Read ``table`` from the response + for the resulting resource name. After the inference + table is created, this field cannot be changed. + required: + - parent + description: Inference table configuration for payload logging. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. description: >- - Whether the caller sees only metadata available through - the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: + Rate limits applied to requests routed through this + model service. + routing: type: object properties: - inference_table: - type: object - properties: - parent: - type: string - description: >- - Parent UC schema where the inference table is - created. Format: ``schemas/{catalog}.{schema}``. - Set at create time and immutable thereafter; - changing it on an existing service is rejected. - disabled: - type: boolean - description: >- - Indicates whether payload logging is disabled - (opt-out). Unset means that payload logging is - active (the on-by-default state coincides with - the proto zero-value, so the server never fills - this field for a client that leaves it unset). - Set ``disabled = true`` to pause runtime logging - while keeping the sub-message attached - (preserving ``parent`` and ``table_name_prefix`` - for a later flip back to active). ``parent`` - remains required either way. - is_deleted: - type: boolean - description: >- - True when the bound inference TABLE has been - deleted but the parent service still references - it. The dangling reference is surfaced (not - silently dropped) so callers can see the broken - dependency. AI Gateway payload logging fails - closed in this state. - table: - type: string - description: >- - Resolved UC table for payload logs. Format: - ``tables/{catalog}.{schema}.{table}``. - table_name_prefix: - type: string - description: >- - Prefix for the inference-table's UC-registered - name. The actual leaf name UC stores is - ``_payload``; the - ``_payload`` suffix is appended automatically. - To find the actual UC table after Create, read - the ``table`` field on the response. Defaults to - ``_payload`` when unset. Set - at create time and immutable thereafter; - changing it on an existing service is rejected. - required: - - parent - description: Inference table config for payload logging. - rate_limits: + destinations: type: array items: type: object properties: - key: + name: type: string - x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - - RATE_LIMIT_KEY_SERVICE - - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - - RATE_LIMIT_KEY_USER - - RATE_LIMIT_KEY_USER_DEFAULT - - RATE_LIMIT_KEY_USER_GROUP description: >- - Scope key. Determines whether ``principal`` is - required. - renewal_period: + User-facing label for this destination, used + in routing references. + destination_type: type: string x-enum: - - RATE_LIMIT_RENEWAL_PERIOD_HOUR - - RATE_LIMIT_RENEWAL_PERIOD_MINUTE - description: Renewal period. - principal: - type: string - description: >- - Principal this limit applies to: user email, - group name, or service principal application - ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, - ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not - set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. - Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only - valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to - apply the limit to every value of - ``request_tag_key`` (an any-value default); a - set value is a specific override for that - value. - requests: - type: integer - description: >- - Max requests allowed within a renewal period. - Leave unset for no request limit. - tokens: - type: integer + - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL description: >- - Max tokens allowed within a renewal period. - Leave unset for no token limit. - required: - - key - - renewal_period - description: >- - A rate limit applied to service requests. Leave - ``requests`` or ``tokens`` unset to impose no - limit on that dimension; set a value to cap that dimension within the renewal period. - description: >- - Rate limits applied to requests routed through this - model service. - routing: - type: object - properties: - destinations: - type: array - items: + Backing-model category. Provide the matching + type-specific configuration and leave the + other type-specific configurations unset. + external_model_config: type: object properties: - name: - type: string - description: >- - User-facing label for this destination, - used in routing references. - destination_type: + model_provider_service: type: string - x-enum: - - >- - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL description: >- - Backing-model category. Determines which - oneof variant is populated. - external_model_config: + Resource name of the governed + ModelProviderService that owns provider + auth and provider-specific configuration. + The referenced ModelProviderService also + carries the provider type, so this message + does not surface it directly. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. + Each ``{...}`` component is capped at 255 + characters individually. + target: type: object properties: - model_provider_service: + model: + type: string + description: >- + Provider-side model identifier, such as + ``gpt-5`` or ``claude-opus-4-7``. This + identifies a model at the upstream + provider; it is not a Unity Catalog + model resource. + endpoint_route: + type: string + description: >- + Relative path appended to a custom + provider's ``base_url`` for this model, + such as ``serve/openai/chat``. Nonempty + values are only supported for custom + model provider service targets; other + provider types reject them. Model + service destinations do not support this + field. Do not include URI templates, + queries, or fragments. When empty, + ``base_url`` is used unchanged. + native_api_types: + type: array + items: + type: string + description: >- + Provider-native API types supported by + this model, such as + ``openai/v1/chat/completions``. A model + provider service target requires at + least one value. A model service + destination may omit the list to use the + matching provider service target's types + when available. AI Gateway uses the + selected types for translation. At most + 64 entries of 256 characters each are + allowed. + required: + - model + description: >- + Routing target for the destination: the + provider-side model selected from the + referenced ModelProviderService's + ``targets`` catalog, plus the unified API + types the platform should translate + to/from at request time. + required: + - model_provider_service + - target + description: >- + Configuration for an external model reached + through a model provider service. + is_deleted: + type: boolean + description: >- + Whether the destination's backing model or + model provider service has been deleted. The + destination remains visible so you can + identify the broken dependency. Requests + cannot use this destination until the backing + resource is restored or the destination is + replaced. + pay_per_token_config: + type: object + properties: + model: + type: string + description: >- + Resource name of the Unity Catalog model. + Format: + ``models/{catalog}.{schema}.{model}``. + required: + - model + description: >- + Configuration for a pay-per-token Databricks + foundation model. + provisioned_throughput_config: + type: object + properties: + model_serving_endpoint: + type: string + description: >- + Name of the backing Model Serving endpoint + serving the provisioned- throughput + foundation model, in the form + ``serving-endpoints/{name}``. The same + Unity Catalog model can be served on + multiple Model Serving endpoints with + different throughput, regions, or + configurations. The caller selects the + endpoint to which this destination routes. + The endpoint must exist at create time. + model: + type: string + description: >- + UC model FQN of the model served by the + backing endpoint (e.g., + ``system.ai.databricks-claude-opus-4-6``). + Resolved from Model Serving at + Create/Update time. + required: + - model_serving_endpoint + description: >- + Configuration for a provisioned-throughput + Databricks foundation model. + traffic_percentage: + type: integer + description: >- + Percentage of primary traffic sent to this + destination, from 0 to 100. Required when + there is more than one primary destination, in + which case the primary percentages must sum to + 100; a single primary destination receives all + traffic. Fallback destinations are ordered and + do not use this field. + required: + - name + - destination_type + description: >- + A destination the model service can route traffic + to. Exactly one of the per-type configs inside + ``type_config`` must be set, and it must match ``destination_type``. + description: >- + Primary routing destinations. At most 10 are + allowed. At least one is required on Create. On + Update, provide this list when replacing the full + ``config`` or updating + ``config.routing.destinations``; other granular + routing updates do not require resending + destinations. The intermediate ``config.routing`` + mask path is not supported. + fallback: + type: object + properties: + destinations: + type: array + items: + type: object + properties: + name: + type: string + description: >- + User-facing label for this destination, + used in routing references. + destination_type: + type: string + x-enum: + - >- + DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL + description: >- + Backing-model category. Provide the + matching type-specific configuration and + leave the other type-specific + configurations unset. + external_model_config: + type: object + properties: + model_provider_service: type: string description: >- Resource name of the governed @@ -2079,28 +2147,40 @@ paths: model: type: string description: >- - Provider-side model identifier (e.g. - "gpt-5", "claude-opus-4-7"). This is a - string on the LLM provider's side, not a - UC entity. The UC governance hook for - external destinations is the - ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, - not the model itself. + Provider-side model identifier, such as + ``gpt-5`` or ``claude-opus-4-7``. This + identifies a model at the upstream + provider; it is not a Unity Catalog + model resource. + endpoint_route: + type: string + description: >- + Relative path appended to a custom + provider's ``base_url`` for this model, + such as ``serve/openai/chat``. Nonempty + values are only supported for custom + model provider service targets; other + provider types reject them. Model + service destinations do not support this + field. Do not include URI templates, + queries, or fragments. When empty, + ``base_url`` is used unchanged. native_api_types: type: array items: type: string description: >- - Provider-native API types the model - supports (e.g. - "openai/v1/chat/completions"). Used by - the platform for request/response - translation from the unified API type. - At most 64 entries of at most 256 - characters each; the list is persisted - into the destination binding's bounded - storage envelope. + Provider-native API types supported by + this model, such as + ``openai/v1/chat/completions``. A model + provider service target requires at + least one value. A model service + destination may omit the list to use the + matching provider service target's types + when available. AI Gateway uses the + selected types for translation. At most + 64 entries of 256 characters each are + allowed. required: - model description: >- @@ -2114,39 +2194,32 @@ paths: - model_provider_service - target description: >- - Configuration for an - external-foundation-model destination. - Provider auth and provider-specific - cloud configuration are owned by a separate, governed ModelProviderService entity referenced via - ``model_provider_service``; the platform resolves the provider at invocation time. + Configuration for an external model + reached through a model provider service. is_deleted: type: boolean description: >- - True when the destination's backing UC - entity (MODEL for foundation-model - destinations, MODEL_PROVIDER_SERVICE for - external destinations) has been deleted - but the destination row still references - it. The dangling destination is surfaced - (not silently dropped) so callers can see - the broken routing. Inference traffic - through this destination fails closed - (BAD_REQUEST / FAILED_PRECONDITION). + Whether the destination's backing model or + model provider service has been deleted. + The destination remains visible so you can + identify the broken dependency. Requests + cannot use this destination until the + backing resource is restored or the + destination is replaced. pay_per_token_config: type: object properties: model: type: string description: >- - Resource name of the UC model. Format: + Resource name of the Unity Catalog + model. Format: ``models/{catalog}.{schema}.{model}``. required: - model description: >- Configuration for a pay-per-token - foundation-model destination. Identifies - the foundation model - by its UC resource name; the platform resolves it to a Model Serving endpoint at request time. + Databricks foundation model. provisioned_throughput_config: type: object properties: @@ -2155,14 +2228,15 @@ paths: description: >- Name of the backing Model Serving endpoint serving the provisioned- - throughput foundation model, as the - AIP-122 typed resource name + throughput foundation model, in the form ``serving-endpoints/{name}``. The same - UC model can be served on multiple Model - Serving endpoints (different throughput - / region / config); the caller picks - which one this destination routes to. - The endpoint must exist at create time. + Unity Catalog model can be served on + multiple Model Serving endpoints with + different throughput, regions, or + configurations. The caller selects the + endpoint to which this destination + routes. The endpoint must exist at + create time. model: type: string description: >- @@ -2175,15 +2249,18 @@ paths: - model_serving_endpoint description: >- Configuration for a provisioned-throughput - foundation-model destination. References a - pre-existing Model Serving endpoint that serves the model; sizing (provisioned throughput, burst - scaling, model version) is owned by the Model Serving endpoint itself, not by this message. + Databricks foundation model. traffic_percentage: type: integer description: >- - Share of traffic sent to this destination, - 0-100. Optional on fallback destinations; - see FallbackConfig. + Percentage of primary traffic sent to this + destination, from 0 to 100. Required when + there is more than one primary + destination, in which case the primary + percentages must sum to 100; a single + primary destination receives all traffic. + Fallback destinations are ordered and do + not use this field. required: - name - destination_type @@ -2193,268 +2270,64 @@ paths: configs inside ``type_config`` must be set, and it must match ``destination_type``. description: >- - Primary routing destinations. At most 10 are - allowed. At least one is required on - CreateModelService; on UpdateModelService it is - required only when ``config.routing`` (or a - ``config.routing.*`` subpath) appears in - ``update_mask``. - fallback: - type: object - properties: - destinations: - type: array - items: - type: object - properties: - name: - type: string - description: >- - User-facing label for this destination, - used in routing references. - destination_type: - type: string - x-enum: - - >- - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL - description: >- - Backing-model category. Determines which - oneof variant is populated. - external_model_config: - type: object - properties: - model_provider_service: - type: string - description: >- - Resource name of the governed - ModelProviderService that owns provider - auth and provider-specific - configuration. The referenced - ModelProviderService also carries the - provider type, so this message does not - surface it directly. Format: - ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. - Each ``{...}`` component is capped at - 255 characters individually. - target: - type: object - properties: - model: - type: string - description: >- - Provider-side model identifier (e.g. - "gpt-5", "claude-opus-4-7"). This is a - string on the LLM provider's side, not a - UC entity. The UC governance hook for - external destinations is the - ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, - not the model itself. - native_api_types: - type: array - items: - type: string - description: >- - Provider-native API types the model - supports (e.g. - "openai/v1/chat/completions"). Used by - the platform for request/response - translation from the unified API type. - At most 64 entries of at most 256 - characters each; the list is persisted - into the destination binding's bounded - storage envelope. - required: - - model - description: >- - Routing target for the destination: the - provider-side model selected from the - referenced ModelProviderService's - ``targets`` catalog, plus the unified - API types the platform should translate - to/from at request time. - required: - - model_provider_service - - target - description: >- - Configuration for an - external-foundation-model destination. - Provider auth and provider-specific - cloud configuration are owned by a separate, governed ModelProviderService entity referenced via - ``model_provider_service``; the platform resolves the provider at invocation time. - is_deleted: - type: boolean - description: >- - True when the destination's backing UC - entity (MODEL for foundation-model - destinations, MODEL_PROVIDER_SERVICE for - external destinations) has been deleted - but the destination row still references - it. The dangling destination is surfaced - (not silently dropped) so callers can - see the broken routing. Inference - traffic through this destination fails - closed (BAD_REQUEST / - FAILED_PRECONDITION). - pay_per_token_config: - type: object - properties: - model: - type: string - description: >- - Resource name of the UC model. Format: - ``models/{catalog}.{schema}.{model}``. - required: - - model - description: >- - Configuration for a pay-per-token - foundation-model destination. Identifies - the foundation model - by its UC resource name; the platform resolves it to a Model Serving endpoint at request time. - provisioned_throughput_config: - type: object - properties: - model_serving_endpoint: - type: string - description: >- - Name of the backing Model Serving - endpoint serving the provisioned- - throughput foundation model, as the - AIP-122 typed resource name - ``serving-endpoints/{name}``. The same - UC model can be served on multiple Model - Serving endpoints (different throughput - / region / config); the caller picks - which one this destination routes to. - The endpoint must exist at create time. - model: - type: string - description: >- - UC model FQN of the model served by the - backing endpoint (e.g., - ``system.ai.databricks-claude-opus-4-6``). - Resolved from Model Serving at - Create/Update time. - required: - - model_serving_endpoint - description: >- - Configuration for a - provisioned-throughput foundation-model - destination. References a - pre-existing Model Serving endpoint that serves the model; sizing (provisioned throughput, burst - scaling, model version) is owned by the Model Serving endpoint itself, not by this message. - traffic_percentage: - type: integer - description: >- - Share of traffic sent to this - destination, 0-100. Optional on fallback - destinations; see FallbackConfig. - required: - - name - - destination_type - description: >- - A destination the model service can route - traffic to. Exactly one of the per-type - configs inside - ``type_config`` must be set, and it must match ``destination_type``. - description: >- - Ordered list of fallback destinations. - Traversal is in list order; the attempt - count is the length of the list. At most 5 - are allowed. - description: >- - Fallback routing config, applied after primary - destinations fail. - first_token_timeout: - type: string - description: >- - Timeout for the first token of a streaming - response. If a destination does not return its - first token within this duration, AI Gateway - aborts the attempt and fails over to the next - destination. Applies to streaming requests only. - Leave unset for no first-token timeout. - traffic_splitting: - type: object - properties: {} - description: >- - Marker message selecting request-based traffic - splitting. Traffic is distributed according to - each destination's traffic_percentage value; no - configuration lives on this message itself. + Fallback destinations, tried in the listed + order. At most 5 are allowed. description: >- - Routing configuration: destinations, routing - strategy, and fallback. - description: >- - Operational configuration: destinations, routing, rate - limits, inference table. Required on CreateModelService; - on UpdateModelService it is required only when - ``config`` (or a ``config.*`` subpath) appears in - ``update_mask``. - create_time: - type: string - format: date-time - description: When the model service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: >- - The resolved owner of the ModelService. Falls back to - the caller's identity when ``owner`` is not explicitly - set on creation. - etag: - type: string - description: >- - Optimistic concurrency control token. Server-generated - from the entity's state and returned on every read. To - use it as an if-match precondition on a mutation, echo - the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects - the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the model service. - name: - type: string - description: >- - Resource name of the model service. Format: - ``model-services/{catalog}.{schema}.{model_service}``. - Each ``{...}`` component is capped at 255 characters - individually. Server-derived on Create from ``parent`` + - ``model_service_id``; required and immutable on - Update/Get/Delete. - owner: - type: string - description: >- - The owner of the model service. Write-only; read owner - via effective_owner. - supported_api_types: - type: array - items: - type: string - description: >- - Unified API types this endpoint supports (e.g. "chat", - "embeddings", "completions"). Derived from the - destinations' backing models / providers at read time. - update_time: - type: string - format: date-time - description: When the model service was last modified. - updated_by: - type: string - description: Identity of the last updater. + Fallback routing applied after a primary destination + fails. Fallback destinations are tried in the listed + order. + description: 'Routing configuration: destinations and fallback.' description: >- - The model service to create. The server populates ``name`` - from ``parent`` + ``model_service_id``; clients should leave - it unset. - required: - - model_service + Destinations, routing, rate limits, and payload logging + configuration. Required on Create. On Update, provide this + field when ``update_mask`` contains ``config`` or one of its + subpaths. + create_time: + type: string + format: date-time + description: Time the model service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the model service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the model service. + name: + type: string + description: >- + Resource name of the model service. Format: + ``model-services/{catalog}.{schema}.{model_service}``. Each + ``{...}`` component is capped at 255 characters + individually. Server-derived on Create from ``parent`` + + ``model_service_id``; required and immutable on + Update/Get/Delete. + supported_api_types: + type: array + items: + type: string + description: >- + API types supported across this service's destinations, such + as ``openai/v1/chat/completions``, ``openai/v1/embeddings``, + and ``mlflow/v1/chat/completions``. Derived from the backing + models and providers at read time. + update_time: + type: string + format: date-time + description: Time the model service was last modified. + updated_by: + type: string + description: Identity of the last updater. responses: '200': description: Success @@ -2498,62 +2371,58 @@ paths: services the caller can access (as owner or through ``EXECUTE``, ``READ_METADATA``, or ``MANAGE``) are - returned. + returned by default. - :param include_browse: bool (optional) - Whether to include model services for which the principal can only access selective metadata. :param page_size: int (optional) - Maximum number of model services to return. Defaults to 100 when unset or 0; the maximum is 1000. - Use ``next_page_token`` to retrieve additional pages. + Maximum number of model services to return. Defaults to 200 when unset or 0; the maximum is 1000 for + ``view = BASIC`` and 200 for ``view = FULL``. Use ``page_token`` to retrieve additional pages. :param page_token: str (optional) - Opaque pagination token from a previous request. + Opaque pagination token from the previous response. :param parent: str (optional) - Resource name of the parent schema to list within, as ``schemas/{catalog}.{schema}``. Each ``{...}`` + Parent schema to list within, in the form ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component is capped at 255 characters individually. :param view: :class:`ListModelServicesRequestView` (optional) - View selector controlling which fields are populated per row. + Fields to return for each service. ``FULL`` includes destinations, inference-table details, and + rate-limit principal names. ``BASIC`` omits destinations and inference-table details and omits + principal names from rate limits. Defaults to ``BASIC`` when unset. :returns: Iterator over :class:`ModelService` parameters: - - name: include_browse - in: query - required: false - schema: - type: boolean - description: >- - Whether to include model services for which the principal can only - access selective metadata. - name: page_size in: query required: false schema: type: integer description: >- - Maximum number of model services to return. Defaults to 100 when - unset or 0; the maximum is 1000. Use ``next_page_token`` to retrieve - additional pages. + Maximum number of model services to return. Defaults to 200 when + unset or 0; the maximum is 1000 for ``view = BASIC`` and 200 for + ``view = FULL``. Use ``page_token`` to retrieve additional pages. - name: page_token in: query required: false schema: type: string - description: Opaque pagination token from a previous request. + description: Opaque pagination token from the previous response. - name: parent in: query required: false schema: type: string description: >- - Resource name of the parent schema to list within, as - ``schemas/{catalog}.{schema}``. Each ``{...}`` component is capped - at 255 characters individually. + Parent schema to list within, in the form + ``schemas/{catalog}.{schema}``. Required. Each ``{...}`` component + is capped at 255 characters individually. - name: view in: query required: false schema: $ref: '#/components/schemas/ListModelServicesRequestView' - description: View selector controlling which fields are populated per row. + description: >- + Fields to return for each service. ``FULL`` includes destinations, + inference-table details, and rate-limit principal names. ``BASIC`` + omits destinations and inference-table details and omits principal + names from rate limits. Defaults to ``BASIC`` when unset. responses: '200': description: Success @@ -2573,56 +2442,150 @@ paths: message: type: string x-stackql-sdk-source: AiGatewayAPI - /api/2.1/unity-catalog/{name}: - delete: - operationId: ai_gateway_delete_model_service + /api/2.1/unity-catalog/skills: + post: + operationId: ai_gateway_create_skill summary: >- - Deletes the model service identified by its resource name. Optionally - supply an ``etag`` to make the + Creates a skill in a Unity Catalog schema and provisions its managed + bundle storage. Specify its name tags: - catalog - ai_gateway description: >- - Deletes the model service identified by its resource name. Optionally - supply an ``etag`` to make the + Creates a skill in a Unity Catalog schema and provisions its managed + bundle storage. Specify its name - delete conditional on the model service not having changed since it was - read. + in ``skill_id``. The request contains an optional comment but no bundle + bytes. - You must be the owner of the model service or have ``MANAGE`` on it, - plus ``USE_CATALOG`` on the + To publish a skill: - parent catalog and ``USE_SCHEMA`` on the parent schema. + 1. Call CreateSkill to create the skill in Unity Catalog. - :param name: str - Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. - Each ``{...}`` component is capped at 255 characters individually. - :param etag: str (optional) - If-match precondition: when set, the delete proceeds only if the current server-side etag matches. - Empty means unconditional delete. + 2. Upload every bundle file, including ``SKILL.md`` at the bundle root, + with the Files API: ``PUT + /api/2.0/fs/files/Skills/{catalog}/{schema}/{skill}/{file_path}``. The CreateSkill caller owns the + skill and can upload. Other callers need ``READ_VOLUME`` and ``WRITE_VOLUME`` on the skill. + 3. Call FinalizeSkill to validate ``SKILL.md`` and set the skill's + ``bundle_name`` and ``description`` + from its frontmatter ``name`` and ``description``. + + You must be the owner of the parent schema or have ``CREATE_VOLUME`` and + ``USE_SCHEMA`` on it, plus + + ``USE_CATALOG`` on the parent catalog. + + + :param skill: :class:`Skill` + The skill to create. ``comment`` is the only accepted client input and may be omitted. Do not set + ``name``; the server derives it from ``parent`` and ``skill_id``. + :param parent: str + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component is + capped at 255 characters individually. + :param skill_id: str + Name for the skill, e.g. "basic-math". The server normalizes this identifier to lowercase. It is + independent of the bundle name read from SKILL.md. + + :returns: :class:`Skill` parameters: - - name: name - in: path + - name: parent + in: query required: true schema: type: string description: >- - Resource name of the model service. Format: - ``model-services/{catalog}.{schema}.{model_service}``. Each - ``{...}`` component is capped at 255 characters individually. - - name: etag + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. + Each ``{...}`` component is capped at 255 characters individually. + - name: skill_id in: query - required: false + required: true schema: type: string description: >- - If-match precondition: when set, the delete proceeds only if the - current server-side etag matches. Empty means unconditional delete. + Name for the skill, e.g. "basic-math". The server normalizes this + identifier to lowercase. It is independent of the bundle name read + from SKILL.md. + requestBody: + content: + application/json: + schema: + type: object + properties: + bundle_name: + type: string + description: >- + Name from the most recently successfully finalized SKILL.md. + It may differ from the final component of the Skill resource + name. Unset until FinalizeSkill succeeds. + comment: + type: string + description: >- + User-provided comment for the skill. Free-text, + user-editable via UpdateSkill (listed in its + ``update_mask``). DISTINCT from ``description``, which is + the server-parsed, OUTPUT_ONLY SKILL.md frontmatter value: + ``comment`` is the customer's own annotation and is + preserved across bundle re-uploads. When ``comment`` is in + the update mask, omitting it clears the field, while an + explicitly empty string is retained. + create_time: + type: string + format: date-time + description: Time the skill was created. + created_by: + type: string + description: Creator identity. + description: + type: string + description: >- + Description from the most recently successfully finalized + SKILL.md. Unset until FinalizeSkill succeeds. + effective_owner: + type: string + description: Owner of the skill. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + finalize_time: + type: string + format: date-time + description: >- + Time of the most recent successful FinalizeSkill. Unset + until one succeeds. + metastore_id: + type: string + description: Metastore hosting the skill. + name: + type: string + description: >- + Resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` + component is capped at 255 characters individually. + Server-derived on Create from ``parent`` + ``skill_id``; + required and immutable on Update/Get/Delete. + update_time: + type: string + format: date-time + description: >- + Time of the most recent Skill metadata mutation. Uploading + bundle files alone does not change this value. + updated_by: + type: string + description: Identity of the last updater. responses: '200': description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Skill' default: description: Error response content: @@ -2636,54 +2599,195 @@ paths: type: string x-stackql-sdk-source: AiGatewayAPI get: - operationId: ai_gateway_get_model_service - summary: Returns the model service identified by its resource name. + operationId: ai_gateway_list_skills + summary: >- + Lists skills in a Unity Catalog schema. Provide ``parent`` as + ``schemas/{catalog}.{schema}``. Results tags: - catalog - ai_gateway description: >- - Returns the model service identified by its resource name. + Lists skills in a Unity Catalog schema. Provide ``parent`` as + ``schemas/{catalog}.{schema}``. Results + are paginated; pass the returned ``next_page_token`` to fetch subsequent + pages. - You must be the owner of the model service or have ``EXECUTE``, - ``READ_METADATA``, or ``MANAGE`` on - it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the - parent schema. + Requires ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the + parent schema. Only skills + the caller can access as owner or through ``READ_VOLUME``, + ``READ_METADATA``, or ``MANAGE`` are - :param name: str - Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. - Each ``{...}`` component is capped at 255 characters individually. - :param include_browse: bool (optional) - Whether to include model services for which the principal can only access selective metadata. + returned. - :returns: :class:`ModelService` + + :param parent: str + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. Each ``{...}`` component is + capped at 255 characters individually. + + Required: skill listing is schema-scoped, so ``parent`` must be set; an unset or empty ``parent`` is + rejected with INVALID_PARAMETER_VALUE. + :param page_size: int (optional) + Maximum number of skills to return. Defaults to 200 when unset or 0; the maximum is 200. Use + ``page_token`` to retrieve additional pages. + :param page_token: str (optional) + Opaque pagination token from a previous request. + + :returns: Iterator over :class:`Skill` parameters: - - name: name - in: path + - name: parent + in: query required: true schema: type: string description: >- - Resource name of the model service. Format: - ``model-services/{catalog}.{schema}.{model_service}``. Each - ``{...}`` component is capped at 255 characters individually. - - name: include_browse + Name of the parent schema. Format: ``schemas/{catalog}.{schema}``. + Each ``{...}`` component is capped at 255 characters individually. + Required: skill listing is schema-scoped, so ``parent`` must be set; + an unset or empty ``parent`` is rejected with + INVALID_PARAMETER_VALUE. + - name: page_size in: query required: false schema: - type: boolean + type: integer description: >- - Whether to include model services for which the principal can only - access selective metadata. - responses: - '200': - description: Success + Maximum number of skills to return. Defaults to 200 when unset or 0; + the maximum is 200. Use ``page_token`` to retrieve additional pages. + - name: page_token + in: query + required: false + schema: + type: string + description: Opaque pagination token from a previous request. + responses: + '200': + description: Success content: application/json: schema: - $ref: '#/components/schemas/ModelService' + $ref: '#/components/schemas/ListSkillsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + /api/2.1/unity-catalog/mcp-services/{full_name}: + delete: + operationId: ai_gateway_delete_mcp_service + summary: >- + Deletes the MCP service identified by its resource name. Optionally + supply an ``etag`` to make the + tags: + - catalog + - ai_gateway + description: >- + Deletes the MCP service identified by its resource name. Optionally + supply an ``etag`` to make the + + delete conditional on the MCP service not having changed since it was + read. + + + You must be the owner of the MCP service or have ``MANAGE`` on it, plus + ``USE_CATALOG`` on the parent + + catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the MCP service. Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. Each + ``{...}`` component is capped at 255 characters individually. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the delete succeeds only if the + resource has not changed. Leave unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`mcp-services/{full_name}`). Resource name of the MCP service. + Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. Each + ``{...}`` component is capped at 255 characters individually. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the delete succeeds only if the resource has not changed. Leave + unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + get: + operationId: ai_gateway_get_mcp_service + summary: Returns the MCP service identified by its resource name. + tags: + - catalog + - ai_gateway + description: >- + Returns the MCP service identified by its resource name. + + + You must be the owner of the MCP service or have ``EXECUTE``, + ``READ_METADATA``, or ``MANAGE`` on it, + + plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the + parent schema. + + + :param name: str + Resource name of the MCP service. Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. Each + ``{...}`` component is capped at 255 characters individually. + + :returns: :class:`McpService` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`mcp-services/{full_name}`). Resource name of the MCP service. + Format: ``mcp-services/{catalog}.{schema}.{mcp_service}``. Each + ``{...}`` component is capped at 255 characters individually. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/McpService' default: description: Error response content: @@ -2697,56 +2801,64 @@ paths: type: string x-stackql-sdk-source: AiGatewayAPI patch: - operationId: ai_gateway_update_model_service + operationId: ai_gateway_update_mcp_service summary: >- - Updates a model service. Only the fields named in ``update_mask`` are + Updates an MCP service. Only the fields named in ``update_mask`` are changed; the resource name is tags: - catalog - ai_gateway description: >- - Updates a model service. Only the fields named in ``update_mask`` are + Updates an MCP service. Only the fields named in ``update_mask`` are changed; the resource name is immutable. Optionally supply an ``etag`` to make the update conditional - on the model service not + on the MCP service not having - having changed since it was read. + changed since it was read. - You must be the owner of the model service or have ``MANAGE`` on it, - plus ``USE_CATALOG`` on the + You must be the owner of the MCP service or have ``MANAGE`` on it, plus + ``USE_CATALOG`` on the parent - parent catalog and ``USE_SCHEMA`` on the parent schema. + catalog and ``USE_SCHEMA`` on the parent schema. When changing + ``config.source_connection.name``, the + + MCP service owner must also have ``USE_CONNECTION`` on the new + connection. :param name: str - Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. - Each ``{...}`` component is capped at 255 characters individually. Server-derived on Create from - ``parent`` + ``model_service_id``; required and immutable on Update/Get/Delete. - :param model_service: :class:`ModelService` - The model service with the updated field values. ``name`` identifies the resource - (``model-services/{catalog}.{schema}.{model_service}``); only fields listed in ``update_mask`` are + 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. + :param mcp_service: :class:`McpService` + The MCP service with the updated field values. ``name`` identifies the resource + (``mcp-services/{catalog}.{schema}.{mcp_service}``); only fields listed in ``update_mask`` are applied. :param update_mask: FieldMask - The list of fields to update. The framework validates each path against the ``model_service`` field - above. Wildcard paths (``paths: ["*"]``) are not supported; list each field path explicitly. + 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: ``comment``, ``config.source_connection.name``, + ``config.include_tool_selectors``, or ``config.rate_limits``. :param etag: str (optional) - If-match precondition: when set, the update proceeds only if the current server-side etag matches. - Empty means an unconditional update. + Optimistic concurrency token from the most recent read. When set, the update succeeds only if the + resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. - :returns: :class:`ModelService` + :returns: :class:`McpService` parameters: - - name: name + - name: full_name in: path required: true schema: type: string description: >- - Resource name of the model service. Format: - ``model-services/{catalog}.{schema}.{model_service}``. Each + The `full_name` segment of the `name` resource name + (`mcp-services/{full_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`` + ``model_service_id``; + Server-derived on Create from ``parent`` + ``mcp_service_id``; required and immutable on Update/Get/Delete. - name: update_mask in: query @@ -2754,591 +2866,2599 @@ paths: schema: type: object description: >- - The list of fields to update. The framework validates each path - against the ``model_service`` field above. Wildcard paths (``paths: - ["*"]``) are not supported; list each field path explicitly. + 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: ``comment``, + ``config.source_connection.name``, + ``config.include_tool_selectors``, or ``config.rate_limits``. - name: etag in: query required: false schema: type: string description: >- - If-match precondition: when set, the update proceeds only if the - current server-side etag matches. Empty means an unconditional - update. + Optimistic concurrency token from the most recent read. When set, + the update succeeds only if the resource has not changed. Leave + unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. requestBody: content: application/json: schema: type: object properties: - model_service: + comment: + type: string + description: User-provided description. + config: type: object properties: - browse_only: - type: boolean + include_tool_selectors: + type: array + items: + type: string description: >- - Whether the caller sees only metadata available through - the BROWSE privilege. - comment: - type: string - description: User-provided description. - config: + Tool names or prefix patterns to expose from the MCP + server. Use exact tool names or prefix patterns such as + ``read_*``. An empty list exposes all tools. At most + 1,024 selectors are allowed, and each selector can + contain at most 256 characters. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. + description: >- + Rate limits for tool invocations. Supported scopes are + user, group, service principal, the service as a whole, + and each user by default. Request and token limits are + supported. Empty when no rate limit is configured. + source_connection: type: object properties: - inference_table: - type: object - properties: - parent: - type: string - description: >- - Parent UC schema where the inference table is - created. Format: ``schemas/{catalog}.{schema}``. - Set at create time and immutable thereafter; - changing it on an existing service is rejected. - disabled: - type: boolean - description: >- - Indicates whether payload logging is disabled - (opt-out). Unset means that payload logging is - active (the on-by-default state coincides with - the proto zero-value, so the server never fills - this field for a client that leaves it unset). - Set ``disabled = true`` to pause runtime logging - while keeping the sub-message attached - (preserving ``parent`` and ``table_name_prefix`` - for a later flip back to active). ``parent`` - remains required either way. - is_deleted: - type: boolean - description: >- - True when the bound inference TABLE has been - deleted but the parent service still references - it. The dangling reference is surfaced (not - silently dropped) so callers can see the broken - dependency. AI Gateway payload logging fails - closed in this state. - table: - type: string - description: >- - Resolved UC table for payload logs. Format: - ``tables/{catalog}.{schema}.{table}``. - table_name_prefix: - type: string - description: >- - Prefix for the inference-table's UC-registered - name. The actual leaf name UC stores is - ``_payload``; the - ``_payload`` suffix is appended automatically. - To find the actual UC table after Create, read - the ``table`` field on the response. Defaults to - ``_payload`` when unset. Set - at create time and immutable thereafter; - changing it on an existing service is rejected. - required: - - parent - description: Inference table config for payload logging. - rate_limits: - type: array - items: - type: object - properties: - key: - type: string - x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - - RATE_LIMIT_KEY_SERVICE - - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - - RATE_LIMIT_KEY_USER - - RATE_LIMIT_KEY_USER_DEFAULT - - RATE_LIMIT_KEY_USER_GROUP - description: >- - Scope key. Determines whether ``principal`` is - required. - renewal_period: - type: string - x-enum: - - RATE_LIMIT_RENEWAL_PERIOD_HOUR - - RATE_LIMIT_RENEWAL_PERIOD_MINUTE - description: Renewal period. - principal: - type: string - description: >- - Principal this limit applies to: user email, - group name, or service principal application - ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, - ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not - set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. - Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden - otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only - valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to - apply the limit to every value of - ``request_tag_key`` (an any-value default); a - set value is a specific override for that - value. - requests: - type: integer - description: >- - Max requests allowed within a renewal period. - Leave unset for no request limit. - tokens: - type: integer - description: >- - Max tokens allowed within a renewal period. - Leave unset for no token limit. - required: - - key - - renewal_period - description: >- - A rate limit applied to service requests. Leave - ``requests`` or ``tokens`` unset to impose no - limit on that dimension; set a value to cap that dimension within the renewal period. + name: + type: string description: >- - Rate limits applied to requests routed through this - model service. - routing: + Resource name of the Unity Catalog connection used + to access the MCP server, in the form + ``connections/{catalog}.{schema}.{connection}``. + is_deleted: + type: boolean + description: >- + Whether the referenced connection has been deleted. + The MCP service keeps the reference so callers can + identify the broken dependency; tool invocation + fails until the source connection is updated. + options: type: object - properties: - destinations: - type: array - items: - type: object - properties: - name: - type: string - description: >- - User-facing label for this destination, - used in routing references. - destination_type: - type: string - x-enum: - - >- - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL - description: >- - Backing-model category. Determines which - oneof variant is populated. - external_model_config: - type: object - properties: - model_provider_service: - type: string - description: >- - Resource name of the governed - ModelProviderService that owns provider - auth and provider-specific - configuration. The referenced - ModelProviderService also carries the - provider type, so this message does not - surface it directly. Format: - ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. - Each ``{...}`` component is capped at - 255 characters individually. - target: - type: object - properties: - model: - type: string - description: >- - Provider-side model identifier (e.g. - "gpt-5", "claude-opus-4-7"). This is a - string on the LLM provider's side, not a - UC entity. The UC governance hook for - external destinations is the - ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, - not the model itself. - native_api_types: - type: array - items: - type: string - description: >- - Provider-native API types the model - supports (e.g. - "openai/v1/chat/completions"). Used by - the platform for request/response - translation from the unified API type. - At most 64 entries of at most 256 - characters each; the list is persisted - into the destination binding's bounded - storage envelope. - required: - - model - description: >- - Routing target for the destination: the - provider-side model selected from the - referenced ModelProviderService's - ``targets`` catalog, plus the unified - API types the platform should translate - to/from at request time. - required: - - model_provider_service - - target - description: >- - Configuration for an - external-foundation-model destination. - Provider auth and provider-specific - cloud configuration are owned by a separate, governed ModelProviderService entity referenced via - ``model_provider_service``; the platform resolves the provider at invocation time. - is_deleted: - type: boolean - description: >- - True when the destination's backing UC - entity (MODEL for foundation-model - destinations, MODEL_PROVIDER_SERVICE for - external destinations) has been deleted - but the destination row still references - it. The dangling destination is surfaced - (not silently dropped) so callers can see - the broken routing. Inference traffic - through this destination fails closed - (BAD_REQUEST / FAILED_PRECONDITION). - pay_per_token_config: - type: object - properties: - model: - type: string - description: >- - Resource name of the UC model. Format: - ``models/{catalog}.{schema}.{model}``. - required: - - model - description: >- - Configuration for a pay-per-token - foundation-model destination. Identifies - the foundation model - by its UC resource name; the platform resolves it to a Model Serving endpoint at request time. - provisioned_throughput_config: - type: object - properties: - model_serving_endpoint: + description: >- + Options needed to build the U2M authorize request, + returned as a flat map. When set, it includes: + ``authorization_endpoint`` (OAuth authorize URL), + ``token_endpoint`` (token-exchange URL), + ``oauth_scope`` (space-separated scopes to request), + ``client_id`` (OAuth client id), and + ``oauth_provider`` (the OAuth provider). + required: + - name + description: >- + Unity Catalog connection referencing the MCP server. + Required on Create. + description: >- + Connection, tool selectors, and rate limits. Required on + Create. On Update, provide this field when ``update_mask`` + contains ``config`` or one of its subpaths. + create_time: + type: string + format: date-time + description: Time the MCP service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the MCP service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the MCP service. + name: + type: string + description: >- + 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. + update_time: + type: string + format: date-time + description: Time the MCP service was last modified. + updated_by: + type: string + description: Identity of the last updater. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/McpService' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + /api/2.1/unity-catalog/model-provider-services/{full_name}: + delete: + operationId: ai_gateway_delete_model_provider_service + summary: >- + Deletes the model provider service identified by its resource name. + Optionally supply an ``etag`` to + tags: + - catalog + - ai_gateway + description: >- + Deletes the model provider service identified by its resource name. + Optionally supply an ``etag`` to + + make the delete conditional on the model provider service not having + changed since it was read. + + + You must be the owner of the model provider service or have ``MANAGE`` + on it, plus ``USE_CATALOG`` on + + the parent catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the model provider service. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. Each ``{...}`` component is + capped at 255 characters individually. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the delete succeeds only if the + resource has not changed. Leave unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-provider-services/{full_name}`). Resource name of the model + provider service. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. + Each ``{...}`` component is capped at 255 characters individually. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the delete succeeds only if the resource has not changed. Leave + unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + get: + operationId: ai_gateway_get_model_provider_service + summary: Returns the model provider service identified by its resource name. + tags: + - catalog + - ai_gateway + description: >- + Returns the model provider service identified by its resource name. + + + You must be the owner of the model provider service or have ``EXECUTE``, + ``READ_METADATA``, or + + ``MANAGE`` on it, plus ``USE_CATALOG`` on the parent catalog and + ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the model provider service. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. Each ``{...}`` component is + capped at 255 characters individually. + + :returns: :class:`ModelProviderService` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-provider-services/{full_name}`). Resource name of the model + provider service. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. + Each ``{...}`` component is capped at 255 characters individually. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ModelProviderService' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + patch: + operationId: ai_gateway_update_model_provider_service + summary: >- + Updates a model provider service. Only the fields named in + ``update_mask`` are changed; the resource + tags: + - catalog + - ai_gateway + description: >- + Updates a model provider service. Only the fields named in + ``update_mask`` are changed; the resource + + name and provider type are immutable. Optionally supply an ``etag`` to + make the update conditional on + + the model provider service not having changed since it was read. + + + You must be the owner of the model provider service or have ``MANAGE`` + on it, plus ``USE_CATALOG`` on + + the parent catalog and ``USE_SCHEMA`` on the parent schema. + + + Updating ``config.provider`` cannot change the provider type. + Authentication mode changes require + + feature availability and support for both modes on the selected + provider. + + + :param name: str + 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. + :param model_provider_service: :class:`ModelProviderService` + The model provider service with the updated field values. ``name`` identifies the resource + (``model-provider-services/{catalog}.{schema}.{model_provider_service}``); only fields listed in + ``update_mask`` are applied. + :param update_mask: FieldMask + 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: ``comment``; ``config.provider`` to replace the active provider-specific value + (for example, ``config.openai``; the mask path remains ``config.provider``); + ``config.allow_all_targets``, ``config.targets``, ``config.forward_headers``, + ``config.forward_query_parameters``, ``config.forward_unmanaged_paths``, ``config.rate_limits``, + ``config.pricing.default_discount_basis_points``, or ``config.inference_table``. For a pricing + update, an explicitly empty ``pricing`` object clears the discount but retains the object; omitting + ``pricing`` clears it. ``config.pricing`` is not a supported mask path. The provider type is + immutable. A ``config`` or ``config.provider`` replacement that carries no authentication material + preserves the existing authentication binding; input-only plaintext does not need to be read back + and re-sent. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the update succeeds only if the + resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + + :returns: :class:`ModelProviderService` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-provider-services/{full_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. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + 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: ``comment``; ``config.provider`` to + replace the active provider-specific value (for example, + ``config.openai``; the mask path remains ``config.provider``); + ``config.allow_all_targets``, ``config.targets``, + ``config.forward_headers``, ``config.forward_query_parameters``, + ``config.forward_unmanaged_paths``, ``config.rate_limits``, + ``config.pricing.default_discount_basis_points``, or + ``config.inference_table``. For a pricing update, an explicitly + empty ``pricing`` object clears the discount but retains the object; + omitting ``pricing`` clears it. ``config.pricing`` is not a + supported mask path. The provider type is immutable. A ``config`` or + ``config.provider`` replacement that carries no authentication + material preserves the existing authentication binding; input-only + plaintext does not need to be read back and re-sent. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the update succeeds only if the resource has not changed. Leave + unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + requestBody: + content: + application/json: + schema: + type: object + properties: + comment: + type: string + description: User-provided description. + config: + type: object + properties: + allow_all_targets: + type: boolean + description: >- + When true, allows models from the provider's built-in + model catalog in addition to explicit ``targets``. When + false, only models listed in ``targets`` are routable. + Defaults to false. CUSTOM providers have no built-in + model catalog and must leave this false and list their + models in ``targets``. + amazon_bedrock: + type: object + properties: + direct: + type: object + properties: + aws_access_key: + type: object + properties: + access_key_id: + type: string + description: >- + AWS access key ID. Required on Create when + using access-key auth. Treated as + username-equivalent (not a secret value): + round-trips on reads and is scrubbed from + audit logs. + secret_access_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + AWS secret access key paired with + ``access_key_id``. Required when creating a + service with access-key authentication. + Supply the value in + ``secret_access_key.plaintext``. + description: >- + AWS access-key-pair authentication. Set + ``access_key_id`` and + ``secret_access_key.plaintext``. Mutually + exclusive with ``service_credential``. + region: + type: string + description: >- + AWS region where the Bedrock endpoint is hosted + (e.g., ``us-east-1``). Required on Create. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Bedrock requests. On Create, supply + ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``aws_access_key``. The + credential is referenced by name; its value is + not carried here. Only supported on AWS-hosted + workspaces. + description: >- + Amazon Bedrock region and authentication + configuration. + description: Amazon Bedrock provider configuration. + anthropic: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Anthropic API key. Required when creating the + service. Supply the value in + ``api_key.plaintext``. + description: >- + Direct authentication with an API key supplied in + ``direct.api_key.plaintext``. Required unless + ``relayed`` is set. + relayed: + type: object + properties: {} + description: >- + Relayed authentication. Each inference request + supplies the caller's OAuth token, which is + forwarded to Anthropic. No Anthropic credential is + stored. Mutually exclusive with ``direct``. + description: >- + Anthropic provider configuration. Exactly one of + ``direct`` or ``relayed`` must be set on + Create; the two are mutually exclusive. + azure_openai: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Azure OpenAI API key. Supply the value in + ``api_key.plaintext``. Mutually exclusive with + Entra ID and Unity Catalog service credential + authentication. + base_url: + type: string + description: >- + Full Azure OpenAI endpoint base URL, e.g. + ``https://myresource.openai.azure.com``. + Required on Create. + entra_service_principal: + type: object + properties: + client_id: + type: string + description: >- + Entra ID client (application) ID. Required + on Create. + client_secret: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Entra ID client secret. Supply the value in + ``client_secret.plaintext``. + tenant_id: + type: string + description: >- + Entra ID (Azure AD) tenant ID. Required on + Create. + description: >- + Entra ID service-principal authentication. Set + ``tenant_id``, ``client_id``, and + ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Azure OpenAI requests. On Create, + supply ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``api_key`` and + ``entra_service_principal``. The credential is + referenced by name; its value is not carried + here. Only supported on Azure-hosted workspaces. + description: >- + Azure OpenAI endpoint and authentication + configuration. + description: Azure OpenAI provider configuration. + bedrock_mantle: + type: object + properties: + direct: + type: object + properties: + aws_access_key: + type: object + properties: + access_key_id: + type: string + description: >- + AWS access key ID. Required on Create when + using access-key auth. Treated as + username-equivalent (not a secret value): + round-trips on reads and is scrubbed from + audit logs. + secret_access_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + AWS secret access key paired with + ``access_key_id``. Required when creating a + service with access-key authentication. + Supply the value in + ``secret_access_key.plaintext``. + description: >- + AWS access-key-pair authentication. Set + ``access_key_id`` and + ``secret_access_key.plaintext``. Mutually + exclusive with ``service_credential``. + region: + type: string + description: >- + AWS region where the Bedrock endpoint is hosted + (e.g., ``us-east-1``). Required on Create. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Bedrock requests. On Create, supply + ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when + using service-credential authentication; + mutually exclusive with ``aws_access_key``. The + credential is referenced by name; its value is + not carried here. Only supported on AWS-hosted + workspaces. + description: >- + Amazon Bedrock region and authentication + configuration. + description: Amazon Bedrock provider configuration. + custom: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Bearer token forwarded in the ``Authorization`` + header. Supply the value in + ``api_key.plaintext``. + base_url: + type: string + description: >- + Endpoint URL of the OpenAI-compatible service + (e.g., ``https://api.example.com/v1``). Required + on Create. + header_auth: + type: object + properties: + api_key_name: + type: string + description: >- + HTTP header name that carries the API key on + outbound requests (e.g., + ``Ocp-Apim-Subscription-Key``). The value + forwarded under this header is supplied via + ``api_key_value``. + api_key_value: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Secret value forwarded under the + ``api_key_name`` header on outbound + requests. Supplied as inline plaintext via + ``ProviderSecret.plaintext``. + description: >- + Header-based API-key auth: the secret is + forwarded on outbound requests under a + caller-chosen HTTP header rather than as an + ``Authorization`` bearer token. Set this instead + of ``api_key`` for header auth. + description: >- + Endpoint and authentication configuration for the + custom provider. + description: Custom OpenAI-compatible provider configuration. + forward_headers: + type: boolean + description: >- + Whether to forward incoming HTTP headers to the upstream + provider. Defaults to false and is configured for the + entire provider service, not per request. Upstream + authentication is configured separately in the + provider-specific configuration. + forward_query_parameters: + type: boolean + description: >- + Whether to forward incoming query parameters to the + upstream provider. Defaults to false and is configured + for the entire provider service, not per request. + forward_unmanaged_paths: + type: boolean + description: >- + Whether to proxy paths that AI Gateway does not + recognize as configured provider-native API types. + Defaults to false. When true, these paths are forwarded + unchanged to the upstream provider. When false, only + recognized API paths are served. Enabling this broadens + the upstream API surface exposed through the provider + service. AI Gateway cannot evaluate Service Policies on + opaque unmanaged requests, so unmanaged requests are + rejected whenever Service Policies are attached to this + securable. + gemini_enterprise: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Google Gemini Enterprise API key. Required when + creating the service. Supply the value in + ``api_key.plaintext``. + project_id: + type: string + description: >- + GCP project ID hosting the Gemini Enterprise + endpoint. Required on Create. + region: + type: string + description: >- + GCP region of the Gemini Enterprise endpoint + (e.g., ``us-central1``). Required on Create. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Gemini Enterprise requests. On + Create, supply ``service_credential.name`` as + ``credentials/{name}``; required when using + service-credential authentication and mutually + exclusive with ``api_key``. The credential is + referenced by name; its value is not carried + here. On read, the resolved ``id`` and + ``is_deleted`` are also populated. Supported + only on GCP-hosted workspaces. + description: >- + Gemini Enterprise project, region, and + authentication configuration. + description: Gemini Enterprise provider configuration. + inference_table: + type: object + properties: + parent: + type: string + description: >- + Parent Unity Catalog schema where the inference + table is created, in the form + ``schemas/{catalog}.{schema}``. Required when + configuring an inference table. After the inference + table is created, this field cannot be changed. + is_deleted: + type: boolean + description: >- + Whether the referenced inference table has been + deleted. The configuration remains visible so you + can identify the broken dependency. Payload logging + cannot continue until the table is restored or the + configuration is updated. + table: + type: string + description: >- + Resolved UC table for payload logs. Format: + ``tables/{catalog}.{schema}.{table}``. + table_name_prefix: + type: string + description: >- + Prefix used to form the inference table's registered + name. AI Gateway appends ``_payload``; for example, + ``table_name_prefix = "orders"`` creates + ``orders_payload``. If unset, the prefix defaults to + the service name. Read ``table`` from the response + for the resulting resource name. After the inference + table is created, this field cannot be changed. + required: + - parent + description: >- + Payload logging configuration for requests sent directly + to this provider service. Requests routed through a + model service are captured by that model service's + inference table instead. + microsoft_foundry: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Microsoft Foundry API key. Supply the value in + ``api_key.plaintext``. Mutually exclusive with + Entra ID and Unity Catalog service credential + authentication. + base_url: + type: string + description: >- + Microsoft Foundry endpoint URL. Required on + Create. + entra_service_principal: + type: object + properties: + client_id: + type: string + description: >- + Entra ID client (application) ID. Required + on Create. + client_secret: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret + that carries this secret value. The + value is read at invoke time under the + model provider service owner's access + and is never copied onto the model + provider service, so rotating the UC + Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + Entra ID client secret. Supply the value in + ``client_secret.plaintext``. + tenant_id: + type: string + description: >- + Entra ID (Azure AD) tenant ID. Required on + Create. + description: >- + Entra ID service-principal authentication. Set + ``tenant_id``, ``client_id``, and + ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. + service_credential: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound Unity Catalog + service credential, in the form + ``credentials/{name}``. Supply this field + when creating the service or rebinding its + credential. On read, it reflects the + credential's current name. + required: + - name + description: >- + Reference to a Unity Catalog service credential + authorizing Microsoft Foundry requests. On + Create, supply ``service_credential.name`` in + the form ``credentials/{name}``. Required on + Create when using service-credential + authentication; mutually exclusive with + ``api_key`` and ``entra_service_principal``. The + credential is referenced by name; its value is + not carried here. Only supported on Azure-hosted + workspaces. + description: >- + Microsoft Foundry endpoint and authentication + configuration. + description: Microsoft Foundry provider configuration. + openai: + type: object + properties: + direct: + type: object + properties: + api_key: + type: object + properties: + plaintext: + type: string + description: >- + 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. + secret_reference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in + the form + ``secrets/{catalog}.{schema}.{secret}``. + On Create the caller supplies the name + here. On read it reflects the secret's + current name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret that + carries this secret value. The value is read + at invoke time under the model provider + service owner's access and is never copied + onto the model provider service, so rotating + the UC Secret takes effect with no change to + the model provider service. On Create, + supply ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. + description: >- + OpenAI API key. Required when creating the + service. Supply the value in + ``api_key.plaintext``. + base_url: + type: string + description: >- + Optional custom base URL. Defaults to + ``https://api.openai.com/v1``. Use for + OpenAI-API-compatible third-party endpoints or + in-network proxies. + organization: + type: string + description: >- + Optional OpenAI organization ID. When set, the + platform forwards it as the + ``OpenAI-Organization`` header. + description: >- + OpenAI configuration with an API key supplied in the + request. + description: OpenAI provider configuration. + pricing: + type: object + properties: + default_discount_basis_points: + type: integer + description: >- + Provider-wide adjustment to external-model spend + estimates in basis points: 2000 = 20% off; -2000 = a + 20% markup. Negative values have no lower bound + beyond the int32 range. Values cannot exceed 10000 + (100% off). An omitted value or zero leaves the + estimate unchanged. + description: >- + Pricing configuration for this provider service. An + explicitly empty configuration is retained on Create and + Update and applies no adjustment. + provider_type: + type: string + x-enum: + - EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK + - EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC + - EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI + - EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE + - EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM + - EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE + - EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY + - EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI + description: >- + External model provider. Required on Create and + immutable thereafter. Set the matching provider-specific + configuration, such as ``openai``, ``azure_openai``, or + ``amazon_bedrock``. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. + description: >- + Rate limits for requests sent directly to this provider + service. Requests routed through a model service use + that model service's rate limits instead. + targets: + type: array + items: + type: object + properties: + model: + type: string + description: >- + Provider-side model identifier, such as ``gpt-5`` + or ``claude-opus-4-7``. This identifies a model at + the upstream provider; it is not a Unity Catalog + model resource. + endpoint_route: + type: string + description: >- + Relative path appended to a custom provider's + ``base_url`` for this model, such as + ``serve/openai/chat``. Nonempty values are only + supported for custom model provider service + targets; other provider types reject them. Model + service destinations do not support this field. Do + not include URI templates, queries, or fragments. + When empty, ``base_url`` is used unchanged. + native_api_types: + type: array + items: + type: string + description: >- + Provider-native API types supported by this model, + such as ``openai/v1/chat/completions``. A model + provider service target requires at least one + value. A model service destination may omit the + list to use the matching provider service target's + types when available. AI Gateway uses the selected + types for translation. At most 64 entries of 256 + characters each are allowed. + required: + - model + description: >- + Model target configuration shared by model provider + service targets and external model + destinations on model services. + description: >- + Models and provider-native API types exposed by this + provider service. Each entry must include at least one + ``native_api_types`` value. When ``allow_all_targets`` + is false, at least one entry is required and model + service destinations can reference only listed models. + When ``allow_all_targets`` is true, models from the + provider's built-in model catalog are also routable. + CUSTOM providers must explicitly list their models here + and cannot enable ``allow_all_targets``. + description: >- + Provider authentication, exposed models, request-forwarding + controls, rate limits, and payload logging. Required on + Create. On Update, it is required only when ``config`` or + one of its subpaths appears in ``update_mask``. + create_time: + type: string + format: date-time + description: Time the provider service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the model provider service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the provider service. + name: + type: string + description: >- + 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. + update_time: + type: string + format: date-time + description: Time the provider service was last modified. + updated_by: + type: string + description: Identity of the last updater. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ModelProviderService' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + /api/2.1/unity-catalog/model-services/{full_name}: + delete: + operationId: ai_gateway_delete_model_service + summary: >- + Deletes the model service identified by its resource name. Optionally + supply an ``etag`` to make the + tags: + - catalog + - ai_gateway + description: >- + Deletes the model service identified by its resource name. Optionally + supply an ``etag`` to make the + + delete conditional on the model service not having changed since it was + read. + + + You must be the owner of the model service or have ``MANAGE`` on it, + plus ``USE_CATALOG`` on the + + parent catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. + Each ``{...}`` component is capped at 255 characters individually. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the delete succeeds only if the + resource has not changed. Leave unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-services/{full_name}`). Resource name of the model service. + Format: ``model-services/{catalog}.{schema}.{model_service}``. Each + ``{...}`` component is capped at 255 characters individually. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the delete succeeds only if the resource has not changed. Leave + unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + get: + operationId: ai_gateway_get_model_service + summary: Returns the model service identified by its resource name. + tags: + - catalog + - ai_gateway + description: >- + Returns the model service identified by its resource name. + + + You must be the owner of the model service or have ``EXECUTE``, + ``READ_METADATA``, or ``MANAGE`` on + + it, plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the + parent schema. + + + :param name: str + Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. + Each ``{...}`` component is capped at 255 characters individually. + + :returns: :class:`ModelService` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-services/{full_name}`). Resource name of the model service. + Format: ``model-services/{catalog}.{schema}.{model_service}``. Each + ``{...}`` component is capped at 255 characters individually. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ModelService' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + patch: + operationId: ai_gateway_update_model_service + summary: >- + Updates a model service. Only the fields named in ``update_mask`` are + changed; the resource name is + tags: + - catalog + - ai_gateway + description: >- + Updates a model service. Only the fields named in ``update_mask`` are + changed; the resource name is + + immutable. Optionally supply an ``etag`` to make the update conditional + on the model service not + + having changed since it was read. + + + You must be the owner of the model service or have ``MANAGE`` on it, + plus ``USE_CATALOG`` on the + + parent catalog and ``USE_SCHEMA`` on the parent schema. When changing + destinations, both you and the + + model service owner need ``USE_CATALOG`` and ``USE_SCHEMA`` on each + destination's parent and + + ``EXECUTE`` on the referenced Unity Catalog model or model provider + service. A provisioned-throughput + + destination additionally requires ``CAN_MANAGE`` for you and + ``CAN_QUERY`` for the model service + + owner. Adding an inference table additionally requires ``CREATE_TABLE``. + + + :param name: str + Resource name of the model service. Format: ``model-services/{catalog}.{schema}.{model_service}``. + Each ``{...}`` component is capped at 255 characters individually. Server-derived on Create from + ``parent`` + ``model_service_id``; required and immutable on Update/Get/Delete. + :param model_service: :class:`ModelService` + The model service with the updated field values. ``name`` identifies the resource + (``model-services/{catalog}.{schema}.{model_service}``); only fields listed in ``update_mask`` are + applied. + :param update_mask: FieldMask + 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: ``comment``, ``config.routing.destinations``, + ``config.routing.fallback.destinations``, ``config.rate_limits``, or ``config.inference_table``. + Intermediate paths such as ``config.routing`` and ``config.routing.fallback`` are not supported. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the update succeeds only if the + resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + + :returns: :class:`ModelService` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`model-services/{full_name}`). Resource name of the model service. + Format: ``model-services/{catalog}.{schema}.{model_service}``. Each + ``{...}`` component is capped at 255 characters individually. + Server-derived on Create from ``parent`` + ``model_service_id``; + required and immutable on Update/Get/Delete. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + 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: ``comment``, + ``config.routing.destinations``, + ``config.routing.fallback.destinations``, ``config.rate_limits``, or + ``config.inference_table``. Intermediate paths such as + ``config.routing`` and ``config.routing.fallback`` are not + supported. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the update succeeds only if the resource has not changed. Leave + unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + requestBody: + content: + application/json: + schema: + type: object + properties: + comment: + type: string + description: User-provided description. + config: + type: object + properties: + inference_table: + type: object + properties: + parent: + type: string + description: >- + Parent Unity Catalog schema where the inference + table is created, in the form + ``schemas/{catalog}.{schema}``. Required when + configuring an inference table. After the inference + table is created, this field cannot be changed. + is_deleted: + type: boolean + description: >- + Whether the referenced inference table has been + deleted. The configuration remains visible so you + can identify the broken dependency. Payload logging + cannot continue until the table is restored or the + configuration is updated. + table: + type: string + description: >- + Resolved UC table for payload logs. Format: + ``tables/{catalog}.{schema}.{table}``. + table_name_prefix: + type: string + description: >- + Prefix used to form the inference table's registered + name. AI Gateway appends ``_payload``; for example, + ``table_name_prefix = "orders"`` creates + ``orders_payload``. If unset, the prefix defaults to + the service name. Read ``table`` from the response + for the resulting resource name. After the inference + table is created, this field cannot be changed. + required: + - parent + description: Inference table configuration for payload logging. + rate_limits: + type: array + items: + type: object + properties: + key: + type: string + x-enum: + - RATE_LIMIT_KEY_SERVICE + - RATE_LIMIT_KEY_SERVICE_PRINCIPAL + - RATE_LIMIT_KEY_USER + - RATE_LIMIT_KEY_USER_DEFAULT + - RATE_LIMIT_KEY_USER_GROUP + description: >- + Scope of the rate limit. Depending on this value, + the limit applies to a principal, the service as a + whole, or each user by default. + renewal_period: + type: string + x-enum: + - RATE_LIMIT_RENEWAL_PERIOD_HOUR + - RATE_LIMIT_RENEWAL_PERIOD_MINUTE + description: Renewal period. + principal: + type: string + description: >- + Principal this limit applies to: user email, group + name, or service principal application ID. + Required when ``key`` applies to a user, group, or + service principal; otherwise it must be unset. + requests: + type: integer + description: >- + Maximum requests allowed in one renewal period. + Leave unset for no request limit. Set to ``0`` to + deny all requests. + tokens: + type: integer + description: >- + Maximum tokens allowed in one renewal period. + Leave unset for no token limit. Set to ``0`` to + deny all requests. + required: + - key + - renewal_period + description: >- + A rate limit applied to service requests. Leave + ``requests`` or ``tokens`` unset to impose no + limit on that dimension; set a value to cap that dimension within the renewal period. + description: >- + Rate limits applied to requests routed through this + model service. + routing: + type: object + properties: + destinations: + type: array + items: + type: object + properties: + name: + type: string + description: >- + User-facing label for this destination, used + in routing references. + destination_type: + type: string + x-enum: + - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL + description: >- + Backing-model category. Provide the matching + type-specific configuration and leave the + other type-specific configurations unset. + external_model_config: + type: object + properties: + model_provider_service: + type: string + description: >- + Resource name of the governed + ModelProviderService that owns provider + auth and provider-specific configuration. + The referenced ModelProviderService also + carries the provider type, so this message + does not surface it directly. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. + Each ``{...}`` component is capped at 255 + characters individually. + target: + type: object + properties: + model: type: string description: >- - Name of the backing Model Serving - endpoint serving the provisioned- - throughput foundation model, as the - AIP-122 typed resource name - ``serving-endpoints/{name}``. The same - UC model can be served on multiple Model - Serving endpoints (different throughput - / region / config); the caller picks - which one this destination routes to. - The endpoint must exist at create time. - model: + Provider-side model identifier, such as + ``gpt-5`` or ``claude-opus-4-7``. This + identifies a model at the upstream + provider; it is not a Unity Catalog + model resource. + endpoint_route: type: string description: >- - UC model FQN of the model served by the - backing endpoint (e.g., - ``system.ai.databricks-claude-opus-4-6``). - Resolved from Model Serving at - Create/Update time. + Relative path appended to a custom + provider's ``base_url`` for this model, + such as ``serve/openai/chat``. Nonempty + values are only supported for custom + model provider service targets; other + provider types reject them. Model + service destinations do not support this + field. Do not include URI templates, + queries, or fragments. When empty, + ``base_url`` is used unchanged. + native_api_types: + type: array + items: + type: string + description: >- + Provider-native API types supported by + this model, such as + ``openai/v1/chat/completions``. A model + provider service target requires at + least one value. A model service + destination may omit the list to use the + matching provider service target's types + when available. AI Gateway uses the + selected types for translation. At most + 64 entries of 256 characters each are + allowed. required: - - model_serving_endpoint + - model description: >- - Configuration for a provisioned-throughput - foundation-model destination. References a - pre-existing Model Serving endpoint that serves the model; sizing (provisioned throughput, burst - scaling, model version) is owned by the Model Serving endpoint itself, not by this message. - traffic_percentage: - type: integer + Routing target for the destination: the + provider-side model selected from the + referenced ModelProviderService's + ``targets`` catalog, plus the unified API + types the platform should translate + to/from at request time. + required: + - model_provider_service + - target + description: >- + Configuration for an external model reached + through a model provider service. + is_deleted: + type: boolean + description: >- + Whether the destination's backing model or + model provider service has been deleted. The + destination remains visible so you can + identify the broken dependency. Requests + cannot use this destination until the backing + resource is restored or the destination is + replaced. + pay_per_token_config: + type: object + properties: + model: + type: string description: >- - Share of traffic sent to this destination, - 0-100. Optional on fallback destinations; - see FallbackConfig. + Resource name of the Unity Catalog model. + Format: + ``models/{catalog}.{schema}.{model}``. required: - - name - - destination_type + - model description: >- - A destination the model service can route - traffic to. Exactly one of the per-type - configs inside - ``type_config`` must be set, and it must match ``destination_type``. - description: >- - Primary routing destinations. At most 10 are - allowed. At least one is required on - CreateModelService; on UpdateModelService it is - required only when ``config.routing`` (or a - ``config.routing.*`` subpath) appears in - ``update_mask``. - fallback: - type: object - properties: - destinations: - type: array - items: + Configuration for a pay-per-token Databricks + foundation model. + provisioned_throughput_config: + type: object + properties: + model_serving_endpoint: + type: string + description: >- + Name of the backing Model Serving endpoint + serving the provisioned- throughput + foundation model, in the form + ``serving-endpoints/{name}``. The same + Unity Catalog model can be served on + multiple Model Serving endpoints with + different throughput, regions, or + configurations. The caller selects the + endpoint to which this destination routes. + The endpoint must exist at create time. + model: + type: string + description: >- + UC model FQN of the model served by the + backing endpoint (e.g., + ``system.ai.databricks-claude-opus-4-6``). + Resolved from Model Serving at + Create/Update time. + required: + - model_serving_endpoint + description: >- + Configuration for a provisioned-throughput + Databricks foundation model. + traffic_percentage: + type: integer + description: >- + Percentage of primary traffic sent to this + destination, from 0 to 100. Required when + there is more than one primary destination, in + which case the primary percentages must sum to + 100; a single primary destination receives all + traffic. Fallback destinations are ordered and + do not use this field. + required: + - name + - destination_type + description: >- + A destination the model service can route traffic + to. Exactly one of the per-type configs inside + ``type_config`` must be set, and it must match ``destination_type``. + description: >- + Primary routing destinations. At most 10 are + allowed. At least one is required on Create. On + Update, provide this list when replacing the full + ``config`` or updating + ``config.routing.destinations``; other granular + routing updates do not require resending + destinations. The intermediate ``config.routing`` + mask path is not supported. + fallback: + type: object + properties: + destinations: + type: array + items: + type: object + properties: + name: + type: string + description: >- + User-facing label for this destination, + used in routing references. + destination_type: + type: string + x-enum: + - >- + DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL + - >- + DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL + description: >- + Backing-model category. Provide the + matching type-specific configuration and + leave the other type-specific + configurations unset. + external_model_config: type: object properties: - name: - type: string - description: >- - User-facing label for this destination, - used in routing references. - destination_type: + model_provider_service: type: string - x-enum: - - >- - DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL - - >- - DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL - description: >- - Backing-model category. Determines which - oneof variant is populated. - external_model_config: - type: object - properties: - model_provider_service: - type: string - description: >- - Resource name of the governed - ModelProviderService that owns provider - auth and provider-specific - configuration. The referenced - ModelProviderService also carries the - provider type, so this message does not - surface it directly. Format: - ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. - Each ``{...}`` component is capped at - 255 characters individually. - target: - type: object - properties: - model: - type: string - description: >- - Provider-side model identifier (e.g. - "gpt-5", "claude-opus-4-7"). This is a - string on the LLM provider's side, not a - UC entity. The UC governance hook for - external destinations is the - ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, - not the model itself. - native_api_types: - type: array - items: - type: string - description: >- - Provider-native API types the model - supports (e.g. - "openai/v1/chat/completions"). Used by - the platform for request/response - translation from the unified API type. - At most 64 entries of at most 256 - characters each; the list is persisted - into the destination binding's bounded - storage envelope. - required: - - model - description: >- - Routing target for the destination: the - provider-side model selected from the - referenced ModelProviderService's - ``targets`` catalog, plus the unified - API types the platform should translate - to/from at request time. - required: - - model_provider_service - - target description: >- - Configuration for an - external-foundation-model destination. - Provider auth and provider-specific - cloud configuration are owned by a separate, governed ModelProviderService entity referenced via - ``model_provider_service``; the platform resolves the provider at invocation time. - is_deleted: - type: boolean - description: >- - True when the destination's backing UC - entity (MODEL for foundation-model - destinations, MODEL_PROVIDER_SERVICE for - external destinations) has been deleted - but the destination row still references - it. The dangling destination is surfaced - (not silently dropped) so callers can - see the broken routing. Inference - traffic through this destination fails - closed (BAD_REQUEST / - FAILED_PRECONDITION). - pay_per_token_config: + Resource name of the governed + ModelProviderService that owns provider + auth and provider-specific + configuration. The referenced + ModelProviderService also carries the + provider type, so this message does not + surface it directly. Format: + ``model-provider-services/{catalog}.{schema}.{model_provider_service}``. + Each ``{...}`` component is capped at + 255 characters individually. + target: type: object properties: model: type: string description: >- - Resource name of the UC model. Format: - ``models/{catalog}.{schema}.{model}``. - required: - - model - description: >- - Configuration for a pay-per-token - foundation-model destination. Identifies - the foundation model - by its UC resource name; the platform resolves it to a Model Serving endpoint at request time. - provisioned_throughput_config: - type: object - properties: - model_serving_endpoint: + Provider-side model identifier, such as + ``gpt-5`` or ``claude-opus-4-7``. This + identifies a model at the upstream + provider; it is not a Unity Catalog + model resource. + endpoint_route: type: string description: >- - Name of the backing Model Serving - endpoint serving the provisioned- - throughput foundation model, as the - AIP-122 typed resource name - ``serving-endpoints/{name}``. The same - UC model can be served on multiple Model - Serving endpoints (different throughput - / region / config); the caller picks - which one this destination routes to. - The endpoint must exist at create time. - model: - type: string + Relative path appended to a custom + provider's ``base_url`` for this model, + such as ``serve/openai/chat``. Nonempty + values are only supported for custom + model provider service targets; other + provider types reject them. Model + service destinations do not support this + field. Do not include URI templates, + queries, or fragments. When empty, + ``base_url`` is used unchanged. + native_api_types: + type: array + items: + type: string description: >- - UC model FQN of the model served by the - backing endpoint (e.g., - ``system.ai.databricks-claude-opus-4-6``). - Resolved from Model Serving at - Create/Update time. + Provider-native API types supported by + this model, such as + ``openai/v1/chat/completions``. A model + provider service target requires at + least one value. A model service + destination may omit the list to use the + matching provider service target's types + when available. AI Gateway uses the + selected types for translation. At most + 64 entries of 256 characters each are + allowed. required: - - model_serving_endpoint + - model + description: >- + Routing target for the destination: the + provider-side model selected from the + referenced ModelProviderService's + ``targets`` catalog, plus the unified + API types the platform should translate + to/from at request time. + required: + - model_provider_service + - target + description: >- + Configuration for an external model + reached through a model provider service. + is_deleted: + type: boolean + description: >- + Whether the destination's backing model or + model provider service has been deleted. + The destination remains visible so you can + identify the broken dependency. Requests + cannot use this destination until the + backing resource is restored or the + destination is replaced. + pay_per_token_config: + type: object + properties: + model: + type: string + description: >- + Resource name of the Unity Catalog + model. Format: + ``models/{catalog}.{schema}.{model}``. + required: + - model + description: >- + Configuration for a pay-per-token + Databricks foundation model. + provisioned_throughput_config: + type: object + properties: + model_serving_endpoint: + type: string description: >- - Configuration for a - provisioned-throughput foundation-model - destination. References a - pre-existing Model Serving endpoint that serves the model; sizing (provisioned throughput, burst - scaling, model version) is owned by the Model Serving endpoint itself, not by this message. - traffic_percentage: - type: integer + Name of the backing Model Serving + endpoint serving the provisioned- + throughput foundation model, in the form + ``serving-endpoints/{name}``. The same + Unity Catalog model can be served on + multiple Model Serving endpoints with + different throughput, regions, or + configurations. The caller selects the + endpoint to which this destination + routes. The endpoint must exist at + create time. + model: + type: string description: >- - Share of traffic sent to this - destination, 0-100. Optional on fallback - destinations; see FallbackConfig. + UC model FQN of the model served by the + backing endpoint (e.g., + ``system.ai.databricks-claude-opus-4-6``). + Resolved from Model Serving at + Create/Update time. required: - - name - - destination_type + - model_serving_endpoint description: >- - A destination the model service can route - traffic to. Exactly one of the per-type - configs inside - ``type_config`` must be set, and it must match ``destination_type``. - description: >- - Ordered list of fallback destinations. - Traversal is in list order; the attempt - count is the length of the list. At most 5 - are allowed. - description: >- - Fallback routing config, applied after primary - destinations fail. - first_token_timeout: - type: string - description: >- - Timeout for the first token of a streaming - response. If a destination does not return its - first token within this duration, AI Gateway - aborts the attempt and fails over to the next - destination. Applies to streaming requests only. - Leave unset for no first-token timeout. - traffic_splitting: - type: object - properties: {} + Configuration for a provisioned-throughput + Databricks foundation model. + traffic_percentage: + type: integer + description: >- + Percentage of primary traffic sent to this + destination, from 0 to 100. Required when + there is more than one primary + destination, in which case the primary + percentages must sum to 100; a single + primary destination receives all traffic. + Fallback destinations are ordered and do + not use this field. + required: + - name + - destination_type + description: >- + A destination the model service can route + traffic to. Exactly one of the per-type + configs inside + ``type_config`` must be set, and it must match ``destination_type``. description: >- - Marker message selecting request-based traffic - splitting. Traffic is distributed according to - each destination's traffic_percentage value; no - configuration lives on this message itself. + Fallback destinations, tried in the listed + order. At most 5 are allowed. description: >- - Routing configuration: destinations, routing - strategy, and fallback. - description: >- - Operational configuration: destinations, routing, rate - limits, inference table. Required on CreateModelService; - on UpdateModelService it is required only when - ``config`` (or a ``config.*`` subpath) appears in - ``update_mask``. - create_time: - type: string - format: date-time - description: When the model service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: >- - The resolved owner of the ModelService. Falls back to - the caller's identity when ``owner`` is not explicitly - set on creation. - etag: - type: string - description: >- - Optimistic concurrency control token. Server-generated - from the entity's state and returned on every read. To - use it as an if-match precondition on a mutation, echo - the last-read value back via the dedicated ``etag`` - field on the Update / Delete request; the server rejects - the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the model service. - name: - type: string - description: >- - Resource name of the model service. Format: - ``model-services/{catalog}.{schema}.{model_service}``. - Each ``{...}`` component is capped at 255 characters - individually. Server-derived on Create from ``parent`` + - ``model_service_id``; required and immutable on - Update/Get/Delete. - owner: - type: string - description: >- - The owner of the model service. Write-only; read owner - via effective_owner. - supported_api_types: - type: array - items: - type: string - description: >- - Unified API types this endpoint supports (e.g. "chat", - "embeddings", "completions"). Derived from the - destinations' backing models / providers at read time. - update_time: - type: string - format: date-time - description: When the model service was last modified. - updated_by: - type: string - description: Identity of the last updater. + Fallback routing applied after a primary destination + fails. Fallback destinations are tried in the listed + order. + description: 'Routing configuration: destinations and fallback.' description: >- - The model service with the updated field values. ``name`` - identifies the resource - (``model-services/{catalog}.{schema}.{model_service}``); - only fields listed in ``update_mask`` are applied. - required: - - model_service + Destinations, routing, rate limits, and payload logging + configuration. Required on Create. On Update, provide this + field when ``update_mask`` contains ``config`` or one of its + subpaths. + create_time: + type: string + format: date-time + description: Time the model service was created. + created_by: + type: string + description: Creator identity. + effective_owner: + type: string + description: Owner of the model service. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + metastore_id: + type: string + description: Metastore hosting the model service. + name: + type: string + description: >- + Resource name of the model service. Format: + ``model-services/{catalog}.{schema}.{model_service}``. Each + ``{...}`` component is capped at 255 characters + individually. Server-derived on Create from ``parent`` + + ``model_service_id``; required and immutable on + Update/Get/Delete. + supported_api_types: + type: array + items: + type: string + description: >- + API types supported across this service's destinations, such + as ``openai/v1/chat/completions``, ``openai/v1/embeddings``, + and ``mlflow/v1/chat/completions``. Derived from the backing + models and providers at read time. + update_time: + type: string + format: date-time + description: Time the model service was last modified. + updated_by: + type: string + description: Identity of the last updater. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ModelService' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + /api/2.1/unity-catalog/skills/{full_name}: + delete: + operationId: ai_gateway_delete_skill + summary: >- + Deletes the skill identified by its resource name and makes its managed + bundle path unavailable. + tags: + - catalog + - ai_gateway + description: >- + Deletes the skill identified by its resource name and makes its managed + bundle path unavailable. + + Managed bundle data is deleted asynchronously. Optionally supply an + ``etag`` to make the delete + + conditional on the skill not having changed since it was read. + + + You must be the owner of the skill or have ``MANAGE`` on it, plus + ``USE_CATALOG`` on the parent + + catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Full resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` + component is capped at 255 characters individually. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the delete succeeds only if the + resource has not changed. Leave unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`skills/{full_name}`). Full resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component is + capped at 255 characters individually. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the delete succeeds only if the resource has not changed. Leave + unset for an unconditional delete. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + get: + operationId: ai_gateway_get_skill + summary: Returns the skill identified by its resource name. + tags: + - catalog + - ai_gateway + description: >- + Returns the skill identified by its resource name. + + + You must be the owner of the skill or have ``READ_VOLUME``, + ``READ_METADATA``, or ``MANAGE`` on it, + + plus ``USE_CATALOG`` on the parent catalog and ``USE_SCHEMA`` on the + parent schema. + + + :param name: str + Full resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` + component is capped at 255 characters individually. + + :returns: :class:`Skill` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`skills/{full_name}`). Full resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component is + capped at 255 characters individually. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Skill' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + patch: + operationId: ai_gateway_update_skill + summary: >- + Updates a skill. Only fields named in ``update_mask`` are changed; + currently only ``comment`` is + tags: + - catalog + - ai_gateway + description: >- + Updates a skill. Only fields named in ``update_mask`` are changed; + currently only ``comment`` is + + supported. The resource name is immutable. Optionally supply an ``etag`` + to make the update + + conditional on the skill not having changed since it was read. Bundle + files, grants, tags, and + + ownership are unchanged. + + + To update the bundle, add, overwrite (``overwrite=true``), or delete + files under + + ``/Skills/{catalog}/{schema}/{skill}/`` with the Files API, then call + FinalizeSkill. Changing bundle + + files requires being the owner of the skill or having ``READ_VOLUME`` + and ``WRITE_VOLUME`` on it; + + ``MANAGE`` does not grant access to bundle files. + + + To call UpdateSkill, you must be the owner of the skill or have + ``MANAGE`` on it, plus ``USE_CATALOG`` + + on the parent catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component + is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``skill_id``; + required and immutable on Update/Get/Delete. + :param skill: :class:`Skill` + The skill with the updated field values. ``name`` identifies the resource + (``skills/{catalog}.{schema}.{skill}``); only fields listed in ``update_mask`` are applied. + :param update_mask: FieldMask + Fields to update; validated against ``skill``. REQUIRED, matching the sibling Update RPCs. + ``comment`` is the only mutable field. + :param etag: str (optional) + Optimistic concurrency token from the most recent read. When set, the update succeeds only if the + resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query parameter. + + :returns: :class:`Skill` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`skills/{full_name}`). Resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component is + capped at 255 characters individually. Server-derived on Create from + ``parent`` + ``skill_id``; required and immutable on + Update/Get/Delete. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Fields to update; validated against ``skill``. REQUIRED, matching + the sibling Update RPCs. ``comment`` is the only mutable field. + - name: etag + in: query + required: false + schema: + type: string + description: >- + Optimistic concurrency token from the most recent read. When set, + the update succeeds only if the resource has not changed. Leave + unset for an unconditional update. For REST requests, URL-encode the + base64 string returned by the API when setting the ``etag`` query + parameter. + requestBody: + content: + application/json: + schema: + type: object + properties: + bundle_name: + type: string + description: >- + Name from the most recently successfully finalized SKILL.md. + It may differ from the final component of the Skill resource + name. Unset until FinalizeSkill succeeds. + comment: + type: string + description: >- + User-provided comment for the skill. Free-text, + user-editable via UpdateSkill (listed in its + ``update_mask``). DISTINCT from ``description``, which is + the server-parsed, OUTPUT_ONLY SKILL.md frontmatter value: + ``comment`` is the customer's own annotation and is + preserved across bundle re-uploads. When ``comment`` is in + the update mask, omitting it clears the field, while an + explicitly empty string is retained. + create_time: + type: string + format: date-time + description: Time the skill was created. + created_by: + type: string + description: Creator identity. + description: + type: string + description: >- + Description from the most recently successfully finalized + SKILL.md. Unset until FinalizeSkill succeeds. + effective_owner: + type: string + description: Owner of the skill. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make + an Update or Delete conditional, pass the last-read value in + that request's ``etag`` field. In REST responses, this value + is a base64 string; URL-encode it when setting the ``etag`` + query parameter. + finalize_time: + type: string + format: date-time + description: >- + Time of the most recent successful FinalizeSkill. Unset + until one succeeds. + metastore_id: + type: string + description: Metastore hosting the skill. + name: + type: string + description: >- + Resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` + component is capped at 255 characters individually. + Server-derived on Create from ``parent`` + ``skill_id``; + required and immutable on Update/Get/Delete. + update_time: + type: string + format: date-time + description: >- + Time of the most recent Skill metadata mutation. Uploading + bundle files alone does not change this value. + updated_by: + type: string + description: Identity of the last updater. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Skill' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: AiGatewayAPI + /api/2.1/unity-catalog/skills/{full_name}/finalize: + post: + operationId: ai_gateway_finalize_skill + summary: >- + Finalizes a skill after its bundle files are uploaded or changed through + the Files API. Call it again + tags: + - catalog + - ai_gateway + description: >- + Finalizes a skill after its bundle files are uploaded or changed through + the Files API. Call it again + + after every bundle change. This method reads SKILL.md through the Files + API using the caller's + + authorization. Its YAML frontmatter must contain an + agentskills.io-compliant ``name`` and a nonblank + + ``description`` within the configured UTF-8 byte limit. On success, it + replaces ``bundle_name`` and + + ``description``; refreshes ``finalize_time``, ``update_time``, and + ``updated_by``; and returns the + + updated skill. ``comment`` is preserved. Re-finalization uses the latest + SKILL.md and is + + last-write-wins without an etag precondition. Validation failures do not + change metadata. + + + You must be the owner of the skill or have ``READ_VOLUME`` on it, plus + ``USE_CATALOG`` on the parent + + catalog and ``USE_SCHEMA`` on the parent schema. + + + :param name: str + Full resource name of the skill. Format: ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` + component is capped at 255 characters individually. + + :returns: :class:`Skill` + parameters: + - name: full_name + in: path + required: true + schema: + type: string + description: >- + The `full_name` segment of the `name` resource name + (`skills/{full_name}`). Full resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component is + capped at 255 characters individually. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ModelService' + $ref: '#/components/schemas/Skill' default: description: Error response content: @@ -3518,19 +5638,12 @@ paths: :param name: str Name of catalog. - :param catalog_federation_config: :class:`CatalogFederationConfig` - (optional) - Federation-only configuration, present only for FOREIGN catalogs. :param comment: str (optional) User-provided free-form text description. :param connection_name: str (optional) The name of the connection to an external data source. - :param conversion_info: :class:`ConversionInfo` (optional) - Status of conversion of FOREIGN catalog to UC Native catalog. :param custom_max_retention_hours: int (optional) Custom maximum retention period in hours for the catalog - :param dr_replication_info: :class:`DrReplicationInfo` (optional) - Disaster Recovery replication state snapshot. :param managed_encryption_settings: :class:`EncryptionSettings` (optional) Control CMK encryption for managed catalog data @@ -3557,116 +5670,15 @@ paths: name: type: string description: Name of catalog. - catalog_federation_config: - type: object - properties: - schema_filter_type: - type: string - x-enum: - - SCHEMA_FILTER_TYPE_EXCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE_ALL - description: >- - Controls how the catalog's schema filter items are - treated. - description: >- - Federation-only configuration, present only for FOREIGN - catalogs. comment: type: string description: User-provided free-form text description. connection_name: type: string description: The name of the connection to an external data source. - conversion_info: - type: object - properties: - state: - type: string - x-enum: - - COMPLETED - - IN_PROGRESS - description: The conversion state of the resource. - description: >- - Status of conversion of FOREIGN catalog to UC Native - catalog. custom_max_retention_hours: type: integer description: Custom maximum retention period in hours for the catalog - dr_replication_info: - type: object - properties: - last_failover_time_ms: - type: integer - description: >- - Wall-clock epoch milliseconds when this catalog was last - promoted to primary via failover or failback. Set by DR - Manager. Used by Predictive Optimization to suppress - operations until sufficient workload history - accumulates. - replicated_entities: - type: string - description: >- - See - https://docs.google.com/document/d/1X0A_3hMhzuS2V1E3zB0x5wxPsFx70bVYK5rHep2AjW8. - status: - type: string - x-enum: - - DR_REPLICATION_STATUS_PRIMARY - - DR_REPLICATION_STATUS_SECONDARY - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members can - have their own - - attributes -- see the documentation for details. - description: Disaster Recovery replication state snapshot. managed_encryption_settings: type: object properties: @@ -3970,17 +5982,10 @@ paths: :param name: str The name of the catalog. - :param catalog_federation_config: :class:`CatalogFederationConfig` - (optional) - Federation-only configuration, present only for FOREIGN catalogs. :param comment: str (optional) User-provided free-form text description. - :param conversion_info: :class:`ConversionInfo` (optional) - Status of conversion of FOREIGN catalog to UC Native catalog. :param custom_max_retention_hours: int (optional) Custom maximum retention period in hours for the catalog - :param dr_replication_info: :class:`DrReplicationInfo` (optional) - Disaster Recovery replication state snapshot. :param enable_predictive_optimization: :class:`EnablePredictiveOptimization` (optional) Whether predictive optimization should be enabled for this object and objects under it. @@ -4012,113 +6017,12 @@ paths: schema: type: object properties: - catalog_federation_config: - type: object - properties: - schema_filter_type: - type: string - x-enum: - - SCHEMA_FILTER_TYPE_EXCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE_ALL - description: >- - Controls how the catalog's schema filter items are - treated. - description: >- - Federation-only configuration, present only for FOREIGN - catalogs. comment: type: string description: User-provided free-form text description. - conversion_info: - type: object - properties: - state: - type: string - x-enum: - - COMPLETED - - IN_PROGRESS - description: The conversion state of the resource. - description: >- - Status of conversion of FOREIGN catalog to UC Native - catalog. custom_max_retention_hours: type: integer description: Custom maximum retention period in hours for the catalog - dr_replication_info: - type: object - properties: - last_failover_time_ms: - type: integer - description: >- - Wall-clock epoch milliseconds when this catalog was last - promoted to primary via failover or failback. Set by DR - Manager. Used by Predictive Optimization to suppress - operations until sufficient workload history - accumulates. - replicated_entities: - type: string - description: >- - See - https://docs.google.com/document/d/1X0A_3hMhzuS2V1E3zB0x5wxPsFx70bVYK5rHep2AjW8. - status: - type: string - x-enum: - - DR_REPLICATION_STATUS_PRIMARY - - DR_REPLICATION_STATUS_SECONDARY - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members can - have their own - - attributes -- see the documentation for details. - description: Disaster Recovery replication state snapshot. enable_predictive_optimization: type: string x-enum: @@ -4133,7 +6037,6 @@ paths: x-enum: - ISOLATED - OPEN - - OPEN_IN_ACCOUNT description: >- Whether the current securable is accessible from all workspaces or a specific set of workspaces. @@ -4243,94 +6146,39 @@ paths: connection_type: type: string x-enum: - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AMPLITUDE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - - BIGLAKE + - AWS_SECRETS_MANAGER + - AZURE_KEY_VAULT - BIGQUERY - - CERIDIAN_DAYFORCE - CONFLUENCE - DATABRICKS - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - GITHUB - - GITLAB - GLUE - - GMAIL - - GONG - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - - GOOGLE_CLOUD_LAKEHOUSE - - GOOGLE_WORKSPACE - - GURU - - HIBOB - HIVE_METASTORE - HTTP - HUBSPOT - - ICEBERG_REST - - IRONCLAD - JDBC - - KINESIS - - LINEAR - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - - NOTION + - NETSUITE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - OUTLOOK - - PAGERDUTY - - PALANTIR - - PARTNERSTACK - - PENDO - POSTGRESQL - POWER_BI - - PUBSUB - - QUICKBOOKS - REDSHIFT - SALESFORCE - SALESFORCE_DATA_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - SMARTSHEET - - SNAPCHAT_ADS - SNOWFLAKE - - SPLUNK - SQLDW - SQLSERVER - - SQUARE - TERADATA + - TIKTOK_ADS - UNKNOWN_CONNECTION_TYPE - - VERKADA - WORKDAY_RAAS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS description: The type of connection. options: type: object @@ -4676,47 +6524,38 @@ paths: schema: type: object properties: - tag_assignment: - type: object - properties: - entity_name: - type: string - description: >- - The fully qualified name of the entity to which the tag - is assigned - tag_key: - type: string - description: The key of the tag - entity_type: - type: string - description: The type of the entity to which the tag is assigned. - inherited: - type: boolean - description: Boolean which indicates whether this tag is inherited. - source_type: - type: string - x-enum: - - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION - description: >- - The source type of the tag assignment, e.g., - user-assigned or system-assigned - tag_value: - type: string - description: The value of the tag - update_time: - type: string - format: date-time - description: The timestamp when the tag assignment was last updated - updated_by: - type: string - description: The user or principal who updated the tag assignment - required: - - entity_name - - tag_key - - entity_type - description: Represents a tag assignment to an entity + entity_name: + type: string + description: >- + The fully qualified name of the entity to which the tag is + assigned + tag_key: + type: string + description: The key of the tag + entity_type: + type: string + description: The type of the entity to which the tag is assigned. + source_type: + type: string + x-enum: + - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION + description: >- + The source type of the tag assignment, e.g., user-assigned + or system-assigned + tag_value: + type: string + description: The value of the tag + update_time: + type: string + format: date-time + description: The timestamp when the tag assignment was last updated + updated_by: + type: string + description: The user or principal who updated the tag assignment required: - - tag_assignment + - entity_name + - tag_key + - entity_type responses: '200': description: Success @@ -4821,8 +6660,6 @@ paths: The fully qualified name of the entity to which the tag is assigned :param tag_key: str Required. The key of the tag - :param include_inherited: bool (optional) - Boolean which indicates whether this tag is inherited. :returns: :class:`EntityTagAssignment` parameters: @@ -4844,12 +6681,6 @@ paths: schema: type: string description: Required. The key of the tag - - name: include_inherited - in: query - required: false - schema: - type: boolean - description: Boolean which indicates whether this tag is inherited. responses: '200': description: Success @@ -4959,47 +6790,38 @@ paths: schema: type: object properties: - tag_assignment: - type: object - properties: - entity_name: - type: string - description: >- - The fully qualified name of the entity to which the tag - is assigned - tag_key: - type: string - description: The key of the tag - entity_type: - type: string - description: The type of the entity to which the tag is assigned. - inherited: - type: boolean - description: Boolean which indicates whether this tag is inherited. - source_type: - type: string - x-enum: - - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION - description: >- - The source type of the tag assignment, e.g., - user-assigned or system-assigned - tag_value: - type: string - description: The value of the tag - update_time: - type: string - format: date-time - description: The timestamp when the tag assignment was last updated - updated_by: - type: string - description: The user or principal who updated the tag assignment - required: - - entity_name - - tag_key - - entity_type - description: Represents a tag assignment to an entity + entity_name: + type: string + description: >- + The fully qualified name of the entity to which the tag is + assigned + tag_key: + type: string + description: The key of the tag + entity_type: + type: string + description: The type of the entity to which the tag is assigned. + source_type: + type: string + x-enum: + - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION + description: >- + The source type of the tag assignment, e.g., user-assigned + or system-assigned + tag_value: + type: string + description: The value of the tag + update_time: + type: string + format: date-time + description: The timestamp when the tag assignment was last updated + updated_by: + type: string + description: The user or principal who updated the tag assignment required: - - tag_assignment + - entity_name + - tag_key + - entity_type responses: '200': description: Success @@ -5043,8 +6865,6 @@ paths: The type of the entity to which the tag is assigned. :param entity_name: str The fully qualified name of the entity to which the tag is assigned - :param include_inherited: bool (optional) - Boolean which indicates whether this tag is inherited. :param max_results: int (optional) Optional. Maximum number of tag assignments to return in a single page :param page_token: str (optional) @@ -5064,12 +6884,6 @@ paths: schema: type: string description: The fully qualified name of the entity to which the tag is assigned - - name: include_inherited - in: query - required: false - schema: - type: boolean - description: Boolean which indicates whether this tag is inherited. - name: max_results in: query required: false @@ -5130,95 +6944,80 @@ paths: schema: type: object properties: - external_lineage_relationship: + source: type: object properties: - source: + external_metadata: type: object properties: - external_metadata: - type: object - properties: - name: - type: string - model_version: - type: object - properties: - name: - type: string - version: - type: string - path: - type: object - properties: - url: - type: string - table: - type: object - properties: - name: - type: string - volume: - type: object - properties: - name: - type: string - target: + name: + type: string + model_version: + type: object + properties: + name: + type: string + version: + type: string + path: + type: object + properties: + url: + type: string + table: + type: object + properties: + name: + type: string + target: + type: object + properties: + external_metadata: + type: object + properties: + name: + type: string + model_version: + type: object + properties: + name: + type: string + version: + type: string + path: type: object properties: - external_metadata: - type: object - properties: - name: - type: string - model_version: - type: object - properties: - name: - type: string - version: - type: string - path: - type: object - properties: - url: - type: string - table: - type: object - properties: - name: - type: string - volume: - type: object - properties: - name: - type: string - description: Target object of the external lineage relationship. - columns: - type: array - items: - type: object - properties: - source: - type: string - target: - type: string - description: >- - List of column relationships between source and target - objects. - id: - type: string - description: Unique identifier of the external lineage relationship. - properties: + url: + type: string + table: type: object - description: >- - Key-value properties associated with the external - lineage relationship. - required: - - source - - target + properties: + name: + type: string + description: Target object of the external lineage relationship. + columns: + type: array + items: + type: object + properties: + source: + type: string + target: + type: string + description: >- + List of column relationships between source and target + objects. + id: + type: string + description: Unique identifier of the external lineage relationship. + properties: + type: object + description: >- + Key-value properties associated with the external lineage + relationship. required: - - external_lineage_relationship + - source + - target responses: '200': description: Success @@ -5408,95 +7207,80 @@ paths: schema: type: object properties: - external_lineage_relationship: + source: type: object properties: - source: + external_metadata: type: object properties: - external_metadata: - type: object - properties: - name: - type: string - model_version: - type: object - properties: - name: - type: string - version: - type: string - path: - type: object - properties: - url: - type: string - table: - type: object - properties: - name: - type: string - volume: - type: object - properties: - name: - type: string - target: + name: + type: string + model_version: type: object properties: - external_metadata: - type: object - properties: - name: - type: string - model_version: - type: object - properties: - name: - type: string - version: - type: string - path: - type: object - properties: - url: - type: string - table: - type: object - properties: - name: - type: string - volume: - type: object - properties: - name: - type: string - description: Target object of the external lineage relationship. - columns: - type: array - items: - type: object - properties: - source: - type: string - target: - type: string - description: >- - List of column relationships between source and target - objects. - id: - type: string - description: Unique identifier of the external lineage relationship. - properties: + name: + type: string + version: + type: string + path: type: object - description: >- - Key-value properties associated with the external - lineage relationship. - required: - - source - - target + properties: + url: + type: string + table: + type: object + properties: + name: + type: string + target: + type: object + properties: + external_metadata: + type: object + properties: + name: + type: string + model_version: + type: object + properties: + name: + type: string + version: + type: string + path: + type: object + properties: + url: + type: string + table: + type: object + properties: + name: + type: string + description: Target object of the external lineage relationship. + columns: + type: array + items: + type: object + properties: + source: + type: string + target: + type: string + description: >- + List of column relationships between source and target + objects. + id: + type: string + description: Unique identifier of the external lineage relationship. + properties: + type: object + description: >- + Key-value properties associated with the external lineage + relationship. required: - - external_lineage_relationship + - source + - target responses: '200': description: Success @@ -5619,47 +7403,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - managed_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). managed_pubsub: type: object properties: @@ -5707,47 +7450,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - provided_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). provided_pubsub: type: object properties: @@ -5847,47 +7549,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - managed_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). managed_pubsub: type: object properties: @@ -5935,47 +7596,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - provided_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). provided_pubsub: type: object properties: @@ -6359,47 +7979,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - managed_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). managed_pubsub: type: object properties: @@ -6447,47 +8026,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - provided_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). provided_pubsub: type: object properties: @@ -6587,47 +8125,6 @@ paths: subscription, and external location storage account. Required for locations with a service principal storage credential - managed_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). managed_pubsub: type: object properties: @@ -6660,62 +8157,21 @@ paths: description: >- The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name} Only - required for provided_aqs. - resource_group: - type: string - description: >- - Optional resource group for the queue, event grid - subscription, and external location storage account. - Only required for locations with a service principal - storage credential - subscription_id: - type: string - description: >- - Optional subscription id for the queue, event grid - subscription, and external location storage account. - Required for locations with a service principal - storage credential - provided_onelake: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file - events. Defaults to "$Default" when unset. - Recommended for provided_onelake: create a dedicated - consumer group on the Event Hub for file events to - avoid contending with the customer's other - consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only - required for provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + - event_hub_name instead. - fully_qualified_namespace: + required for provided_aqs. + resource_group: type: string description: >- - The fully qualified domain name of the Event Hubs - namespace, e.g. - {yournamespace}.servicebus.windows.net. Only - required for provided_onelake. - managed_resource_id: + Optional resource group for the queue, event grid + subscription, and external location storage account. + Only required for locations with a service principal + storage credential + subscription_id: type: string description: >- - Unique identifier included in the name of the file - events managed resources. - description: >- - File event queue for OneLake (Microsoft Fabric) - locations. Events flow through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). + Optional subscription id for the queue, event grid + subscription, and external location storage account. + Required for locations with a service principal + storage credential provided_pubsub: type: object properties: @@ -6752,7 +8208,6 @@ paths: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: >- Create a collection of name/value pairs. @@ -6870,90 +8325,83 @@ paths: schema: type: object properties: - external_metadata: + name: + type: string + system_type: + type: string + x-enum: + - AMAZON_REDSHIFT + - AZURE_SYNAPSE + - CONFLUENT + - DATABRICKS + - GOOGLE_BIGQUERY + - KAFKA + - LOOKER + - MICROSOFT_FABRIC + - MICROSOFT_SQL_SERVER + - MONGODB + - MYSQL + - ORACLE + - OTHER + - POSTGRESQL + - POWER_BI + - SALESFORCE + - SAP + - SERVICENOW + - SNOWFLAKE + - STREAM_NATIVE + - TABLEAU + - TERADATA + - WORKDAY + description: Type of external system. + entity_type: + type: string + description: Type of entity within the external system. + columns: + type: array + items: + type: string + description: >- + List of columns associated with the external metadata + object. + create_time: + type: string + description: Time at which this external metadata object was created. + created_by: + type: string + description: Username of external metadata object creator. + description: + type: string + description: User-provided free-form text description. + id: + type: string + description: Unique identifier of the external metadata object. + metastore_id: + type: string + description: Unique identifier of parent metastore. + owner: + type: string + description: Owner of the external metadata object. + properties: type: object - properties: - name: - type: string - system_type: - type: string - x-enum: - - AMAZON_REDSHIFT - - AZURE_SYNAPSE - - CONFLUENT - - DATABRICKS - - GOOGLE_BIGQUERY - - KAFKA - - LOOKER - - MICROSOFT_FABRIC - - MICROSOFT_SQL_SERVER - - MONGODB - - MYSQL - - ORACLE - - OTHER - - POSTGRESQL - - POWER_BI - - SALESFORCE - - SAP - - SERVICENOW - - SNOWFLAKE - - STREAM_NATIVE - - TABLEAU - - TERADATA - - WORKDAY - description: Type of external system. - entity_type: - type: string - description: Type of entity within the external system. - columns: - type: array - items: - type: string - description: >- - List of columns associated with the external metadata - object. - create_time: - type: string - description: Time at which this external metadata object was created. - created_by: - type: string - description: Username of external metadata object creator. - description: - type: string - description: User-provided free-form text description. - id: - type: string - description: Unique identifier of the external metadata object. - metastore_id: - type: string - description: Unique identifier of parent metastore. - owner: - type: string - description: Owner of the external metadata object. - properties: - type: object - description: >- - A map of key-value properties attached to the external - metadata object. - update_time: - type: string - description: >- - Time at which this external metadata object was last - modified. - updated_by: - type: string - description: >- - Username of user who last modified external metadata - object. - url: - type: string - description: URL associated with the external metadata object. - required: - - name - - system_type - - entity_type + description: >- + A map of key-value properties attached to the external + metadata object. + update_time: + type: string + description: >- + Time at which this external metadata object was last + modified. + updated_by: + type: string + description: Username of user who last modified external metadata object. + url: + type: string + description: URL associated with the external metadata object. required: - - external_metadata + - name + - system_type + - entity_type responses: '200': description: Success @@ -7185,90 +8633,83 @@ paths: schema: type: object properties: - external_metadata: + name: + type: string + system_type: + type: string + x-enum: + - AMAZON_REDSHIFT + - AZURE_SYNAPSE + - CONFLUENT + - DATABRICKS + - GOOGLE_BIGQUERY + - KAFKA + - LOOKER + - MICROSOFT_FABRIC + - MICROSOFT_SQL_SERVER + - MONGODB + - MYSQL + - ORACLE + - OTHER + - POSTGRESQL + - POWER_BI + - SALESFORCE + - SAP + - SERVICENOW + - SNOWFLAKE + - STREAM_NATIVE + - TABLEAU + - TERADATA + - WORKDAY + description: Type of external system. + entity_type: + type: string + description: Type of entity within the external system. + columns: + type: array + items: + type: string + description: >- + List of columns associated with the external metadata + object. + create_time: + type: string + description: Time at which this external metadata object was created. + created_by: + type: string + description: Username of external metadata object creator. + description: + type: string + description: User-provided free-form text description. + id: + type: string + description: Unique identifier of the external metadata object. + metastore_id: + type: string + description: Unique identifier of parent metastore. + owner: + type: string + description: Owner of the external metadata object. + properties: type: object - properties: - name: - type: string - system_type: - type: string - x-enum: - - AMAZON_REDSHIFT - - AZURE_SYNAPSE - - CONFLUENT - - DATABRICKS - - GOOGLE_BIGQUERY - - KAFKA - - LOOKER - - MICROSOFT_FABRIC - - MICROSOFT_SQL_SERVER - - MONGODB - - MYSQL - - ORACLE - - OTHER - - POSTGRESQL - - POWER_BI - - SALESFORCE - - SAP - - SERVICENOW - - SNOWFLAKE - - STREAM_NATIVE - - TABLEAU - - TERADATA - - WORKDAY - description: Type of external system. - entity_type: - type: string - description: Type of entity within the external system. - columns: - type: array - items: - type: string - description: >- - List of columns associated with the external metadata - object. - create_time: - type: string - description: Time at which this external metadata object was created. - created_by: - type: string - description: Username of external metadata object creator. - description: - type: string - description: User-provided free-form text description. - id: - type: string - description: Unique identifier of the external metadata object. - metastore_id: - type: string - description: Unique identifier of parent metastore. - owner: - type: string - description: Owner of the external metadata object. - properties: - type: object - description: >- - A map of key-value properties attached to the external - metadata object. - update_time: - type: string - description: >- - Time at which this external metadata object was last - modified. - updated_by: - type: string - description: >- - Username of user who last modified external metadata - object. - url: - type: string - description: URL associated with the external metadata object. - required: - - name - - system_type - - entity_type + description: >- + A map of key-value properties attached to the external + metadata object. + update_time: + type: string + description: >- + Time at which this external metadata object was last + modified. + updated_by: + type: string + description: Username of user who last modified external metadata object. + url: + type: string + description: URL associated with the external metadata object. required: - - external_metadata + - name + - system_type + - entity_type responses: '200': description: Success @@ -7356,7 +8797,6 @@ paths: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -7368,9 +8808,7 @@ paths: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -7431,7 +8869,6 @@ paths: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -7443,9 +8880,7 @@ paths: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -7533,7 +8968,6 @@ paths: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -7545,9 +8979,7 @@ paths: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -7639,26 +9071,6 @@ paths: required: - function_full_name description: A function that is dependent on a SQL object. - metastore_name: - type: string - description: >- - Metastore context for the dependency. Global - UC server responses currently populate this - with the metastore UUID string so clients can - disambiguate dependencies with identical names - across metastores. - secret: - type: object - properties: - secret_full_name: - type: string - description: >- - Full name of the dependent secret, in the - form of - **catalog_name**.**schema_name**.**secret_name**. - required: - - secret_full_name - description: A dependency on a Unity Catalog secret. table: type: object properties: @@ -7671,24 +9083,14 @@ paths: required: - table_full_name description: A table that is dependent on a SQL object. - volume: - type: object - properties: - volume_full_name: - type: string - description: >- - Full name of the dependent volume, in the - form of - **catalog_name**.**schema_name**.**volume_name**. - required: - - volume_full_name - description: A dependency on a Unity Catalog volume. description: >- A dependency of a SQL object. One of the following fields must be defined: **table**, **function**, **connection**, **credential**, **volume**, or **secret**. description: Array of dependencies. - description: function dependencies. + description: >- + Function dependencies. For external UDFs, dependencies + may contain only credential, secret, or volume objects. sql_path: type: string description: >- @@ -8086,8 +9488,6 @@ paths: Type of securable. :param full_name: str Full name of securable. - :param include_deleted_principals: bool (optional) - Optional. If true, also return privilege assignments whose principals have been deleted. :param max_results: int (optional) Specifies the maximum number of privileges to return (page length). Every PrivilegeAssignment present in a single page response is guaranteed to contain all the privileges granted on the @@ -8120,14 +9520,6 @@ paths: schema: type: string description: Full name of securable. - - name: include_deleted_principals - in: query - required: false - schema: - type: boolean - description: >- - Optional. If true, also return privilege assignments whose - principals have been deleted. - name: max_results in: query required: false @@ -8231,70 +9623,42 @@ paths: - APPLY_TAG - BROWSE - CREATE - - CREATE_CASE_COLLECTION - CREATE_CATALOG - CREATE_CLEAN_ROOM - CREATE_CONNECTION - - CREATE_DATASOURCE - CREATE_EXTERNAL_LOCATION - CREATE_EXTERNAL_TABLE - CREATE_EXTERNAL_VOLUME - - CREATE_FEATURE - - CREATE_FLOW - CREATE_FOREIGN_CATALOG - CREATE_FOREIGN_SECURABLE - CREATE_FUNCTION - CREATE_MANAGED_STORAGE - CREATE_MATERIALIZED_VIEW - - CREATE_MEMORY_STORE - CREATE_MODEL - CREATE_PROVIDER - CREATE_RECIPIENT - - CREATE_RULE - CREATE_SCHEMA - - CREATE_SEMANTIC_GRAPH - - CREATE_SERVICE - CREATE_SERVICE_CREDENTIAL - CREATE_SHARE - - CREATE_SKILL - CREATE_STORAGE_CREDENTIAL - - CREATE_STREAM - CREATE_TABLE - CREATE_VIEW - CREATE_VOLUME - - DELETE - - DELETE_EVENTS - - DELETE_SECURITY_DATA - EXECUTE - EXECUTE_CLEAN_ROOM_TASK + - EXTERNAL_USE_LOCATION - EXTERNAL_USE_SCHEMA - - INSERT - - INSERT_SECURITY_DATA - MANAGE - - MANAGE_ACCESS - - MANAGE_ACCESS_CONTROL - MANAGE_ALLOWLIST - - MANAGE_GRANTS - MODIFY - MODIFY_CLEAN_ROOM - - READ_EVENTS - - READ_FEATURE - READ_FILES - - READ_FLOW - - READ_MEMORY_STORE - READ_METADATA - READ_PRIVATE_FILES - - READ_SECURITY_DATA - - READ_SEMANTIC_GRAPH - - READ_SKILL - - READ_STREAM - READ_VOLUME - REFRESH - SELECT - SET_SHARE_PERMISSION - - UPDATE - - UPDATE_EVENTS - - UPDATE_SECURITY_DATA - USAGE - USE_CATALOG - USE_CONNECTION @@ -8303,16 +9667,8 @@ paths: - USE_RECIPIENT - USE_SCHEMA - USE_SHARE - - USE_VOLUME - - VIEW_ADMIN_METADATA - - VIEW_METADATA - - VIEW_OBJECT - WRITE_FILES - - WRITE_FLOW - - WRITE_MEMORY_STORE - WRITE_PRIVATE_FILES - - WRITE_SEMANTIC_GRAPH - - WRITE_SKILL - WRITE_VOLUME description: >- Create a collection of name/value pairs. @@ -8372,17 +9728,6 @@ paths: The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time. - principal_id: - type: integer - description: >- - An opaque internal ID that identifies the principal - whose privileges should be removed. This field is - intended for removing privileges associated with a - deleted user. When set, only the entries specified in - the remove field are processed; any entries in the add - field will be rejected. Only one of principal or - principal_id should be specified, never both at the - same time. remove: type: array items: @@ -8393,70 +9738,42 @@ paths: - APPLY_TAG - BROWSE - CREATE - - CREATE_CASE_COLLECTION - CREATE_CATALOG - CREATE_CLEAN_ROOM - CREATE_CONNECTION - - CREATE_DATASOURCE - CREATE_EXTERNAL_LOCATION - CREATE_EXTERNAL_TABLE - CREATE_EXTERNAL_VOLUME - - CREATE_FEATURE - - CREATE_FLOW - CREATE_FOREIGN_CATALOG - CREATE_FOREIGN_SECURABLE - CREATE_FUNCTION - CREATE_MANAGED_STORAGE - CREATE_MATERIALIZED_VIEW - - CREATE_MEMORY_STORE - CREATE_MODEL - CREATE_PROVIDER - CREATE_RECIPIENT - - CREATE_RULE - CREATE_SCHEMA - - CREATE_SEMANTIC_GRAPH - - CREATE_SERVICE - CREATE_SERVICE_CREDENTIAL - CREATE_SHARE - - CREATE_SKILL - CREATE_STORAGE_CREDENTIAL - - CREATE_STREAM - CREATE_TABLE - CREATE_VIEW - CREATE_VOLUME - - DELETE - - DELETE_EVENTS - - DELETE_SECURITY_DATA - EXECUTE - EXECUTE_CLEAN_ROOM_TASK + - EXTERNAL_USE_LOCATION - EXTERNAL_USE_SCHEMA - - INSERT - - INSERT_SECURITY_DATA - MANAGE - - MANAGE_ACCESS - - MANAGE_ACCESS_CONTROL - MANAGE_ALLOWLIST - - MANAGE_GRANTS - MODIFY - MODIFY_CLEAN_ROOM - - READ_EVENTS - - READ_FEATURE - READ_FILES - - READ_FLOW - - READ_MEMORY_STORE - READ_METADATA - READ_PRIVATE_FILES - - READ_SECURITY_DATA - - READ_SEMANTIC_GRAPH - - READ_SKILL - - READ_STREAM - READ_VOLUME - REFRESH - SELECT - SET_SHARE_PERMISSION - - UPDATE - - UPDATE_EVENTS - - UPDATE_SECURITY_DATA - USAGE - USE_CATALOG - USE_CONNECTION @@ -8465,16 +9782,8 @@ paths: - USE_RECIPIENT - USE_SCHEMA - USE_SHARE - - USE_VOLUME - - VIEW_ADMIN_METADATA - - VIEW_METADATA - - VIEW_OBJECT - WRITE_FILES - - WRITE_FLOW - - WRITE_MEMORY_STORE - WRITE_PRIVATE_FILES - - WRITE_SEMANTIC_GRAPH - - WRITE_SKILL - WRITE_VOLUME description: >- Create a collection of name/value pairs. @@ -8694,8 +10003,6 @@ paths: Type of securable. :param full_name: str Full name of securable. - :param include_deleted_principals: bool (optional) - Optional. If true, also return privilege assignments whose principals have been deleted. :param page_size: int (optional) Specifies the maximum number of privilege assignments to return (page length). Every PrivilegeAssignment present in a single page response is guaranteed to contain all the privileges @@ -8728,14 +10035,6 @@ paths: schema: type: string description: Full name of securable. - - name: include_deleted_principals - in: query - required: false - schema: - type: boolean - description: >- - Optional. If true, also return privilege assignments whose - principals have been deleted. - name: page_size in: query required: false @@ -9803,26 +11102,6 @@ paths: required: - function_full_name description: A function that is dependent on a SQL object. - metastore_name: - type: string - description: >- - Metastore context for the dependency. Global UC - server responses currently populate this with the - metastore UUID string so clients can disambiguate - dependencies with identical names across - metastores. - secret: - type: object - properties: - secret_full_name: - type: string - description: >- - Full name of the dependent secret, in the form - of - **catalog_name**.**schema_name**.**secret_name**. - required: - - secret_full_name - description: A dependency on a Unity Catalog secret. table: type: object properties: @@ -9835,18 +11114,6 @@ paths: required: - table_full_name description: A table that is dependent on a SQL object. - volume: - type: object - properties: - volume_full_name: - type: string - description: >- - Full name of the dependent volume, in the form - of - **catalog_name**.**schema_name**.**volume_name**. - required: - - volume_full_name - description: A dependency on a Unity Catalog volume. description: >- A dependency of a SQL object. One of the following fields must be defined: **table**, @@ -10116,16 +11383,16 @@ paths: get: operationId: model_versions_list summary: >- - List model versions. You can list model versions under a particular - schema, or list all model versions + List the model versions of the specified registered model, identified by + its full three-level name tags: - catalog - model_versions description: >- - List model versions. You can list model versions under a particular - schema, or list all model versions + List the model versions of the specified registered model, identified by + its full three-level name - in the current metastore. + (catalog.schema.model). The returned models are filtered based on the privileges of the calling @@ -10254,281 +11521,267 @@ paths: schema: type: object properties: - table: + name: + type: string + description: Full three-part (catalog, schema, table) name of the table. + spec: type: object properties: - name: + perform_full_copy: + type: boolean + description: >- + Whether to create a full-copy pipeline -- a pipeline + that stops after creates a full copy of the source table + upon initialization and does not process any change data + feeds (CDFs) afterwards. The pipeline can still be + manually triggered afterwards, but it always perform a + full copy of the source table and there are no + incremental updates. This mode is useful for syncing + views or tables without CDFs to online tables. Note that + the full-copy pipeline only supports "triggered" + scheduling policy. + pipeline_id: type: string description: >- - Full three-part (catalog, schema, table) name of the - table. - spec: + ID of the associated pipeline. Generated by the server - + cannot be set by the caller. + primary_key_columns: + type: array + items: + type: string + description: >- + Primary Key columns to be used for data insert/update in + the destination. + run_continuously: + type: object + properties: {} + description: >- + Pipeline runs continuously after generating the initial + data. + run_triggered: + type: object + properties: {} + description: >- + Pipeline stops after generating the initial data and can + be triggered later (manually, through a cron job or + through data triggers) + source_table_full_name: + type: string + description: >- + Three-part (catalog, schema, table) name of the source + Delta table. + timeseries_key: + type: string + description: >- + Time series key to deduplicate (tie-break) rows with the + same primary key. + description: Specification of the online table. + status: + type: object + properties: + continuous_update_status: type: object properties: - perform_full_copy: - type: boolean - description: >- - Whether to create a full-copy pipeline -- a pipeline - that stops after creates a full copy of the source - table upon initialization and does not process any - change data feeds (CDFs) afterwards. The pipeline - can still be manually triggered afterwards, but it - always perform a full copy of the source table and - there are no incremental updates. This mode is - useful for syncing views or tables without CDFs to - online tables. Note that the full-copy pipeline only - supports "triggered" scheduling policy. - pipeline_id: - type: string - description: >- - ID of the associated pipeline. Generated by the - server - cannot be set by the caller. - primary_key_columns: - type: array - items: - type: string - description: >- - Primary Key columns to be used for data - insert/update in the destination. - run_continuously: - type: object - properties: {} - description: >- - Pipeline runs continuously after generating the - initial data. - run_triggered: + initial_pipeline_sync_progress: type: object - properties: {} + properties: + estimated_completion_time_seconds: + type: number + description: >- + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: + type: integer + description: >- + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + sync_progress_completion: + type: number + description: >- + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer + description: >- + The total number of rows that need to be synced + in this update. This number may be an estimate. + description: Progress of the initial data synchronization. + last_processed_commit_version: + type: integer description: >- - Pipeline stops after generating the initial data and - can be triggered later (manually, through a cron job - or through data triggers) - source_table_full_name: + The last source table Delta version that was synced + to the online table. Note that this Delta version + may not be completely synced to the online table + yet. + timestamp: type: string description: >- - Three-part (catalog, schema, table) name of the - source Delta table. - timeseries_key: + The timestamp of the last time any data was + synchronized from the source table to the online + table. + description: >- + Detailed status of an online table. Shown if the online + table is in the ONLINE_CONTINUOUS_UPDATE + or the ONLINE_UPDATING_PIPELINE_RESOURCES state. + detailed_state: + type: string + x-enum: + - OFFLINE + - OFFLINE_FAILED + - ONLINE + - ONLINE_CONTINUOUS_UPDATE + - ONLINE_NO_PENDING_UPDATE + - ONLINE_PIPELINE_FAILED + - ONLINE_TRIGGERED_UPDATE + - ONLINE_UPDATING_PIPELINE_RESOURCES + - PROVISIONING + - PROVISIONING_INITIAL_SNAPSHOT + - PROVISIONING_PIPELINE_RESOURCES + description: The state of the online table. + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + description: >- + The last source table Delta version that was synced + to the online table. Note that this Delta version + may only be partially synced to the online table. + Only populated if the table is still online and + available for serving. + timestamp: type: string description: >- - Time series key to deduplicate (tie-break) rows with - the same primary key. - description: Specification of the online table. - status: + The timestamp of the last time any data was + synchronized from the source table to the online + table. Only populated if the table is still online + and available for serving. + description: >- + Detailed status of an online table. Shown if the online + table is in the OFFLINE_FAILED or the + ONLINE_PIPELINE_FAILED state. + message: + type: string + description: >- + A text description of the current state of the online + table. + provisioning_status: type: object properties: - continuous_update_status: + initial_pipeline_sync_progress: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. - description: Progress of the initial data synchronization. - last_processed_commit_version: - type: integer + estimated_completion_time_seconds: + type: number description: >- - The last source table Delta version that was - synced to the online table. Note that this Delta - version may not be completely synced to the - online table yet. - timestamp: - type: string + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: + type: integer description: >- - The timestamp of the last time any data was - synchronized from the source table to the online - table. - description: >- - Detailed status of an online table. Shown if the - online table is in the ONLINE_CONTINUOUS_UPDATE - or the ONLINE_UPDATING_PIPELINE_RESOURCES state. - detailed_state: - type: string - x-enum: - - OFFLINE - - OFFLINE_FAILED - - ONLINE - - ONLINE_CONTINUOUS_UPDATE - - ONLINE_NO_PENDING_UPDATE - - ONLINE_PIPELINE_FAILED - - ONLINE_TRIGGERED_UPDATE - - ONLINE_UPDATING_PIPELINE_RESOURCES - - PROVISIONING - - PROVISIONING_INITIAL_SNAPSHOT - - PROVISIONING_PIPELINE_RESOURCES - description: The state of the online table. - failed_status: - type: object - properties: - last_processed_commit_version: + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + sync_progress_completion: + type: number + description: >- + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: type: integer description: >- - The last source table Delta version that was - synced to the online table. Note that this Delta - version may only be partially synced to the - online table. Only populated if the table is - still online and available for serving. - timestamp: - type: string + The number of rows that have been synced in this + update. + total_row_count: + type: integer description: >- - The timestamp of the last time any data was - synchronized from the source table to the online - table. Only populated if the table is still - online and available for serving. + The total number of rows that need to be synced + in this update. This number may be an estimate. + description: >- + Details about initial data synchronization. Only + populated when in the PROVISIONING_INITIAL_SNAPSHOT + state. + description: >- + Detailed status of an online table. Shown if the online + table is in the + PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. + triggered_update_status: + type: object + properties: + last_processed_commit_version: + type: integer description: >- - Detailed status of an online table. Shown if the - online table is in the OFFLINE_FAILED or the - ONLINE_PIPELINE_FAILED state. - message: + The last source table Delta version that was synced + to the online table. Note that this Delta version + may not be completely synced to the online table + yet. + timestamp: type: string description: >- - A text description of the current state of the - online table. - provisioning_status: + The timestamp of the last time any data was + synchronized from the source table to the online + table. + triggered_update_progress: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. + estimated_completion_time_seconds: + type: number description: >- - Details about initial data synchronization. Only - populated when in the - PROVISIONING_INITIAL_SNAPSHOT state. - description: >- - Detailed status of an online table. Shown if the - online table is in the - PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. - triggered_update_status: - type: object - properties: - last_processed_commit_version: + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: type: integer description: >- - The last source table Delta version that was - synced to the online table. Note that this Delta - version may not be completely synced to the - online table yet. - timestamp: - type: string + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + sync_progress_completion: + type: number description: >- - The timestamp of the last time any data was - synchronized from the source table to the online - table. - triggered_update_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer description: >- - Progress of the active data synchronization - pipeline. + The total number of rows that need to be synced + in this update. This number may be an estimate. description: >- - Detailed status of an online table. Shown if the - online table is in the ONLINE_TRIGGERED_UPDATE - or the ONLINE_NO_PENDING_UPDATE state. - description: Online Table data synchronization status - table_serving_url: - type: string - description: Data serving REST API URL for this table - unity_catalog_provisioning_state: - type: string - x-enum: - - ACTIVE - - DEGRADED - - DELETING - - FAILED - - PROVISIONING - - UPDATING + Progress of the active data synchronization + pipeline. description: >- - The provisioning state of the online table entity in - Unity Catalog. This is distinct from the state of the - data synchronization pipeline (i.e. the table may be in - "ACTIVE" but the pipeline may be in "PROVISIONING" as it - runs asynchronously). - description: Specification of the online table to be created. - required: - - table + Detailed status of an online table. Shown if the online + table is in the ONLINE_TRIGGERED_UPDATE + or the ONLINE_NO_PENDING_UPDATE state. + description: Online Table data synchronization status + table_serving_url: + type: string + description: Data serving REST API URL for this table + unity_catalog_provisioning_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - DELETING + - FAILED + - PROVISIONING + - UPDATING + description: >- + The provisioning state of the online table entity in Unity + Catalog. This is distinct from the state of the data + synchronization pipeline (i.e. the table may be in "ACTIVE" + but the pipeline may be in "PROVISIONING" as it runs + asynchronously). responses: '200': description: Success @@ -10654,339 +11907,340 @@ paths: schema: type: object properties: - policy_info: + to_principals: + type: array + items: + type: string + for_securable_type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Type of securables that the policy should take effect on. + Required on create and optional on update. + policy_type: + type: string + x-enum: + - POLICY_TYPE_COLUMN_MASK + - POLICY_TYPE_DENY + - POLICY_TYPE_GRANT + - POLICY_TYPE_ROW_FILTER + description: Type of the policy. Required on create. + column_mask: type: object properties: - to_principals: - type: array - items: - type: string - for_securable_type: + function_name: type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Type of securables that the policy should take effect - on. Only ``TABLE`` is supported at this moment. Required - on create and optional on update. - policy_type: + on_column: type: string - x-enum: - - POLICY_TYPE_COLUMN_MASK - - POLICY_TYPE_DENY - - POLICY_TYPE_GRANT - - POLICY_TYPE_ROW_FILTER - description: Type of the policy. Required on create. - column_mask: - type: object - properties: - function_name: - type: string - on_column: - type: string - description: >- - The alias of the column to be masked. The alias must - refer to one of matched columns. The values of the - column is passed to the column mask function as the - first argument. Required on create and update. - using: - type: array - items: + description: >- + The alias of the column to be masked. The alias must + refer to one of matched columns. The values of the + column is passed to the column mask function as the + first argument. Required on create and update. + using: + type: array + items: + type: object + properties: + alias: + type: string + constant: + type: string + description: A constant literal. + function_arg_expression: type: object properties: - alias: - type: string - constant: - type: string - description: A constant literal. - function_arg_expression: + tag_introspection: type: object properties: - tag_introspection: + column_tag_value: type: object properties: - column_tag_value: - type: object - properties: - column_alias: - type: string - description: >- - The alias from MATCH COLUMNS that - identifies the column. - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - column_alias - - tag_key + column_alias: + type: string description: >- - Extracts the value of a column-level - tag. - tag_value: - type: object - properties: - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - tag_key + The alias from MATCH COLUMNS that + identifies the column. + tag_key: + type: string + description: >- + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - column_alias + - tag_key + description: Extracts the value of a column-level tag. + tag_value: + type: object + properties: + tag_key: + type: string description: >- - Extracts the value of a securable-level - tag. + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - tag_key description: >- - An expression that introspects tags at - query time. + Extracts the value of a securable-level + tag. description: >- - An expression evaluated at query time. Wraps - per-request expression variants (e.g., tag - introspection) so new variants can be added - without extending the FunctionArgument oneof. - description: >- - Optional list of column aliases or constant literals - to be passed as additional arguments to the column - mask function. The type of each column should match - the positional argument of the column mask function. - required: - - function_name - - on_column - description: >- - Options for column mask policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_COLUMN_MASK``. Required - on create and optional on update. When specified on - update, the new options will replace the existing - options as a whole. - comment: - type: string - description: Optional description of the policy. - created_at: - type: integer - description: >- - Time at which the policy was created, in epoch - milliseconds. Output only. - created_by: - type: string - description: >- - Username of the user who created the policy. Output - only. - deny: - type: object - properties: - privileges: - type: array - items: - type: string - required: - - privileges + An expression that introspects tags at query + time. + description: >- + An expression evaluated at query time. Wraps + per-request expression variants (e.g., tag + introspection) so new variants can be added + without extending the FunctionArgument oneof. description: >- - Options for deny policies. Valid only if ``policy_type`` - is ``POLICY_TYPE_DENY``. Required on create and optional - on update. When specified on update, the new options - will replace the existing options as a whole. - except_principals: + Optional list of column aliases or constant literals to + be passed as additional arguments to the column mask + function. The type of each column should match the + positional argument of the column mask function. + required: + - function_name + - on_column + description: >- + Options for column mask policies. Valid only if + ``policy_type`` is ``POLICY_TYPE_COLUMN_MASK``. Required on + create and optional on update. When specified on update, the + new options will replace the existing options as a whole. + comment: + type: string + description: Optional description of the policy. + created_at: + type: integer + description: >- + Time at which the policy was created, in epoch milliseconds. + Output only. + created_by: + type: string + description: Username of the user who created the policy. Output only. + deny: + type: object + properties: + privileges: type: array items: type: string - description: >- - Optional list of user or group names that should be - excluded from the policy. - grant: - type: object - properties: - privileges: - type: array - items: - type: string - required: - - privileges - description: >- - Options for grant policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_GRANT``. Required on - create and optional on update. When specified on update, - the new options will replace the existing options as a - whole. - id: + required: + - privileges + description: >- + Options for deny policies. Valid only if ``policy_type`` is + ``POLICY_TYPE_DENY``. Required on create and optional on + update. When specified on update, the new options will + replace the existing options as a whole. + except_principals: + type: array + items: + type: string + description: >- + Optional list of user or group names that should be excluded + from the policy. + governed_tags: + type: array + items: + type: object + properties: + tag_key: + type: string + description: The governed tag key. + tag_value: + type: string + description: >- + The governed tag value, when the policy references a + specific value. + required: + - tag_key + description: A governed tag referenced by a policy condition. + description: >- + Governed tag keys and values referenced by this policy's + conditions and function arguments. Output only. + grant: + type: object + properties: + privileges: + type: array + items: + type: string + required: + - privileges + description: >- + Options for grant policies. Valid only if ``policy_type`` is + ``POLICY_TYPE_GRANT``. Required on create and optional on + update. When specified on update, the new options will + replace the existing options as a whole. + id: + type: string + description: >- + Unique identifier of the policy. This field is output only + and is generated by the system. + match_columns: + type: array + items: + type: object + properties: + alias: + type: string + condition: + type: string + description: The condition expression used to match a table column. + description: >- + Optional list of condition expressions used to match table + columns. Only valid when ``for_securable_type`` is + ``TABLE``. When specified, the policy only applies to tables + whose columns satisfy all match conditions. + name: + type: string + description: >- + Name of the policy. Required on create and optional on + update. To rename the policy, set ``name`` to a different + value on update. + on_securable_fullname: + type: string + description: >- + Full name of the securable on which the policy is defined. + Required on create. + on_securable_type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Type of the securable on which the policy is defined. Only + ``CATALOG``, ``SCHEMA`` and ``TABLE`` are supported at this + moment. Required on create. + row_filter: + type: object + properties: + function_name: type: string - description: >- - Unique identifier of the policy. This field is output - only and is generated by the system. - match_columns: + using: type: array items: type: object properties: alias: type: string - condition: + constant: type: string - description: >- - The condition expression used to match a table - column. - description: >- - Optional list of condition expressions used to match - table columns. Only valid when ``for_securable_type`` is - ``TABLE``. When specified, the policy only applies to - tables whose columns satisfy all match conditions. - name: - type: string - description: >- - Name of the policy. Required on create and optional on - update. To rename the policy, set ``name`` to a - different value on update. - on_securable_fullname: - type: string - description: >- - Full name of the securable on which the policy is - defined. Required on create. - on_securable_type: - type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Type of the securable on which the policy is defined. - Only ``CATALOG``, ``SCHEMA`` and ``TABLE`` are supported - at this moment. Required on create. - row_filter: - type: object - properties: - function_name: - type: string - using: - type: array - items: + description: A constant literal. + function_arg_expression: type: object properties: - alias: - type: string - constant: - type: string - description: A constant literal. - function_arg_expression: + tag_introspection: type: object properties: - tag_introspection: + column_tag_value: type: object properties: - column_tag_value: - type: object - properties: - column_alias: - type: string - description: >- - The alias from MATCH COLUMNS that - identifies the column. - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - column_alias - - tag_key + column_alias: + type: string description: >- - Extracts the value of a column-level - tag. - tag_value: - type: object - properties: - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - tag_key + The alias from MATCH COLUMNS that + identifies the column. + tag_key: + type: string + description: >- + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - column_alias + - tag_key + description: Extracts the value of a column-level tag. + tag_value: + type: object + properties: + tag_key: + type: string description: >- - Extracts the value of a securable-level - tag. + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - tag_key description: >- - An expression that introspects tags at - query time. + Extracts the value of a securable-level + tag. description: >- - An expression evaluated at query time. Wraps - per-request expression variants (e.g., tag - introspection) so new variants can be added - without extending the FunctionArgument oneof. - description: >- - Optional list of column aliases or constant literals - to be passed as arguments to the row filter - function. The type of each column should match the - positional argument of the row filter function. - required: - - function_name - description: >- - Options for row filter policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_ROW_FILTER``. Required - on create and optional on update. When specified on - update, the new options will replace the existing - options as a whole. - updated_at: - type: integer - description: >- - Time at which the policy was last modified, in epoch - milliseconds. Output only. - updated_by: - type: string - description: >- - Username of the user who last modified the policy. - Output only. - use_session_identity: - type: boolean + An expression that introspects tags at query + time. + description: >- + An expression evaluated at query time. Wraps + per-request expression variants (e.g., tag + introspection) so new variants can be added + without extending the FunctionArgument oneof. description: >- - Temporary for migrating customers to session identity. - Customers not currently using ABAC will not be able to - set this field to false and all new policies will have - this field default to true. Existing customers will have - this field default to false, but can set it to true to - opt in to session identity. after a grace period, this - field will be removed and all policies will use session - identity. Only for row filter and column mask policies. - Not applicable to deny policies. - when_condition: - type: string - description: Optional condition when the policy should take effect. + Optional list of column aliases or constant literals to + be passed as arguments to the row filter function. The + type of each column should match the positional argument + of the row filter function. required: - - to_principals - - for_securable_type - - policy_type - description: Required. The policy to create. + - function_name + description: >- + Options for row filter policies. Valid only if + ``policy_type`` is ``POLICY_TYPE_ROW_FILTER``. Required on + create and optional on update. When specified on update, the + new options will replace the existing options as a whole. + updated_at: + type: integer + description: >- + Time at which the policy was last modified, in epoch + milliseconds. Output only. + updated_by: + type: string + description: >- + Username of the user who last modified the policy. Output + only. + when_condition: + type: string + description: Optional condition when the policy should take effect. required: - - policy_info + - to_principals + - for_securable_type + - policy_type responses: '200': description: Success @@ -11185,349 +12439,340 @@ paths: schema: type: object properties: - policy_info: + to_principals: + type: array + items: + type: string + for_securable_type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Type of securables that the policy should take effect on. + Required on create and optional on update. + policy_type: + type: string + x-enum: + - POLICY_TYPE_COLUMN_MASK + - POLICY_TYPE_DENY + - POLICY_TYPE_GRANT + - POLICY_TYPE_ROW_FILTER + description: Type of the policy. Required on create. + column_mask: type: object properties: - to_principals: - type: array - items: - type: string - for_securable_type: + function_name: type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Type of securables that the policy should take effect - on. Only ``TABLE`` is supported at this moment. Required - on create and optional on update. - policy_type: + on_column: type: string - x-enum: - - POLICY_TYPE_COLUMN_MASK - - POLICY_TYPE_DENY - - POLICY_TYPE_GRANT - - POLICY_TYPE_ROW_FILTER - description: Type of the policy. Required on create. - column_mask: - type: object - properties: - function_name: - type: string - on_column: - type: string - description: >- - The alias of the column to be masked. The alias must - refer to one of matched columns. The values of the - column is passed to the column mask function as the - first argument. Required on create and update. - using: - type: array - items: + description: >- + The alias of the column to be masked. The alias must + refer to one of matched columns. The values of the + column is passed to the column mask function as the + first argument. Required on create and update. + using: + type: array + items: + type: object + properties: + alias: + type: string + constant: + type: string + description: A constant literal. + function_arg_expression: type: object properties: - alias: - type: string - constant: - type: string - description: A constant literal. - function_arg_expression: + tag_introspection: type: object properties: - tag_introspection: + column_tag_value: type: object properties: - column_tag_value: - type: object - properties: - column_alias: - type: string - description: >- - The alias from MATCH COLUMNS that - identifies the column. - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - column_alias - - tag_key + column_alias: + type: string description: >- - Extracts the value of a column-level - tag. - tag_value: - type: object - properties: - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - tag_key + The alias from MATCH COLUMNS that + identifies the column. + tag_key: + type: string + description: >- + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - column_alias + - tag_key + description: Extracts the value of a column-level tag. + tag_value: + type: object + properties: + tag_key: + type: string description: >- - Extracts the value of a securable-level - tag. + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - tag_key description: >- - An expression that introspects tags at - query time. + Extracts the value of a securable-level + tag. description: >- - An expression evaluated at query time. Wraps - per-request expression variants (e.g., tag - introspection) so new variants can be added - without extending the FunctionArgument oneof. - description: >- - Optional list of column aliases or constant literals - to be passed as additional arguments to the column - mask function. The type of each column should match - the positional argument of the column mask function. - required: - - function_name - - on_column - description: >- - Options for column mask policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_COLUMN_MASK``. Required - on create and optional on update. When specified on - update, the new options will replace the existing - options as a whole. - comment: - type: string - description: Optional description of the policy. - created_at: - type: integer - description: >- - Time at which the policy was created, in epoch - milliseconds. Output only. - created_by: - type: string - description: >- - Username of the user who created the policy. Output - only. - deny: - type: object - properties: - privileges: - type: array - items: - type: string - required: - - privileges + An expression that introspects tags at query + time. + description: >- + An expression evaluated at query time. Wraps + per-request expression variants (e.g., tag + introspection) so new variants can be added + without extending the FunctionArgument oneof. description: >- - Options for deny policies. Valid only if ``policy_type`` - is ``POLICY_TYPE_DENY``. Required on create and optional - on update. When specified on update, the new options - will replace the existing options as a whole. - except_principals: + Optional list of column aliases or constant literals to + be passed as additional arguments to the column mask + function. The type of each column should match the + positional argument of the column mask function. + required: + - function_name + - on_column + description: >- + Options for column mask policies. Valid only if + ``policy_type`` is ``POLICY_TYPE_COLUMN_MASK``. Required on + create and optional on update. When specified on update, the + new options will replace the existing options as a whole. + comment: + type: string + description: Optional description of the policy. + created_at: + type: integer + description: >- + Time at which the policy was created, in epoch milliseconds. + Output only. + created_by: + type: string + description: Username of the user who created the policy. Output only. + deny: + type: object + properties: + privileges: type: array items: type: string - description: >- - Optional list of user or group names that should be - excluded from the policy. - grant: - type: object - properties: - privileges: - type: array - items: - type: string - required: - - privileges - description: >- - Options for grant policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_GRANT``. Required on - create and optional on update. When specified on update, - the new options will replace the existing options as a - whole. - id: + required: + - privileges + description: >- + Options for deny policies. Valid only if ``policy_type`` is + ``POLICY_TYPE_DENY``. Required on create and optional on + update. When specified on update, the new options will + replace the existing options as a whole. + except_principals: + type: array + items: + type: string + description: >- + Optional list of user or group names that should be excluded + from the policy. + governed_tags: + type: array + items: + type: object + properties: + tag_key: + type: string + description: The governed tag key. + tag_value: + type: string + description: >- + The governed tag value, when the policy references a + specific value. + required: + - tag_key + description: A governed tag referenced by a policy condition. + description: >- + Governed tag keys and values referenced by this policy's + conditions and function arguments. Output only. + grant: + type: object + properties: + privileges: + type: array + items: + type: string + required: + - privileges + description: >- + Options for grant policies. Valid only if ``policy_type`` is + ``POLICY_TYPE_GRANT``. Required on create and optional on + update. When specified on update, the new options will + replace the existing options as a whole. + id: + type: string + description: >- + Unique identifier of the policy. This field is output only + and is generated by the system. + match_columns: + type: array + items: + type: object + properties: + alias: + type: string + condition: + type: string + description: The condition expression used to match a table column. + description: >- + Optional list of condition expressions used to match table + columns. Only valid when ``for_securable_type`` is + ``TABLE``. When specified, the policy only applies to tables + whose columns satisfy all match conditions. + name: + type: string + description: >- + Name of the policy. Required on create and optional on + update. To rename the policy, set ``name`` to a different + value on update. + on_securable_fullname: + type: string + description: >- + Full name of the securable on which the policy is defined. + Required on create. + on_securable_type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Type of the securable on which the policy is defined. Only + ``CATALOG``, ``SCHEMA`` and ``TABLE`` are supported at this + moment. Required on create. + row_filter: + type: object + properties: + function_name: type: string - description: >- - Unique identifier of the policy. This field is output - only and is generated by the system. - match_columns: + using: type: array items: type: object properties: alias: type: string - condition: + constant: type: string - description: >- - The condition expression used to match a table - column. - description: >- - Optional list of condition expressions used to match - table columns. Only valid when ``for_securable_type`` is - ``TABLE``. When specified, the policy only applies to - tables whose columns satisfy all match conditions. - name: - type: string - description: >- - Name of the policy. Required on create and optional on - update. To rename the policy, set ``name`` to a - different value on update. - on_securable_fullname: - type: string - description: >- - Full name of the securable on which the policy is - defined. Required on create. - on_securable_type: - type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Type of the securable on which the policy is defined. - Only ``CATALOG``, ``SCHEMA`` and ``TABLE`` are supported - at this moment. Required on create. - row_filter: - type: object - properties: - function_name: - type: string - using: - type: array - items: + description: A constant literal. + function_arg_expression: type: object properties: - alias: - type: string - constant: - type: string - description: A constant literal. - function_arg_expression: + tag_introspection: type: object properties: - tag_introspection: + column_tag_value: type: object properties: - column_tag_value: - type: object - properties: - column_alias: - type: string - description: >- - The alias from MATCH COLUMNS that - identifies the column. - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - column_alias - - tag_key + column_alias: + type: string description: >- - Extracts the value of a column-level - tag. - tag_value: - type: object - properties: - tag_key: - type: string - description: >- - 1024 matches the max_length on - FunctionArgument.constant above. - required: - - tag_key + The alias from MATCH COLUMNS that + identifies the column. + tag_key: + type: string + description: >- + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - column_alias + - tag_key + description: Extracts the value of a column-level tag. + tag_value: + type: object + properties: + tag_key: + type: string description: >- - Extracts the value of a securable-level - tag. + 1024 matches the max_length on + FunctionArgument.constant above. + required: + - tag_key description: >- - An expression that introspects tags at - query time. + Extracts the value of a securable-level + tag. description: >- - An expression evaluated at query time. Wraps - per-request expression variants (e.g., tag - introspection) so new variants can be added - without extending the FunctionArgument oneof. - description: >- - Optional list of column aliases or constant literals - to be passed as arguments to the row filter - function. The type of each column should match the - positional argument of the row filter function. - required: - - function_name - description: >- - Options for row filter policies. Valid only if - ``policy_type`` is ``POLICY_TYPE_ROW_FILTER``. Required - on create and optional on update. When specified on - update, the new options will replace the existing - options as a whole. - updated_at: - type: integer - description: >- - Time at which the policy was last modified, in epoch - milliseconds. Output only. - updated_by: - type: string - description: >- - Username of the user who last modified the policy. - Output only. - use_session_identity: - type: boolean + An expression that introspects tags at query + time. + description: >- + An expression evaluated at query time. Wraps + per-request expression variants (e.g., tag + introspection) so new variants can be added + without extending the FunctionArgument oneof. description: >- - Temporary for migrating customers to session identity. - Customers not currently using ABAC will not be able to - set this field to false and all new policies will have - this field default to true. Existing customers will have - this field default to false, but can set it to true to - opt in to session identity. after a grace period, this - field will be removed and all policies will use session - identity. Only for row filter and column mask policies. - Not applicable to deny policies. - when_condition: - type: string - description: Optional condition when the policy should take effect. + Optional list of column aliases or constant literals to + be passed as arguments to the row filter function. The + type of each column should match the positional argument + of the row filter function. required: - - to_principals - - for_securable_type - - policy_type + - function_name + description: >- + Options for row filter policies. Valid only if + ``policy_type`` is ``POLICY_TYPE_ROW_FILTER``. Required on + create and optional on update. When specified on update, the + new options will replace the existing options as a whole. + updated_at: + type: integer description: >- - Optional fields to update. This is the request body for - updating a policy. Use ``update_mask`` field to specify - which fields in the request is to be updated. - If - ``update_mask`` is empty or "*", all specified fields will - be updated. - If ``update_mask`` is specified, only the - fields specified in the ``update_mask`` will be updated. If - a field is specified in ``update_mask`` and not set in the - request, the field will be cleared. Users can use the update - mask to explicitly unset optional fields such as - ``exception_principals`` and ``when_condition``. + Time at which the policy was last modified, in epoch + milliseconds. Output only. + updated_by: + type: string + description: >- + Username of the user who last modified the policy. Output + only. + when_condition: + type: string + description: Optional condition when the policy should take effect. required: - - policy_info + - to_principals + - for_securable_type + - policy_type responses: '200': description: Success @@ -13802,6 +15047,7 @@ paths: type: type: string x-enum: + - AGENT_SERVICE - CATALOG - CLEAN_ROOM - CONNECTION @@ -13809,12 +15055,17 @@ paths: - EXTERNAL_LOCATION - EXTERNAL_METADATA - FUNCTION + - MCP_SERVICE - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE - PIPELINE - PROVIDER - RECIPIENT - SCHEMA - SHARE + - SKILL - STAGING_TABLE - STORAGE_CREDENTIAL - TABLE @@ -13938,10 +15189,10 @@ paths: assign destinations. A maximum of 5 emails and 5 external notification destinations (Slack, Microsoft - Teams, and Generic Webhook destinations) can be assigned to a securable. - If a URL destination is + Teams, Generic Webhook, and Databricks App Slack/Teams destinations) can + be assigned to a securable. - assigned, no other destinations can be set. + If a URL destination is assigned, no other destinations can be set. The supported securable types are: "metastore", "catalog", "schema", @@ -13989,162 +15240,160 @@ paths: schema: type: object properties: - access_request_destinations: + securable: type: object properties: - securable: - type: object - properties: - full_name: - type: string - description: >- - Required. The full name of the catalog/schema/table. - Optional if resource_name is present. - provider_share: - type: string - description: >- - Optional. The name of the Share object that contains - the securable when the securable is getting shared - in D2D Delta Sharing. - type: - type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Required. The type of securable - (catalog/schema/table). Optional if resource_name is - present. - description: >- - Generic definition of a securable, which is uniquely - defined in a metastore by its type and full - name. - are_any_destinations_hidden: - type: boolean + full_name: + type: string description: >- - Indicates whether any destinations are hidden from the - caller due to a lack of permissions. This value is true - if the caller does not have permission to see all - destinations. - destination_source_securable: - type: object - properties: - full_name: - type: string - description: >- - Required. The full name of the catalog/schema/table. - Optional if resource_name is present. - provider_share: - type: string - description: >- - Optional. The name of the Share object that contains - the securable when the securable is getting shared - in D2D Delta Sharing. - type: - type: string - x-enum: - - CATALOG - - CLEAN_ROOM - - CONNECTION - - CREDENTIAL - - EXTERNAL_LOCATION - - EXTERNAL_METADATA - - FUNCTION - - METASTORE - - PIPELINE - - PROVIDER - - RECIPIENT - - SCHEMA - - SHARE - - STAGING_TABLE - - STORAGE_CREDENTIAL - - TABLE - - VOLUME - description: >- - Required. The type of securable - (catalog/schema/table). Optional if resource_name is - present. + Required. The full name of the catalog/schema/table. + Optional if resource_name is present. + provider_share: + type: string description: >- - The source securable from which the destinations are - inherited. Either the same value as securable (if - destination is set directly on the securable) or the - nearest parent securable with destinations set. - destinations: - type: array - items: - type: object - properties: - destination_id: - type: string - destination_type: - type: string - x-enum: - - EMAIL - - GENERIC_WEBHOOK - - MICROSOFT_TEAMS - - SLACK - - URL - description: The type of the destination. - special_destination: - type: string - x-enum: - - SPECIAL_DESTINATION_CATALOG_OWNER - - SPECIAL_DESTINATION_CONNECTION_OWNER - - SPECIAL_DESTINATION_CREDENTIAL_OWNER - - SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER - - SPECIAL_DESTINATION_FUNCTION_OWNER - - SPECIAL_DESTINATION_METASTORE_OWNER - - SPECIAL_DESTINATION_REGISTERED_MODEL_OWNER - - SPECIAL_DESTINATION_SCHEMA_OWNER - - SPECIAL_DESTINATION_TABLE_OWNER - - SPECIAL_DESTINATION_VOLUME_OWNER - description: >- - This field is used to denote whether the - destination is the email of the owner of the - securable object. The special destination cannot - be assigned to a securable and only represents the - default destination of the securable. The - securable types that support default special - destinations are: "catalog", "external_location", - "connection", "credential", and "metastore". The - **destination_type** of a **special_destination** - is always EMAIL. - description: The access request destinations for the securable. + Optional. The name of the Share object that contains the + securable when the securable is getting shared in D2D + Delta Sharing. + type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Required. The type of securable (catalog/schema/table). + Optional if resource_name is present. + description: >- + Generic definition of a securable, which is uniquely defined + in a metastore by its type and full + name. + are_any_destinations_hidden: + type: boolean + description: >- + Indicates whether any destinations are hidden from the + caller due to a lack of permissions. This value is true if + the caller does not have permission to see all destinations. + destination_source_securable: + type: object + properties: full_name: type: string description: >- - The full name of the securable. Redundant with the name - in the securable object, but necessary for Terraform - integration - securable_type: + Required. The full name of the catalog/schema/table. + Optional if resource_name is present. + provider_share: type: string description: >- - The type of the securable. Redundant with the type in - the securable object, but necessary for Terraform - integration - required: - - securable + Optional. The name of the Share object that contains the + securable when the securable is getting shared in D2D + Delta Sharing. + type: + type: string + x-enum: + - AGENT_SERVICE + - CATALOG + - CLEAN_ROOM + - CONNECTION + - CREDENTIAL + - EXTERNAL_LOCATION + - EXTERNAL_METADATA + - FUNCTION + - MCP_SERVICE + - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE + - PIPELINE + - PROVIDER + - RECIPIENT + - SCHEMA + - SHARE + - SKILL + - STAGING_TABLE + - STORAGE_CREDENTIAL + - TABLE + - VOLUME + description: >- + Required. The type of securable (catalog/schema/table). + Optional if resource_name is present. + description: >- + The source securable from which the destinations are + inherited. Either the same value as securable (if + destination is set directly on the securable) or the nearest + parent securable with destinations set. + destinations: + type: array + items: + type: object + properties: + destination_id: + type: string + destination_type: + type: string + x-enum: + - EMAIL + - GENERIC_WEBHOOK + - MICROSOFT_TEAMS + - SLACK + - URL + description: The type of the destination. + special_destination: + type: string + x-enum: + - SPECIAL_DESTINATION_CATALOG_OWNER + - SPECIAL_DESTINATION_CONNECTION_OWNER + - SPECIAL_DESTINATION_CREDENTIAL_OWNER + - SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER + - SPECIAL_DESTINATION_FUNCTION_OWNER + - SPECIAL_DESTINATION_METASTORE_OWNER + - SPECIAL_DESTINATION_REGISTERED_MODEL_OWNER + - SPECIAL_DESTINATION_SCHEMA_OWNER + - SPECIAL_DESTINATION_TABLE_OWNER + - SPECIAL_DESTINATION_VOLUME_OWNER + description: >- + This field is used to denote whether the destination + is the email of the owner of the securable object. The + special destination cannot be assigned to a securable + and only represents the default destination of the + securable. The securable types that support default + special destinations are: "catalog", + "external_location", "connection", "credential", and + "metastore". The **destination_type** of a + **special_destination** is always EMAIL. + description: The access request destinations for the securable. + full_name: + type: string description: >- - The access request destinations to assign to the securable. - For each destination, a **destination_id** and - **destination_type** must be defined. + The full name of the securable. Redundant with the name in + the securable object, but necessary for Terraform + integration + securable_type: + type: string + description: >- + The type of the securable. Redundant with the type in the + securable object, but necessary for Terraform integration required: - - access_request_destinations + - securable responses: '200': description: Success @@ -14578,92 +15827,82 @@ paths: schema: type: object properties: - secret: - type: object - properties: - name: - type: string - description: The name of the secret, relative to its parent schema. - catalog_name: - type: string - description: >- - The name of the catalog where the schema and the secret - reside. - schema_name: - type: string - description: The name of the schema where the secret resides. - value: - type: string - description: >- - The secret value to store. This field is input-only and - is not returned in responses — use the - **effective_value** field (via GetSecret with - **include_value** set to true) to read the secret value. - The maximum size is 60 KiB (pre-encryption). Accepted - content includes passwords, tokens, keys, and other - sensitive credential data. - comment: - type: string - description: User-provided free-form text description of the secret. - create_time: - type: string - format: date-time - description: The time at which this secret was created. - created_by: - type: string - description: The principal that created the secret. - effective_owner: - type: string - description: >- - The effective owner of the secret, which may differ from - the directly-set **owner** due to inheritance. - effective_value: - type: string - description: >- - The secret value. Only populated in responses when you - have the **READ_SECRET** privilege and **include_value** - is set to true in the request. The maximum size is 60 - KiB. - expire_time: - type: string - format: date-time - description: >- - User-provided expiration time of the secret. This field - indicates when the secret should no longer be used and - may be displayed as a warning in the UI. It is purely - informational and does not trigger any automatic actions - or affect the secret's lifecycle. - full_name: - type: string - description: >- - The three-level (fully qualified) name of the secret, in - the form of **catalog_name.schema_name.secret_name**. - metastore_id: - type: string - description: Unique identifier of the metastore hosting the secret. - owner: - type: string - description: >- - The owner of the secret. Defaults to the creating - principal on creation. Can be updated to transfer - ownership of the secret to another principal. - update_time: - type: string - format: date-time - description: The time at which this secret was last updated. - updated_by: - type: string - description: The principal that last updated the secret. - required: - - name - - catalog_name - - schema_name - - value + name: + type: string + description: The name of the secret, relative to its parent schema. + catalog_name: + type: string + description: >- + The name of the catalog where the schema and the secret + reside. + schema_name: + type: string + description: The name of the schema where the secret resides. + value: + type: string + description: >- + The secret value to store. This field is input-only and is + not returned in responses — use the **effective_value** + field (via GetSecret with **include_value** set to true) to + read the secret value. The maximum size is 60 KiB + (pre-encryption). Accepted content includes passwords, + tokens, keys, and other sensitive credential data. + comment: + type: string + description: User-provided free-form text description of the secret. + create_time: + type: string + format: date-time + description: The time at which this secret was created. + created_by: + type: string + description: The principal that created the secret. + effective_owner: + type: string + description: >- + The effective owner of the secret, which may differ from the + directly-set **owner** due to inheritance. + effective_value: + type: string + description: >- + The secret value. Only populated in responses when you have + the **READ_SECRET** privilege and **include_value** is set + to true in the request. The maximum size is 60 KiB. + expire_time: + type: string + format: date-time + description: >- + User-provided expiration time of the secret. This field + indicates when the secret should no longer be used and may + be displayed as a warning in the UI. It is purely + informational and does not trigger any automatic actions or + affect the secret's lifecycle. + full_name: + type: string + description: >- + The three-level (fully qualified) name of the secret, in the + form of **catalog_name.schema_name.secret_name**. + metastore_id: + type: string + description: Unique identifier of the metastore hosting the secret. + owner: + type: string description: >- - The secret object to create. The **name**, **catalog_name**, - **schema_name**, and **value** fields are required. + The owner of the secret. Defaults to the creating principal + on creation. Can be updated to transfer ownership of the + secret to another principal. + update_time: + type: string + format: date-time + description: The time at which this secret was last updated. + updated_by: + type: string + description: The principal that last updated the secret. required: - - secret + - name + - catalog_name + - schema_name + - value responses: '200': description: Success @@ -14846,6 +16085,9 @@ paths: :param full_name: str The three-level (fully qualified) name of the secret (for example, **catalog_name.schema_name.secret_name**). + :param include_value: bool (optional) + Whether to include the secret value in the response. Defaults to false. Requires the **READ_SECRET** + privilege. :returns: :class:`Secret` parameters: @@ -14857,6 +16099,14 @@ paths: description: >- The three-level (fully qualified) name of the secret (for example, **catalog_name.schema_name.secret_name**). + - name: include_value + in: query + required: false + schema: + type: boolean + description: >- + Whether to include the secret value in the response. Defaults to + false. Requires the **READ_SECRET** privilege. responses: '200': description: Success @@ -14941,92 +16191,82 @@ paths: schema: type: object properties: - secret: - type: object - properties: - name: - type: string - description: The name of the secret, relative to its parent schema. - catalog_name: - type: string - description: >- - The name of the catalog where the schema and the secret - reside. - schema_name: - type: string - description: The name of the schema where the secret resides. - value: - type: string - description: >- - The secret value to store. This field is input-only and - is not returned in responses — use the - **effective_value** field (via GetSecret with - **include_value** set to true) to read the secret value. - The maximum size is 60 KiB (pre-encryption). Accepted - content includes passwords, tokens, keys, and other - sensitive credential data. - comment: - type: string - description: User-provided free-form text description of the secret. - create_time: - type: string - format: date-time - description: The time at which this secret was created. - created_by: - type: string - description: The principal that created the secret. - effective_owner: - type: string - description: >- - The effective owner of the secret, which may differ from - the directly-set **owner** due to inheritance. - effective_value: - type: string - description: >- - The secret value. Only populated in responses when you - have the **READ_SECRET** privilege and **include_value** - is set to true in the request. The maximum size is 60 - KiB. - expire_time: - type: string - format: date-time - description: >- - User-provided expiration time of the secret. This field - indicates when the secret should no longer be used and - may be displayed as a warning in the UI. It is purely - informational and does not trigger any automatic actions - or affect the secret's lifecycle. - full_name: - type: string - description: >- - The three-level (fully qualified) name of the secret, in - the form of **catalog_name.schema_name.secret_name**. - metastore_id: - type: string - description: Unique identifier of the metastore hosting the secret. - owner: - type: string - description: >- - The owner of the secret. Defaults to the creating - principal on creation. Can be updated to transfer - ownership of the secret to another principal. - update_time: - type: string - format: date-time - description: The time at which this secret was last updated. - updated_by: - type: string - description: The principal that last updated the secret. - required: - - name - - catalog_name - - schema_name - - value + name: + type: string + description: The name of the secret, relative to its parent schema. + catalog_name: + type: string + description: >- + The name of the catalog where the schema and the secret + reside. + schema_name: + type: string + description: The name of the schema where the secret resides. + value: + type: string + description: >- + The secret value to store. This field is input-only and is + not returned in responses — use the **effective_value** + field (via GetSecret with **include_value** set to true) to + read the secret value. The maximum size is 60 KiB + (pre-encryption). Accepted content includes passwords, + tokens, keys, and other sensitive credential data. + comment: + type: string + description: User-provided free-form text description of the secret. + create_time: + type: string + format: date-time + description: The time at which this secret was created. + created_by: + type: string + description: The principal that created the secret. + effective_owner: + type: string + description: >- + The effective owner of the secret, which may differ from the + directly-set **owner** due to inheritance. + effective_value: + type: string + description: >- + The secret value. Only populated in responses when you have + the **READ_SECRET** privilege and **include_value** is set + to true in the request. The maximum size is 60 KiB. + expire_time: + type: string + format: date-time + description: >- + User-provided expiration time of the secret. This field + indicates when the secret should no longer be used and may + be displayed as a warning in the UI. It is purely + informational and does not trigger any automatic actions or + affect the secret's lifecycle. + full_name: + type: string description: >- - The secret object containing the fields to update. Only - fields specified in **update_mask** will be updated. + The three-level (fully qualified) name of the secret, in the + form of **catalog_name.schema_name.secret_name**. + metastore_id: + type: string + description: Unique identifier of the metastore hosting the secret. + owner: + type: string + description: >- + The owner of the secret. Defaults to the creating principal + on creation. Can be updated to transfer ownership of the + secret to another principal. + update_time: + type: string + format: date-time + description: The time at which this secret was last updated. + updated_by: + type: string + description: The principal that last updated the secret. required: - - secret + - name + - catalog_name + - schema_name + - value responses: '200': description: Success @@ -15562,7 +16802,6 @@ paths: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: >- Whether the current securable is accessible from all workspaces or a specific set of workspaces. @@ -16381,12 +17620,11 @@ paths: column mask function. Distinguishes between column references and literals. description: >- - The list of additional table columns or literals - to be passed as additional arguments to a column - mask function. This is the replacement of the - deprecated using_column_names field and carries - information about the types (alias or constant) of - the arguments to the mask function. + The list of table columns or literals to be passed + as additional arguments to a column mask function, + carrying the type (column reference vs constant + literal) of each argument. Deprecated: use + using_column_names instead. using_column_names: type: array items: @@ -16427,7 +17665,6 @@ paths: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -16439,9 +17676,7 @@ paths: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -18152,138 +19387,6 @@ components: credential_info: $ref: '#/components/schemas/StorageCredentialInfo' description: The storage credential was successfully updated. - AgentService: - type: object - properties: - agent_service_type: - $ref: '#/components/schemas/AgentServiceAgentServiceType' - description: >- - Type of agent service. Required on create. Immutable after creation. - For future internal / genie / app kinds, determines how the backing - agent surface is provisioned. - browse_only: - type: boolean - description: >- - Whether the caller sees only metadata available through the BROWSE - privilege. - comment: - type: string - description: User-provided description. - config: - $ref: '#/components/schemas/AgentServiceConfig' - description: >- - Operational configuration: connection, base_path, system_prompt, - model_service, optional inference table, optional rate limits. - Required on CreateAgentService; on UpdateAgentService it is required - only when ``config`` (or a ``config.*`` subpath) appears in - ``update_mask``. - create_time: - type: string - format: date-time - description: When the agent service was created. - created_by: - type: string - description: Creator identity. - effective_owner: - type: string - description: >- - The resolved owner of the agent service. Falls back to the caller's - identity when ``owner`` is not explicitly set on creation. - etag: - type: string - description: >- - Optimistic concurrency control token. Server-generated from the - entity's state and returned on every read. To use it as an if-match - precondition on a mutation, echo the last-read value back via the - dedicated ``etag`` field on the Update / Delete request; the server - rejects the mutation if the stored etag differs. - metastore_id: - type: string - description: Metastore hosting the agent service. - name: - type: string - description: >- - Resource name of the agent service. Format: - ``agent-services/{catalog}.{schema}.{agent_service}``. Each - ``{...}`` component is capped at 255 characters individually. - Server-derived on Create from ``parent`` + ``agent_service_id``; - required and immutable on Update/Get/Delete. - owner: - type: string - description: >- - The owner of the agent service. Write-only; read owner via - effective_owner. - update_time: - type: string - format: date-time - description: When the agent service was last modified. - updated_by: - type: string - description: Identity of the last updater. - description: >- - An agent service represents a governed registration of an external AI - agent (Bedrock Agents, - Snowflake Cortex Agents, Foundry, etc) in Unity Catalog. It acts as a schema-scoped securable - that references a UC Connection holding the agent platform's auth + endpoint, and exposes the - agent for discovery, authorization, and audit logging. Initial kind: AGENT_SERVICE_STANDARD. - Future kinds (INTERNAL, GENIE, APP) can be added as separate enum values. - AgentServiceConfig: - type: object - properties: - base_path: - type: string - description: >- - Vendor base path appended to the connection url at invocation time. - Bedrock example: ``/agents/AGENT123/agentAliases/ALIAS1/sessions``. - Empty when the agent platform does not require a per-agent suffix. - inference_table: - $ref: '#/components/schemas/InferenceTableConfig' - description: >- - Inference table config for invocation payload logging. Reuses the - shared InferenceTableConfig (same as - ModelServiceConfig.inference_table). - model_service: - type: string - description: >- - Resource name of the model service backing this agent. Empty when - the agent platform manages its own model selection (e.g. Bedrock - Agents). Format: - ``model-services/{catalog}.{schema}.{model_service}``. - rate_limits: - type: array - items: - $ref: '#/components/schemas/RateLimit' - description: >- - Per-principal rate limits applied to invocations routed through this - agent service. Repeated to support per-USER / USER_GROUP / - SERVICE_PRINCIPAL / SERVICE / USER_DEFAULT scopes simultaneously, - mirroring McpServiceConfig.rate_limits. Empty when no rate limit is - configured. - source_connection: - $ref: '#/components/schemas/AgentServiceConfigSourceConnection' - description: External agent referenced via a UC Connection. - system_prompt: - type: string - description: System prompt prepended to invocations. Max 8 KB. - description: >- - Operational configuration for an agent service. Groups the source - connection, base path, system - prompt, model service reference, optional inference table, and optional rate limits. The - ``source_connection.name`` is supplied on create. - AgentServiceConfigSourceConnection: - type: object - properties: - name: - type: string - is_deleted: - type: boolean - required: - - name - description: >- - UC Connection for the agent platform, such as Bedrock Agents, Snowflake - Cortex Agents, or - Foundry. On create, provide ``name`` in the schema-scoped form - ``connections/{catalog}.{schema}.{connection}``. On read, the service returns ``name``. ArtifactAllowlistInfo: type: object properties: @@ -18562,21 +19665,11 @@ components: CancelRefreshResponse: type: object properties: {} - CatalogFederationConfig: - type: object - properties: - schema_filter_type: - $ref: '#/components/schemas/SchemaFilterType' - description: Controls how the catalog's schema filter items are treated. - description: Federation-only configuration for a FOREIGN catalog. CatalogInfo: type: object properties: browse_only: type: boolean - catalog_federation_config: - $ref: '#/components/schemas/CatalogFederationConfig' - description: Federation-only configuration, present only for FOREIGN catalogs. catalog_type: $ref: '#/components/schemas/CatalogType' comment: @@ -18585,9 +19678,6 @@ components: connection_name: type: string description: The name of the connection to an external data source. - conversion_info: - $ref: '#/components/schemas/ConversionInfo' - description: Status of conversion of FOREIGN catalog to UC Native catalog. created_at: type: integer description: Time at which this catalog was created, in epoch milliseconds. @@ -18597,9 +19687,6 @@ components: custom_max_retention_hours: type: integer description: Custom maximum retention period in hours for the catalog - dr_replication_info: - $ref: '#/components/schemas/DrReplicationInfo' - description: Disaster Recovery replication state snapshot. effective_predictive_optimization_flag: $ref: '#/components/schemas/EffectivePredictiveOptimizationFlag' enable_predictive_optimization: @@ -18721,11 +19808,10 @@ components: items: $ref: '#/components/schemas/PolicyFunctionArgument' description: >- - The list of additional table columns or literals to be passed as - additional arguments to a column mask function. This is the - replacement of the deprecated using_column_names field and carries - information about the types (alias or constant) of the arguments to - the mask function. + The list of table columns or literals to be passed as additional + arguments to a column mask function, carrying the type (column + reference vs constant literal) of each argument. Deprecated: use + using_column_names instead. using_column_names: type: array items: @@ -18780,33 +19866,6 @@ components: description: >- Extracts the value of a column-level tag: get_column_tag_value(col, "tagKey"). - ConditionalDisplay: - type: object - properties: - depends_on_option: - type: string - description: >- - The name of the option whose value determines visibility of this - option. - hidden_when_values: - type: array - items: - type: string - description: >- - The values of the depends_on_option that will hide this option. If - empty or not set, this option follows default visibility (shown - unless is_hidden is true). If depends_on_option has any of these - values, this option is hidden. - description: >- - Defines when an option should be hidden based on another option's value. - For example, for - pre-created OAuth connections, some options are conditionally hidden. This field works in - conjunction with OptionSpec.is_hidden: - - - If OptionSpec.is_hidden is true, the option is always hidden regardless of ConditionalDisplay. - - If OptionSpec.is_hidden is false (or unset), ConditionalDisplay determines visibility: - - If depends_on_option matches any value in hidden_when_values, hide this option. - - Otherwise, show this option. ConnectionDependency: type: object properties: @@ -18902,13 +19961,6 @@ components: Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE or the ONLINE_UPDATING_PIPELINE_RESOURCES state. - ConversionInfo: - type: object - properties: - state: - $ref: '#/components/schemas/ConversionInfoState' - description: The conversion state of the resource. - description: Status of conversion of FOREIGN entity into UC Native entity. CreateAccessRequest: type: object properties: @@ -19056,7 +20108,9 @@ components: description: Table function return parameters. routine_dependencies: $ref: '#/components/schemas/DependencyList' - description: function dependencies. + description: >- + Function dependencies. For external UDFs, dependencies may contain + only credential, secret, or volume objects. sql_path: type: string description: >- @@ -19238,6 +20292,13 @@ components: DeleteCredentialResponse: type: object properties: {} + DeleteMcpServiceUserMappedCredentialResponse: + type: object + properties: {} + description: >- + Delete returns no resource; a dedicated (empty) response keeps the + revoke RPC's shape owned here + rather than google.protobuf.Empty. DeleteMonitorResponse: type: object properties: {} @@ -19294,21 +20355,8 @@ components: $ref: '#/components/schemas/CredentialDependency' function: $ref: '#/components/schemas/FunctionDependency' - metastore_name: - type: string - description: >- - Metastore context for the dependency. Global UC server responses - currently populate this with the metastore UUID string so clients - can disambiguate dependencies with identical names across - metastores. - secret: - $ref: '#/components/schemas/SecretDependency' - description: A dependency on a Unity Catalog secret. table: $ref: '#/components/schemas/TableDependency' - volume: - $ref: '#/components/schemas/VolumeDependency' - description: A dependency on a Unity Catalog volume. description: >- A dependency of a SQL object. One of the following fields must be defined: **table**, @@ -19325,24 +20373,6 @@ components: DisableResponse: type: object properties: {} - DrReplicationInfo: - type: object - properties: - last_failover_time_ms: - type: integer - description: >- - Wall-clock epoch milliseconds when this catalog was last promoted to - primary via failover or failback. Set by DR Manager. Used by - Predictive Optimization to suppress operations until sufficient - workload history accumulates. - replicated_entities: - type: string - description: >- - See - https://docs.google.com/document/d/1X0A_3hMhzuS2V1E3zB0x5wxPsFx70bVYK5rHep2AjW8. - status: - $ref: '#/components/schemas/DrReplicationStatus' - description: Metadata related to Disaster Recovery. EffectivePermissionsList: type: object properties: @@ -19439,9 +20469,6 @@ components: entity_type: type: string description: The type of the entity to which the tag is assigned. - inherited: - type: boolean - description: Boolean which indicates whether this tag is inherited. source_type: $ref: '#/components/schemas/TagAssignmentSourceType' description: >- @@ -19535,9 +20562,6 @@ components: table_info: $ref: '#/components/schemas/ExternalLineageTableInfo' description: Information about the table involved in the lineage relationship. - volume_info: - $ref: '#/components/schemas/ExternalLineageVolumeInfo' - description: Information about the volume involved in the lineage relationship. description: Lineage response containing lineage information of a data asset. ExternalLineageModelVersion: type: object @@ -19570,8 +20594,6 @@ components: $ref: '#/components/schemas/ExternalLineagePath' table: $ref: '#/components/schemas/ExternalLineageTable' - volume: - $ref: '#/components/schemas/ExternalLineageVolume' ExternalLineagePath: type: object properties: @@ -19646,26 +20668,6 @@ components: type: string description: Name of Schema. description: Represents the table information in the lineage event. - ExternalLineageVolume: - type: object - properties: - name: - type: string - ExternalLineageVolumeInfo: - type: object - properties: - catalog_name: - type: string - event_time: - type: string - format: date-time - description: Timestamp of the lineage event. - name: - type: string - description: Name of the volume. - schema_name: - type: string - description: Name of the schema. ExternalLocationInfo: type: object properties: @@ -19825,16 +20827,12 @@ components: properties: managed_aqs: $ref: '#/components/schemas/AzureQueueStorage' - managed_onelake: - $ref: '#/components/schemas/OneLakeEventQueue' managed_pubsub: $ref: '#/components/schemas/GcpPubsub' managed_sqs: $ref: '#/components/schemas/AwsSqsQueue' provided_aqs: $ref: '#/components/schemas/AzureQueueStorage' - provided_onelake: - $ref: '#/components/schemas/OneLakeEventQueue' provided_pubsub: $ref: '#/components/schemas/GcpPubsub' provided_sqs: @@ -19977,7 +20975,9 @@ components: description: Function body. routine_dependencies: $ref: '#/components/schemas/DependencyList' - description: function dependencies. + description: >- + Function dependencies. For external UDFs, dependencies may contain + only credential, secret, or volume objects. schema_name: type: string description: Name of parent Schema relative to its parent Catalog. @@ -20091,8 +21091,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -20140,8 +21138,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -20164,8 +21160,6 @@ components: $ref: '#/components/schemas/GcpOauthToken' r2_temp_credentials: $ref: '#/components/schemas/R2Credentials' - uc_encrypted_token: - $ref: '#/components/schemas/UcEncryptedToken' url: type: string description: The URL of the storage path accessible by the temporary credential. @@ -20277,6 +21271,18 @@ components: Opaque token to retrieve the next page of results. Absent if there are no more pages. **page_token** should be set to this value for the next request (for the next page of results). + GovernedTagReference: + type: object + properties: + tag_key: + type: string + description: The governed tag key. + tag_value: + type: string + description: The governed tag value, when the policy references a specific value. + required: + - tag_key + description: A governed tag referenced by a policy condition. GrantOptions: type: object properties: @@ -20292,26 +21298,17 @@ components: parent: type: string description: >- - Parent UC schema where the inference table is created. Format: - ``schemas/{catalog}.{schema}``. Set at create time and immutable - thereafter; changing it on an existing service is rejected. - disabled: - type: boolean - description: >- - Indicates whether payload logging is disabled (opt-out). Unset means - that payload logging is active (the on-by-default state coincides - with the proto zero-value, so the server never fills this field for - a client that leaves it unset). Set ``disabled = true`` to pause - runtime logging while keeping the sub-message attached (preserving - ``parent`` and ``table_name_prefix`` for a later flip back to - active). ``parent`` remains required either way. + Parent Unity Catalog schema where the inference table is created, in + the form ``schemas/{catalog}.{schema}``. Required when configuring + an inference table. After the inference table is created, this field + cannot be changed. is_deleted: type: boolean description: >- - True when the bound inference TABLE has been deleted but the parent - service still references it. The dangling reference is surfaced (not - silently dropped) so callers can see the broken dependency. AI - Gateway payload logging fails closed in this state. + Whether the referenced inference table has been deleted. The + configuration remains visible so you can identify the broken + dependency. Payload logging cannot continue until the table is + restored or the configuration is updated. table: type: string description: >- @@ -20320,22 +21317,18 @@ components: table_name_prefix: type: string description: >- - Prefix for the inference-table's UC-registered name. The actual leaf - name UC stores is ``_payload``; the ``_payload`` - suffix is appended automatically. To find the actual UC table after - Create, read the ``table`` field on the response. Defaults to - ``_payload`` when unset. Set at create time and - immutable thereafter; changing it on an existing service is - rejected. + Prefix used to form the inference table's registered name. AI + Gateway appends ``_payload``; for example, ``table_name_prefix = + "orders"`` creates ``orders_payload``. If unset, the prefix defaults + to the service name. Read ``table`` from the response for the + resulting resource name. After the inference table is created, this + field cannot be changed. required: - parent - description: |- - Inference table configuration for payload logging on a model service. - - ``parent`` is always REQUIRED when the sub-message is set; the destination UC schema is needed - to construct or rebind the payload TABLE regardless of whether payload logging is currently - active. Payload logging is active by default; set ``disabled = true`` to pause runtime logging - without dropping the table or the binding. + description: >- + Configuration for logging request and response payloads to a Unity + Catalog inference table. When + this configuration is present, payload logging is enabled by default. ListAccountMetastoreAssignmentsResponse: type: object properties: @@ -20353,18 +21346,6 @@ components: $ref: '#/components/schemas/StorageCredentialInfo' description: An array of metastore storage credentials. description: The metastore storage credentials were successfully returned. - ListAgentServicesResponse: - type: object - properties: - agent_services: - type: array - items: - $ref: '#/components/schemas/AgentService' - description: The list of agent services. - next_page_token: - type: string - description: Pagination token for retrieving the next page of results. - description: Response for listing agent services. ListCatalogsResponse: type: object properties: @@ -20481,7 +21462,9 @@ components: description: The list of MCP services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: >- + Pagination token for retrieving the next page. Empty when there are + no more results. description: Response for listing MCP services. ListMetastoresResponse: type: object @@ -20506,7 +21489,9 @@ components: description: The list of model provider services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: >- + Pagination token for retrieving the next page. Empty when there are + no more results. description: Response for listing model provider services. ListModelServicesResponse: type: object @@ -20518,7 +21503,9 @@ components: description: The list of model services. next_page_token: type: string - description: Pagination token for retrieving the next page of results. + description: >- + Pagination token for retrieving the next page. Empty when there are + no more results. description: Response for listing model services. ListModelVersionsResponse: type: object @@ -20596,6 +21583,18 @@ components: $ref: '#/components/schemas/Secret' description: An array of secret objects. description: Response message for ListSecrets. + ListSkillsResponse: + type: object + properties: + next_page_token: + type: string + description: Pagination token for retrieving the next page of results. + skills: + type: array + items: + $ref: '#/components/schemas/Skill' + description: The list of skills. + description: Response for listing skills. ListStorageCredentialsResponse: type: object properties: @@ -20655,41 +21654,32 @@ components: McpService: type: object properties: - browse_only: - type: boolean - description: >- - Whether the caller sees only metadata available through the BROWSE - privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/McpServiceConfig' description: >- - Operational configuration: connection, tool selectors, rate limit. - Required on CreateMcpService; on UpdateMcpService it is required - only when ``config`` (or a ``config.*`` subpath) appears in - ``update_mask``. + Connection, tool selectors, and rate limits. Required on Create. On + Update, provide this field when ``update_mask`` contains ``config`` + or one of its subpaths. create_time: type: string format: date-time - description: When the MCP service was created. + description: Time the MCP service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: >- - The resolved owner of the MCP service. Falls back to the caller's - identity when ``owner`` is not explicitly set on creation. + description: Owner of the MCP service. etag: type: string description: >- - Optimistic concurrency control token. Server-generated from the - entity's state and returned on every read. To use it as an if-match - precondition on a mutation, echo the last-read value back via the - dedicated ``etag`` field on the Update / Delete request; the server - rejects the mutation if the stored etag differs. + Optimistic concurrency token returned on every read. To make an + Update or Delete conditional, pass the last-read value in that + request's ``etag`` field. In REST responses, this value is a base64 + string; URL-encode it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the MCP service. @@ -20701,23 +21691,17 @@ components: component is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``mcp_service_id``; required and immutable on Update/Get/Delete. - owner: - type: string - description: >- - The owner of the MCP service. Write-only; read owner via - effective_owner. update_time: type: string format: date-time - description: When the MCP service was last modified. + description: Time the MCP service was last modified. updated_by: type: string description: Identity of the last updater. description: >- - A governed MCP server registration in Unity Catalog. Acts as a container - securable that - references an MCP server -- customer-external via a UC Connection, or Databricks-hosted via an - internal server -- and exposes its tools for discovery, authorization, and invocation. + A Unity Catalog securable that registers an MCP server through a Unity + Catalog connection and + exposes its tools for discovery, authorization, and invocation. McpServiceConfig: type: object properties: @@ -20726,42 +21710,86 @@ components: items: type: string description: >- - Glob or exact-match patterns selecting which tools from the MCP - server to expose. Prefix match for patterns with ``*``, exact match - otherwise. An empty list means all tools are included. Per-element - max 256 chars. + Tool names or prefix patterns to expose from the MCP server. Use + exact tool names or prefix patterns such as ``read_*``. An empty + list exposes all tools. At most 1,024 selectors are allowed, and + each selector can contain at most 256 characters. rate_limits: type: array items: $ref: '#/components/schemas/RateLimit' description: >- - Per-principal rate limits applied to tool invocations routed through - this MCP service. Repeated to support per-USER / USER_GROUP / - SERVICE_PRINCIPAL / SERVICE / USER_DEFAULT scopes simultaneously, - mirroring the ``ModelServiceConfig.rate_limits`` shape. Empty when - no rate limit is configured. + Rate limits for tool invocations. Supported scopes are user, group, + service principal, the service as a whole, and each user by default. + Request and token limits are supported. Empty when no rate limit is + configured. source_connection: $ref: '#/components/schemas/McpServiceConfigSourceConnection' - description: UC Connection referencing the MCP server. + description: >- + Unity Catalog connection referencing the MCP server. Required on + Create. description: >- Operational configuration for an MCP service. Groups the source reference, tool selectors, and - rate limit -- the fields that configure how the MCP service behaves at invocation time. + rate limits -- the fields that configure how the MCP service behaves at invocation time. McpServiceConfigSourceConnection: type: object properties: name: type: string + description: >- + Resource name of the Unity Catalog connection used to access the MCP + server, in the form ``connections/{catalog}.{schema}.{connection}``. is_deleted: type: boolean + description: >- + Whether the referenced connection has been deleted. The MCP service + keeps the reference so callers can identify the broken dependency; + tool invocation fails until the source connection is updated. + options: + type: object + description: >- + Options needed to build the U2M authorize request, returned as a + flat map. When set, it includes: ``authorization_endpoint`` (OAuth + authorize URL), ``token_endpoint`` (token-exchange URL), + ``oauth_scope`` (space-separated scopes to request), ``client_id`` + (OAuth client id), and ``oauth_provider`` (the OAuth provider). required: - name description: >- - UC Connection that hosts the MCP server. On create, provide ``name`` in - the schema-scoped form - ``connections/{catalog}.{schema}.{connection}``. On read, the service populates the resolved - connection metadata and preserves a dangling source so callers can diagnose a deleted backing - connection. + Unity Catalog connection that points to the MCP server. On Create, + provide ``name`` in the + schema-scoped form ``connections/{catalog}.{schema}.{connection}``. On read, the service + populates the resolved connection metadata. If the connection is deleted, its reference remains + visible so you can identify the broken dependency. + McpServiceUserMappedCredential: + type: object + properties: + options: + type: object + description: >- + Token-expiry info for the credential, returned as a flat map: + ``access_token_expiration`` (always set) and + ``refresh_token_expiration`` (set when the credential has a refresh + token). Both values are timestamps. + provisioning_info: + $ref: '#/components/schemas/ProvisioningInfo' + description: >- + Provisioning state of the credential. ``ACTIVE`` means the caller is + logged in and the credential is usable; any other state means the + login has not completed. + description: A caller's per-user OAuth credential for an MCP service. + McpServiceUserMappedCredentialLogin: + type: object + properties: + options: + type: object + description: >- + OAuth exchange fields: ``pkce_verifier``, ``authorization_code``, + and ``oauth_redirect_uri``. + description: >- + Login input for an MCP service user credential. Carries the OAuth + exchange fields as a flat map. MetastoreAssignment: type: object properties: @@ -20855,42 +21883,33 @@ components: ModelProviderService: type: object properties: - browse_only: - type: boolean - description: >- - Whether the caller sees only metadata available through the BROWSE - privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/ModelProviderServiceConfig' description: >- - Behavioral configuration: provider connection, model catalog, and - passthrough policy. See ``ModelProviderServiceConfig`` for the - per-field contract. Required on CreateModelProviderService; on - Update it is required only when ``config`` (or a ``config.*`` - subpath) appears in ``update_mask``. + Provider authentication, exposed models, request-forwarding + controls, rate limits, and payload logging. Required on Create. On + Update, it is required only when ``config`` or one of its subpaths + appears in ``update_mask``. create_time: type: string format: date-time - description: When the provider service was created. + description: Time the provider service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: >- - The resolved owner of the model provider service. Falls back to the - caller's identity when ``owner`` is not explicitly set on creation. + description: Owner of the model provider service. etag: type: string description: >- - Optimistic concurrency control token. Server-generated from the - entity's state and returned on every read. To use it as an if-match - precondition on a mutation, echo the last-read value back via the - dedicated ``etag`` field on the Update / Delete request; the server - rejects the mutation if the stored etag differs. + Optimistic concurrency token returned on every read. To make an + Update or Delete conditional, pass the last-read value in that + request's ``etag`` field. In REST responses, this value is a base64 + string; URL-encode it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the provider service. @@ -20903,37 +21922,32 @@ components: Server-derived on Create from ``parent`` + ``model_provider_service_id``; required and immutable on Update/Get/Delete. - owner: - type: string - description: >- - The owner of the model provider service. Write-only; read owner via - effective_owner. update_time: type: string format: date-time - description: When the provider service was last modified. + description: Time the provider service was last modified. updated_by: type: string description: Identity of the last updater. description: >- - A governed external model-provider connection stored in Unity Catalog - (e.g. an OpenAI API - account, an Azure OpenAI deployment, an Amazon Bedrock account). Owns the provider type and the - auth/configuration the platform needs to invoke that provider, and is referenced from - ``ExternalModelConfig.model_provider_service`` on a ModelService. - - One ModelProviderService can back many ModelServices (e.g. an ``openai_prod`` provider serving - multiple models); a single ModelService can fan out across multiple ModelProviderServices for - traffic split or failover. + A Unity Catalog securable that stores authentication and request + configuration for an external + model provider, such as OpenAI, Azure OpenAI, or Amazon Bedrock. Model service destinations + reference it to send requests to that provider. + + A model provider service can be referenced by multiple model services. A model service can route + across multiple model provider services for traffic splitting or failover. ModelProviderServiceConfig: type: object properties: allow_all_targets: type: boolean description: >- - When true, accepts any model exposed by the upstream provider; - ``targets`` is not required and does not restrict routability. When - false, only models listed in ``targets`` are routable. + When true, allows models from the provider's built-in model catalog + in addition to explicit ``targets``. When false, only models listed + in ``targets`` are routable. Defaults to false. CUSTOM providers + have no built-in model catalog and must leave this false and list + their models in ``targets``. amazon_bedrock: $ref: >- #/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderConfig @@ -20943,83 +21957,87 @@ components: azure_openai: $ref: >- #/components/schemas/ModelProviderServiceConfigAzureOpenAiProviderConfig + bedrock_mantle: + $ref: >- + #/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderConfig custom: $ref: '#/components/schemas/ModelProviderServiceConfigCustomProviderConfig' forward_headers: type: boolean description: >- - Whether to forward incoming request headers to the upstream - provider. Applies to managed (multi-model) requests as well as - passthrough requests served by this provider service. - Governance-level decision by the provider service owner; not - selectable per inference call. + Whether to forward incoming HTTP headers to the upstream provider. + Defaults to false and is configured for the entire provider service, + not per request. Upstream authentication is configured separately in + the provider-specific configuration. forward_query_parameters: type: boolean description: >- - Whether to forward incoming request query parameters to the upstream - provider. Same trust-boundary semantics as ``forward_headers``. + Whether to forward incoming query parameters to the upstream + provider. Defaults to false and is configured for the entire + provider service, not per request. forward_unmanaged_paths: type: boolean description: >- - Whether to forward request paths that fall outside this service's - managed API set to the upstream provider as opaque passthrough. When - true, requests addressed to subpaths not recognized by the managed - API surface are proxied to the upstream provider over the same - provider connection. When false, only managed-API paths are served. - Governance-level decision by the provider service owner; expanding - this expands the trust boundary that the ModelProviderService - exposes. + Whether to proxy paths that AI Gateway does not recognize as + configured provider-native API types. Defaults to false. When true, + these paths are forwarded unchanged to the upstream provider. When + false, only recognized API paths are served. Enabling this broadens + the upstream API surface exposed through the provider service. AI + Gateway cannot evaluate Service Policies on opaque unmanaged + requests, so unmanaged requests are rejected whenever Service + Policies are attached to this securable. gemini_enterprise: $ref: >- #/components/schemas/ModelProviderServiceConfigGeminiEnterpriseProviderConfig inference_table: $ref: '#/components/schemas/InferenceTableConfig' description: >- - Inference table configuration for payload logging when this provider - service is invoked directly. When it is invoked through a model - service, the model service's own inference table captures the - invocation instead. Mirrors ``ModelServiceConfig.inference_table`` / - ``AgentServiceConfig.inference_table``. + Payload logging configuration for requests sent directly to this + provider service. Requests routed through a model service are + captured by that model service's inference table instead. microsoft_foundry: $ref: >- #/components/schemas/ModelProviderServiceConfigMicrosoftFoundryProviderConfig openai: $ref: '#/components/schemas/ModelProviderServiceConfigOpenAiProviderConfig' + pricing: + $ref: '#/components/schemas/ModelProviderServiceConfigProviderPricingConfig' + description: >- + Pricing configuration for this provider service. An explicitly empty + configuration is retained on Create and Update and applies no + adjustment. provider_type: $ref: >- #/components/schemas/ModelProviderServiceConfigExternalModelProviderType description: >- - Provider type discriminator. Required at create time; immutable - after. Determines which variant of the ``provider`` oneof must be - set. May not be changed via Update; attempts to include - ``config.provider_type`` in - ``UpdateModelProviderServiceRequest.update_mask`` are rejected. - Required on CreateModelProviderService and immutable thereafter. + External model provider. Required on Create and immutable + thereafter. Set the matching provider-specific configuration, such + as ``openai``, ``azure_openai``, or ``amazon_bedrock``. rate_limits: type: array items: $ref: '#/components/schemas/RateLimit' description: >- - Rate limits applied when this provider service is invoked directly. - When it is invoked through a model service, the model service's own - ``rate_limits`` apply instead. Mirrors - ``ModelServiceConfig.rate_limits`` / - ``McpServiceConfig.rate_limits``. + Rate limits for requests sent directly to this provider service. + Requests routed through a model service use that model service's + rate limits instead. targets: type: array items: $ref: '#/components/schemas/ModelProviderServiceConfigModelTargetConfig' description: >- - Routing targets this provider service exposes (provider-side model - identifier + unified API types per entry). Required (>=1) when - ``allow_all_targets = false``; optional and additive when - ``allow_all_targets = true``. References from - ``ExternalModelConfig.target`` must match an entry here unless - ``allow_all_targets = true``. + Models and provider-native API types exposed by this provider + service. Each entry must include at least one ``native_api_types`` + value. When ``allow_all_targets`` is false, at least one entry is + required and model service destinations can reference only listed + models. When ``allow_all_targets`` is true, models from the + provider's built-in model catalog are also routable. CUSTOM + providers must explicitly list their models here and cannot enable + ``allow_all_targets``. description: >- - Behavioral configuration for a ModelProviderService: provider connection - (auth + - provider-specific fields), the catalog of models this provider service can route to, and the + Behavioral configuration for a ModelProviderService: provider + authentication and + provider-specific fields, the catalog of models this provider service can route to, and the passthrough policy that governs how request headers, query parameters, and unmanaged subpaths cross the trust boundary to the upstream provider. ModelProviderServiceConfigAmazonBedrockProviderConfig: @@ -21028,6 +22046,7 @@ components: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigAmazonBedrockProviderDirectConfig + description: Amazon Bedrock region and authentication configuration. description: Amazon Bedrock provider configuration. ModelProviderServiceConfigAmazonBedrockProviderDirectConfig: type: object @@ -21035,24 +22054,9 @@ components: aws_access_key: $ref: '#/components/schemas/ModelProviderServiceConfigAwsAccessKey' description: >- - AWS access-key-pair auth. Mutually exclusive with - ``service_credential``. Supersedes the flat ``aws_access_key_id`` / - ``aws_secret_access_key`` fields. - aws_access_key_id: - type: string - description: >- - Deprecated flat AWS access key ID. Superseded by - ``aws_access_key.access_key_id``. Kept for one migration cycle; the - handler mirrors it to/from ``aws_access_key``. Treated as - username-equivalent (not a secret value): round-trips on reads and - is scrubbed from audit logs. - aws_secret_access_key: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: >- - Deprecated flat AWS secret access key. Superseded by - ``aws_access_key.secret_access_key``. Kept for one migration cycle; - the handler mirrors it to/from ``aws_access_key``. Supplied as - inline plaintext via ``ProviderSecret.plaintext``. + AWS access-key-pair authentication. Set ``access_key_id`` and + ``secret_access_key.plaintext``. Mutually exclusive with + ``service_credential``. region: type: string description: >- @@ -21061,15 +22065,12 @@ components: service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' description: >- - Reference to a UC service credential authorizing Bedrock requests. - On Create the caller supplies ``service_credential.name`` in the - AIP-122 resource-name form ``credentials/{name}``. Required on - Create when using UC-service-credential auth; mutually exclusive - with ``aws_access_key``. The credential is referenced by name; its - value is not carried here. On read the resolved ``id`` and - ``is_deleted`` are also populated. Only supported on AWS-hosted - workspaces; Create requests from other clouds are rejected with - INVALID_PARAMETER_VALUE. + Reference to a Unity Catalog service credential authorizing Bedrock + requests. On Create, supply ``service_credential.name`` in the form + ``credentials/{name}``. Required on Create when using + service-credential authentication; mutually exclusive with + ``aws_access_key``. The credential is referenced by name; its value + is not carried here. Only supported on AWS-hosted workspaces. description: |- Direct form of Amazon Bedrock provider config. @@ -21077,9 +22078,10 @@ components: Create: - Access keys: set ``aws_access_key``, leave ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form - ``credentials/{name}``, leave ``aws_access_key`` unset. The credential value lives in UC and - is referenced by name, not held on this message. Setting more than one mode is rejected. + - Unity Catalog service credential: set ``service_credential.name`` to the resource name + ``credentials/{name}``, leave ``aws_access_key`` unset. The credential value lives in Unity + Catalog and is referenced by name, not held on this message. Setting more than one mode is + rejected. ModelProviderServiceConfigAnthropicProviderConfig: type: object properties: @@ -21087,17 +22089,15 @@ components: $ref: >- #/components/schemas/ModelProviderServiceConfigAnthropicProviderDirectConfig description: >- - Direct (inline-credentials) form: caller supplies the API key in the - request body. Required on Create unless ``relayed`` is set. + Direct authentication with an API key supplied in + ``direct.api_key.plaintext``. Required unless ``relayed`` is set. relayed: $ref: >- #/components/schemas/ModelProviderServiceConfigAnthropicProviderRelayedConfig description: >- - Relayed (credential-less) form: no Anthropic credential is stored. - Each inference request instead carries the caller's own OAuth token, - which the platform forwards to Anthropic on outbound requests. - Mutually exclusive with ``direct``; no ``api_key`` is required or - persisted. + Relayed authentication. Each inference request supplies the caller's + OAuth token, which is forwarded to Anthropic. No Anthropic + credential is stored. Mutually exclusive with ``direct``. description: >- Anthropic provider configuration. Exactly one of ``direct`` or ``relayed`` must be set on @@ -21108,27 +22108,16 @@ components: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Anthropic API key. Required on Create. Sent as the ``x-api-key`` - header on outbound requests. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + Anthropic API key. Required when creating the service. Supply the + value in ``api_key.plaintext``. description: Direct form of Anthropic provider config. ModelProviderServiceConfigAnthropicProviderRelayedConfig: type: object - properties: - plan_type: - $ref: >- - #/components/schemas/ModelProviderServiceConfigAnthropicProviderRelayedConfigAnthropicRelayedPlanType - description: >- - Which Anthropic subscription tier the relayed token belongs to. - Optional; when unset the MPS gets the full governance surface (see - TEAM_ENTERPRISE). Immutable after Create, so the tier cannot be - flipped in place. + properties: {} description: >- - Relayed form of Anthropic provider config: no credential is stored. - Authentication is the - caller's own OAuth token, forwarded to Anthropic on outbound requests, so there is no persisted - secret. Presence of this variant is the signal that the provider service uses relayed auth; - ``plan_type`` further distinguishes which Anthropic subscription tier the token belongs to. + Relayed Anthropic provider configuration. Each inference request + supplies the caller's OAuth + token, which is forwarded to Anthropic. No Anthropic credential is stored. ModelProviderServiceConfigAwsAccessKey: type: object properties: @@ -21141,9 +22130,9 @@ components: secret_access_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - AWS secret access key paired with ``access_key_id``. Required on - Create when using access-key auth. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + AWS secret access key paired with ``access_key_id``. Required when + creating a service with access-key authentication. Supply the value + in ``secret_access_key.plaintext``. description: 'AWS access-key-pair auth for Amazon Bedrock: a SigV4-signing key pair.' ModelProviderServiceConfigAzureOpenAiProviderConfig: type: object @@ -21151,6 +22140,7 @@ components: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigAzureOpenAiProviderDirectConfig + description: Azure OpenAI endpoint and authentication configuration. description: Azure OpenAI provider configuration. ModelProviderServiceConfigAzureOpenAiProviderDirectConfig: type: object @@ -21158,51 +22148,30 @@ components: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Azure OpenAI API key. Mutually exclusive with the Entra and - service-credential modes. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + Azure OpenAI API key. Supply the value in ``api_key.plaintext``. + Mutually exclusive with Entra ID and Unity Catalog service + credential authentication. base_url: type: string description: >- Full Azure OpenAI endpoint base URL, e.g. ``https://myresource.openai.azure.com``. Required on Create. - client_id: - type: string - description: >- - Deprecated flat Entra client ID. Superseded by - ``entra_service_principal.client_id``. Kept for one migration cycle; - the handler mirrors it to/from ``entra_service_principal``. - client_secret: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: >- - Deprecated flat Entra client secret. Superseded by - ``entra_service_principal.client_secret``. Kept for one migration - cycle; the handler mirrors it to/from ``entra_service_principal``. - Supplied as inline plaintext via ``ProviderSecret.plaintext``. entra_service_principal: $ref: '#/components/schemas/ModelProviderServiceConfigEntraServicePrincipal' description: >- - Entra ID (service principal) auth. Mutually exclusive with - ``api_key`` and ``service_credential``. Supersedes the flat - ``tenant_id`` / ``client_id`` / ``client_secret`` fields. + Entra ID service-principal authentication. Set ``tenant_id``, + ``client_id``, and ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' description: >- - Reference to a UC service credential authorizing Azure OpenAI - requests. On Create the caller supplies ``service_credential.name`` - in the AIP-122 resource-name form ``credentials/{name}``. Required - on Create when using UC-service-credential auth; mutually exclusive - with ``api_key`` and ``entra_service_principal``. The credential is - referenced by name; its value is not carried here. On read the - resolved ``id`` and ``is_deleted`` are also populated. Only - supported on Azure-hosted workspaces; Create requests from other - clouds are rejected with INVALID_PARAMETER_VALUE. - tenant_id: - type: string - description: >- - Deprecated flat Entra tenant ID. Superseded by - ``entra_service_principal.tenant_id``. Kept for one migration cycle; - the handler mirrors it to/from ``entra_service_principal``. + Reference to a Unity Catalog service credential authorizing Azure + OpenAI requests. On Create, supply ``service_credential.name`` in + the form ``credentials/{name}``. Required on Create when using + service-credential authentication; mutually exclusive with + ``api_key`` and ``entra_service_principal``. The credential is + referenced by name; its value is not carried here. Only supported on + Azure-hosted workspaces. description: >- Direct form of Azure OpenAI provider config. Exactly one of three mutually-exclusive auth modes @@ -21211,43 +22180,63 @@ components: - API key: set ``api_key``, leave ``entra_service_principal`` and ``service_credential`` unset. - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and ``service_credential`` unset. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form + - Unity Catalog service credential: set ``service_credential.name`` to the resource name ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. + credential value lives in Unity Catalog and is referenced by name, not held on this message. + Only supported on Azure-hosted workspaces. Setting more than one mode is rejected. + ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth: + type: object + properties: + api_key_name: + type: string + description: >- + HTTP header name that carries the API key on outbound requests + (e.g., ``Ocp-Apim-Subscription-Key``). The value forwarded under + this header is supplied via ``api_key_value``. + api_key_value: + $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' + description: >- + Secret value forwarded under the ``api_key_name`` header on outbound + requests. Supplied as inline plaintext via + ``ProviderSecret.plaintext``. + description: >- + Header-based API-key authentication for a custom provider: the secret is + forwarded on outbound + requests under a caller-chosen HTTP header, as ``: ``. ModelProviderServiceConfigCustomProviderConfig: type: object properties: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigCustomProviderDirectConfig - description: >- - Custom provider configuration: arbitrary HTTP endpoint with bearer-token - auth. + description: Endpoint and authentication configuration for the custom provider. + description: Custom OpenAI-compatible provider configuration. ModelProviderServiceConfigCustomProviderDirectConfig: type: object properties: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Bearer token forwarded as the ``Authorization: Bearer ...`` header - on outbound requests. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. Set this for bearer-token auth. + Bearer token forwarded in the ``Authorization`` header. Supply the + value in ``api_key.plaintext``. base_url: type: string description: >- Endpoint URL of the OpenAI-compatible service (e.g., ``https://api.example.com/v1``). Required on Create. - description: |- - Direct form of custom provider config. - - Authentication is one of two mutually exclusive modes, exactly one of which must be supplied on - Create: - - - Bearer: set ``api_key``, leave ``header_auth`` unset. The secret is forwarded as - ``Authorization: Bearer ``. - - Header: set ``header_auth``, leave ``api_key`` unset. The secret is forwarded as - ``: ``. Setting both modes or neither mode is rejected. + header_auth: + $ref: >- + #/components/schemas/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth + description: >- + Header-based API-key auth: the secret is forwarded on outbound + requests under a caller-chosen HTTP header rather than as an + ``Authorization`` bearer token. Set this instead of ``api_key`` for + header auth. + description: >- + Direct form of a custom provider configuration. Set ``api_key`` to send + the secret as an + ``Authorization`` bearer token, or ``header_auth`` to forward it under a caller-chosen HTTP + header. ModelProviderServiceConfigEntraServicePrincipal: type: object properties: @@ -21257,23 +22246,23 @@ components: client_secret: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Entra ID client secret. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + Entra ID client secret. Supply the value in + ``client_secret.plaintext``. tenant_id: type: string description: Entra ID (Azure AD) tenant ID. Required on Create. description: >- - Entra ID (Azure AD) service-principal auth: AI Gateway exchanges the - ``tenant_id`` + - ``client_id`` identify the service principal, and the ``credential`` oneof proves that identity, - exchanged for an Entra bearer token on outbound requests via the OAuth2 client-credentials - grant. Shared by the Azure OpenAI and Microsoft Foundry provider configs. + Entra ID (Azure AD) service-principal authentication. The ``tenant_id`` + and ``client_id`` + identify the service principal, and ``client_secret`` authenticates it. AI Gateway exchanges + these credentials for an Entra bearer token for requests to Azure OpenAI or Microsoft Foundry. ModelProviderServiceConfigGeminiEnterpriseProviderConfig: type: object properties: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig + description: Gemini Enterprise project, region, and authentication configuration. description: Gemini Enterprise provider configuration. ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig: type: object @@ -21281,8 +22270,8 @@ components: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Google Gemini Enterprise API key. Required on Create. Supplied as - inline plaintext via ``ProviderSecret.plaintext``. + Google Gemini Enterprise API key. Required when creating the + service. Supply the value in ``api_key.plaintext``. project_id: type: string description: >- @@ -21293,13 +22282,27 @@ components: description: >- GCP region of the Gemini Enterprise endpoint (e.g., ``us-central1``). Required on Create. - description: Direct form of Gemini Enterprise provider config. + service_credential: + $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' + description: >- + Reference to a Unity Catalog service credential authorizing Gemini + Enterprise requests. On Create, supply ``service_credential.name`` + as ``credentials/{name}``; required when using service-credential + authentication and mutually exclusive with ``api_key``. The + credential is referenced by name; its value is not carried here. On + read, the resolved ``id`` and ``is_deleted`` are also populated. + Supported only on GCP-hosted workspaces. + description: >- + Direct Gemini Enterprise provider configuration. An API key is required + when creating the + service. ModelProviderServiceConfigMicrosoftFoundryProviderConfig: type: object properties: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig + description: Microsoft Foundry endpoint and authentication configuration. description: Microsoft Foundry provider configuration. ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig: type: object @@ -21307,49 +22310,28 @@ components: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - Microsoft AI Foundry API key. Mutually exclusive with the Entra and - service-credential modes. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + Microsoft Foundry API key. Supply the value in + ``api_key.plaintext``. Mutually exclusive with Entra ID and Unity + Catalog service credential authentication. base_url: type: string - description: Microsoft AI Foundry endpoint URL. Required on Create. - client_id: - type: string - description: >- - Deprecated flat Entra client ID. Superseded by - ``entra_service_principal.client_id``. Kept for one migration cycle; - the handler mirrors it to/from ``entra_service_principal``. - client_secret: - $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' - description: >- - Deprecated flat Entra client secret. Superseded by - ``entra_service_principal.client_secret``. Kept for one migration - cycle; the handler mirrors it to/from ``entra_service_principal``. - Supplied as inline plaintext via ``ProviderSecret.plaintext``. + description: Microsoft Foundry endpoint URL. Required on Create. entra_service_principal: $ref: '#/components/schemas/ModelProviderServiceConfigEntraServicePrincipal' description: >- - Entra ID (service principal) auth. Mutually exclusive with - ``api_key`` and ``service_credential``. Supersedes the flat - ``tenant_id`` / ``client_id`` / ``client_secret`` fields. + Entra ID service-principal authentication. Set ``tenant_id``, + ``client_id``, and ``client_secret.plaintext``. Mutually exclusive + with ``api_key`` and ``service_credential``. service_credential: $ref: '#/components/schemas/ModelProviderServiceConfigServiceCredential' description: >- - Reference to a UC service credential authorizing Microsoft Foundry - requests. On Create the caller supplies ``service_credential.name`` - in the AIP-122 resource-name form ``credentials/{name}``. Required - on Create when using UC-service-credential auth; mutually exclusive - with ``api_key`` and ``entra_service_principal``. The credential is - referenced by name; its value is not carried here. On read the - resolved ``id`` and ``is_deleted`` are also populated. Only - supported on Azure-hosted workspaces; Create requests from other - clouds are rejected with INVALID_PARAMETER_VALUE. - tenant_id: - type: string - description: >- - Deprecated flat Entra tenant ID. Superseded by - ``entra_service_principal.tenant_id``. Kept for one migration cycle; - the handler mirrors it to/from ``entra_service_principal``. + Reference to a Unity Catalog service credential authorizing + Microsoft Foundry requests. On Create, supply + ``service_credential.name`` in the form ``credentials/{name}``. + Required on Create when using service-credential authentication; + mutually exclusive with ``api_key`` and ``entra_service_principal``. + The credential is referenced by name; its value is not carried here. + Only supported on Azure-hosted workspaces. description: |- Direct form of Microsoft Foundry provider config. @@ -21360,41 +22342,52 @@ components: - Entra ID (service principal): set ``entra_service_principal``, leave ``api_key`` and ``service_credential`` unset. AI Gateway exchanges these for an Entra bearer token on outbound requests via the OAuth2 client-credentials grant. - - UC service credential: set ``service_credential.name`` to the AIP-122 resource-name form + - Unity Catalog service credential: set ``service_credential.name`` to the resource name ``credentials/{name}``, leave ``api_key`` and ``entra_service_principal`` unset. The - credential value lives in UC and is referenced by name, not held on this message. Only - supported on Azure-hosted workspaces. Setting more than one mode is rejected. + credential value lives in Unity Catalog and is referenced by name, not held on this message. + Only supported on Azure-hosted workspaces. Setting more than one mode is rejected. ModelProviderServiceConfigModelTargetConfig: type: object properties: model: type: string description: >- - Provider-side model identifier (e.g. "gpt-5", "claude-opus-4-7"). - This is a string on the LLM provider's side, not a UC entity. The UC - governance hook for external destinations is the - ModelProviderService referenced by - ``ExternalModelConfig.model_provider_service``, not the model - itself. + Provider-side model identifier, such as ``gpt-5`` or + ``claude-opus-4-7``. This identifies a model at the upstream + provider; it is not a Unity Catalog model resource. + endpoint_route: + type: string + description: >- + Relative path appended to a custom provider's ``base_url`` for this + model, such as ``serve/openai/chat``. Nonempty values are only + supported for custom model provider service targets; other provider + types reject them. Model service destinations do not support this + field. Do not include URI templates, queries, or fragments. When + empty, ``base_url`` is used unchanged. native_api_types: type: array items: type: string description: >- - Provider-native API types the model supports (e.g. - "openai/v1/chat/completions"). Used by the platform for - request/response translation from the unified API type. At most 64 - entries of at most 256 characters each; the list is persisted into - the destination binding's bounded storage envelope. + Provider-native API types supported by this model, such as + ``openai/v1/chat/completions``. A model provider service target + requires at least one value. A model service destination may omit + the list to use the matching provider service target's types when + available. AI Gateway uses the selected types for translation. At + most 64 entries of 256 characters each are allowed. required: - model - description: Model target configuration for an external model destination. + description: >- + Model target configuration shared by model provider service targets and + external model + destinations on model services. ModelProviderServiceConfigOpenAiProviderConfig: type: object properties: direct: $ref: >- #/components/schemas/ModelProviderServiceConfigOpenAiProviderDirectConfig + description: OpenAI configuration with an API key supplied in the request. description: OpenAI provider configuration. ModelProviderServiceConfigOpenAiProviderDirectConfig: type: object @@ -21402,8 +22395,8 @@ components: api_key: $ref: '#/components/schemas/ModelProviderServiceConfigProviderSecret' description: >- - OpenAI API key. Required on Create. Supplied as inline plaintext via - ``ProviderSecret.plaintext``. + OpenAI API key. Required when creating the service. Supply the value + in ``api_key.plaintext``. base_url: type: string description: >- @@ -21416,6 +22409,19 @@ components: Optional OpenAI organization ID. When set, the platform forwards it as the ``OpenAI-Organization`` header. description: Direct (inline-credentials) form of the OpenAI provider config. + ModelProviderServiceConfigProviderPricingConfig: + type: object + properties: + default_discount_basis_points: + type: integer + description: >- + Provider-wide adjustment to external-model spend estimates in basis + points: 2000 = 20% off; -2000 = a 20% markup. Negative values have + no lower bound beyond the int32 range. Values cannot exceed 10000 + (100% off). An omitted value or zero leaves the estimate unchanged. + description: >- + Pricing adjustments applied to this provider service's external-model + spend estimates. ModelProviderServiceConfigProviderSecret: type: object properties: @@ -21423,69 +22429,85 @@ components: type: string description: >- Inline plaintext credential. INPUT_ONLY: the value never round-trips - on reads. Get and List responses omit ``plaintext``; the field's - presence in the read shape only indicates that a secret is + on reads. Get and List responses omit ``plaintext``; the enclosing + secret object remains present to indicate that a secret is configured. + secret_reference: + $ref: '#/components/schemas/ModelProviderServiceConfigSecretReference' + description: >- + Reference to a customer-owned UC Secret that carries this secret + value. The value is read at invoke time under the model provider + service owner's access and is never copied onto the model provider + service, so rotating the UC Secret takes effect with no change to + the model provider service. On Create, supply + ``secret_reference.name`` as + ``secrets/{catalog}.{schema}.{secret}``. description: >- A secret value supplied as part of an inline provider config. The caller supplies the value as inline ``plaintext`` on writes; the platform stores it encrypted. The ``plaintext`` field is ``INPUT_ONLY`` and never round-trips on reads. + ModelProviderServiceConfigSecretReference: + type: object + properties: + name: + type: string + description: >- + Resource name of the bound UC Secret, in the form + ``secrets/{catalog}.{schema}.{secret}``. On Create the caller + supplies the name here. On read it reflects the secret's current + name at read time. + required: + - name + description: >- + Reference to a customer-owned UC Secret backing a secret-bearing + provider field, in the + ``ProviderSecret.secret_reference`` arm. ModelProviderServiceConfigServiceCredential: type: object properties: name: type: string description: >- - Resource name of the bound UC service credential, in the AIP-122 - form ``credentials/{name}`` (a metastore-level single-part - credential name). On create the caller supplies the name here. On - read it reflects the credential's current name at read time. + Resource name of the bound Unity Catalog service credential, in the + form ``credentials/{name}``. Supply this field when creating the + service or rebinding its credential. On read, it reflects the + credential's current name. required: - name description: >- - ---- Provider configuration (nested; see the ``provider`` oneof below) - ---- The customer-owned - UC service credential a ModelProviderService uses to authenticate to its provider, referenced by - name. + The customer-owned Unity Catalog service credential a model provider + service uses to + authenticate to its provider, referenced by name. ModelService: type: object properties: - browse_only: - type: boolean - description: >- - Whether the caller sees only metadata available through the BROWSE - privilege. comment: type: string description: User-provided description. config: $ref: '#/components/schemas/ModelServiceConfig' description: >- - Operational configuration: destinations, routing, rate limits, - inference table. Required on CreateModelService; on - UpdateModelService it is required only when ``config`` (or a - ``config.*`` subpath) appears in ``update_mask``. + Destinations, routing, rate limits, and payload logging + configuration. Required on Create. On Update, provide this field + when ``update_mask`` contains ``config`` or one of its subpaths. create_time: type: string format: date-time - description: When the model service was created. + description: Time the model service was created. created_by: type: string description: Creator identity. effective_owner: type: string - description: >- - The resolved owner of the ModelService. Falls back to the caller's - identity when ``owner`` is not explicitly set on creation. + description: Owner of the model service. etag: type: string description: >- - Optimistic concurrency control token. Server-generated from the - entity's state and returned on every read. To use it as an if-match - precondition on a mutation, echo the last-read value back via the - dedicated ``etag`` field on the Update / Delete request; the server - rejects the mutation if the stored etag differs. + Optimistic concurrency token returned on every read. To make an + Update or Delete conditional, pass the last-read value in that + request's ``etag`` field. In REST responses, this value is a base64 + string; URL-encode it when setting the ``etag`` query parameter. metastore_id: type: string description: Metastore hosting the model service. @@ -21497,38 +22519,33 @@ components: ``{...}`` component is capped at 255 characters individually. Server-derived on Create from ``parent`` + ``model_service_id``; required and immutable on Update/Get/Delete. - owner: - type: string - description: >- - The owner of the model service. Write-only; read owner via - effective_owner. supported_api_types: type: array items: type: string description: >- - Unified API types this endpoint supports (e.g. "chat", "embeddings", - "completions"). Derived from the destinations' backing models / + API types supported across this service's destinations, such as + ``openai/v1/chat/completions``, ``openai/v1/embeddings``, and + ``mlflow/v1/chat/completions``. Derived from the backing models and providers at read time. update_time: type: string format: date-time - description: When the model service was last modified. + description: Time the model service was last modified. updated_by: type: string description: Identity of the last updater. description: >- A governed AI Gateway endpoint in Unity Catalog that routes inference requests to one or more - model destinations (for example a foundation model or an external LLM reached through a - ModelProviderService). Applies centralized access control, rate limits, guardrails, and auditing - to the traffic it serves. + destinations, such as a Databricks foundation model or an external model reached through a model + provider service. Applies centralized access control, rate limits, and auditing to its traffic. ModelServiceConfig: type: object properties: inference_table: $ref: '#/components/schemas/InferenceTableConfig' - description: Inference table config for payload logging. + description: Inference table configuration for payload logging. rate_limits: type: array items: @@ -21536,7 +22553,7 @@ components: description: Rate limits applied to requests routed through this model service. routing: $ref: '#/components/schemas/ModelServiceConfigRoutingConfig' - description: 'Routing configuration: destinations, routing strategy, and fallback.' + description: 'Routing configuration: destinations and fallback.' description: Operational configuration wrapped around the ModelService resource. ModelServiceConfigDestinationConfig: type: object @@ -21547,28 +22564,39 @@ components: destination_type: $ref: >- #/components/schemas/ModelServiceConfigDestinationConfigDestinationType - description: Backing-model category. Determines which oneof variant is populated. + description: >- + Backing-model category. Provide the matching type-specific + configuration and leave the other type-specific configurations + unset. external_model_config: $ref: '#/components/schemas/ModelServiceConfigExternalModelConfig' + description: >- + Configuration for an external model reached through a model provider + service. is_deleted: type: boolean description: >- - True when the destination's backing UC entity (MODEL for - foundation-model destinations, MODEL_PROVIDER_SERVICE for external - destinations) has been deleted but the destination row still - references it. The dangling destination is surfaced (not silently - dropped) so callers can see the broken routing. Inference traffic - through this destination fails closed (BAD_REQUEST / - FAILED_PRECONDITION). + Whether the destination's backing model or model provider service + has been deleted. The destination remains visible so you can + identify the broken dependency. Requests cannot use this destination + until the backing resource is restored or the destination is + replaced. pay_per_token_config: $ref: '#/components/schemas/ModelServiceConfigPayPerTokenConfig' + description: Configuration for a pay-per-token Databricks foundation model. provisioned_throughput_config: $ref: '#/components/schemas/ModelServiceConfigProvisionedThroughputConfig' + description: >- + Configuration for a provisioned-throughput Databricks foundation + model. traffic_percentage: type: integer description: >- - Share of traffic sent to this destination, 0-100. Optional on - fallback destinations; see FallbackConfig. + Percentage of primary traffic sent to this destination, from 0 to + 100. Required when there is more than one primary destination, in + which case the primary percentages must sum to 100; a single primary + destination receives all traffic. Fallback destinations are ordered + and do not use this field. required: - name - destination_type @@ -21611,19 +22639,19 @@ components: items: $ref: '#/components/schemas/ModelServiceConfigDestinationConfig' description: >- - Ordered list of fallback destinations. Traversal is in list order; - the attempt count is the length of the list. At most 5 are allowed. + Fallback destinations, tried in the listed order. At most 5 are + allowed. description: >- - Fallback routing, applied after the primary destination returns a - retryable error. Traversal is - in list order; the attempt count is the length of the list. + Fallback routing applied after a primary destination fails. Fallback + destinations are tried in + the listed order. ModelServiceConfigPayPerTokenConfig: type: object properties: model: type: string description: >- - Resource name of the UC model. Format: + Resource name of the Unity Catalog model. Format: ``models/{catalog}.{schema}.{model}``. required: - model @@ -21638,11 +22666,12 @@ components: type: string description: >- Name of the backing Model Serving endpoint serving the provisioned- - throughput foundation model, as the AIP-122 typed resource name - ``serving-endpoints/{name}``. The same UC model can be served on - multiple Model Serving endpoints (different throughput / region / - config); the caller picks which one this destination routes to. The - endpoint must exist at create time. + throughput foundation model, in the form + ``serving-endpoints/{name}``. The same Unity Catalog model can be + served on multiple Model Serving endpoints with different + throughput, regions, or configurations. The caller selects the + endpoint to which this destination routes. The endpoint must exist + at create time. model: type: string description: >- @@ -21665,37 +22694,20 @@ components: $ref: '#/components/schemas/ModelServiceConfigDestinationConfig' description: >- Primary routing destinations. At most 10 are allowed. At least one - is required on CreateModelService; on UpdateModelService it is - required only when ``config.routing`` (or a ``config.routing.*`` - subpath) appears in ``update_mask``. + is required on Create. On Update, provide this list when replacing + the full ``config`` or updating ``config.routing.destinations``; + other granular routing updates do not require resending + destinations. The intermediate ``config.routing`` mask path is not + supported. fallback: $ref: '#/components/schemas/ModelServiceConfigFallbackConfig' - description: Fallback routing config, applied after primary destinations fail. - first_token_timeout: - type: string - description: >- - Timeout for the first token of a streaming response. If a - destination does not return its first token within this duration, AI - Gateway aborts the attempt and fails over to the next destination. - Applies to streaming requests only. Leave unset for no first-token - timeout. - traffic_splitting: - $ref: '#/components/schemas/ModelServiceConfigRoutingConfigTrafficSplitting' description: >- - Marker message selecting request-based traffic splitting. Traffic is - distributed according to each destination's traffic_percentage - value; no configuration lives on this message itself. + Fallback routing applied after a primary destination fails. Fallback + destinations are tried in the listed order. description: >- - Routing configuration for a model service, nesting destinations, routing - strategy, and fallback - under a single sub-message. - ModelServiceConfigRoutingConfigTrafficSplitting: - type: object - properties: {} - description: >- - Marker message selecting request-based traffic splitting across primary - destinations. Split - weights are read from each DestinationConfig.traffic_percentage. + Routing configuration for a model service, nesting destinations and + fallback under a single + sub-message. ModelVersionInfo: type: object properties: @@ -22068,43 +23080,6 @@ components: destinations are: "catalog", "external_location", "connection", "credential", and "metastore". The **destination_type** of a **special_destination** is always EMAIL. - OneLakeEventQueue: - type: object - properties: - consumer_group: - type: string - description: >- - Event Hubs consumer group used to consume file events. Defaults to - "$Default" when unset. Recommended for provided_onelake: create a - dedicated consumer group on the Event Hub for file events to avoid - contending with the customer's other consumers. - event_hub_name: - type: string - description: >- - Event Hub entity name within the namespace. Only required for - provided_onelake. - event_hub_url: - type: string - description: >- - The Event Hub URL in the format - https://{namespace}.servicebus.windows.net/{event_hub_name}. - Deprecated: use fully_qualified_namespace + event_hub_name instead. - fully_qualified_namespace: - type: string - description: >- - The fully qualified domain name of the Event Hubs namespace, e.g. - {yournamespace}.servicebus.windows.net. Only required for - provided_onelake. - managed_resource_id: - type: string - description: >- - Unique identifier included in the name of the file events managed - resources. - description: >- - File event queue for OneLake (Microsoft Fabric) locations. Events flow - through Fabric - Eventstream in both arms; CSMS consumes from a user-provided Azure Event Hub (provided_onelake) - or from a Fabric Eventstream that CSMS provisions in the user's workspace (managed_onelake). OnlineTable: type: object properties: @@ -22207,11 +23182,6 @@ components: For drop down / radio button selections, UI will want to know the possible input values, it can also be used by other option types to limit input selections. - conditional_display: - $ref: '#/components/schemas/ConditionalDisplay' - description: >- - Conditional display configuration. Specifies when this option should - be hidden based on another option's value. default_value: type: string description: >- @@ -22287,15 +23257,6 @@ components: The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time. - principal_id: - type: integer - description: >- - An opaque internal ID that identifies the principal whose privileges - should be removed. This field is intended for removing privileges - associated with a deleted user. When set, only the entries specified - in the remove field are processed; any entries in the add field will - be rejected. Only one of principal or principal_id should be - specified, never both at the same time. remove: type: array items: @@ -22350,9 +23311,8 @@ components: for_securable_type: $ref: '#/components/schemas/SecurableType' description: >- - Type of securables that the policy should take effect on. Only - ``TABLE`` is supported at this moment. Required on create and - optional on update. + Type of securables that the policy should take effect on. Required + on create and optional on update. policy_type: $ref: '#/components/schemas/PolicyType' description: Type of the policy. Required on create. @@ -22388,6 +23348,13 @@ components: description: >- Optional list of user or group names that should be excluded from the policy. + governed_tags: + type: array + items: + $ref: '#/components/schemas/GovernedTagReference' + description: >- + Governed tag keys and values referenced by this policy's conditions + and function arguments. Output only. grant: $ref: '#/components/schemas/GrantOptions' description: >- @@ -22440,17 +23407,6 @@ components: updated_by: type: string description: Username of the user who last modified the policy. Output only. - use_session_identity: - type: boolean - description: >- - Temporary for migrating customers to session identity. Customers not - currently using ABAC will not be able to set this field to false and - all new policies will have this field default to true. Existing - customers will have this field default to false, but can set it to - true to opt in to session identity. after a grace period, this field - will be removed and all policies will use session identity. Only for - row filter and column mask policies. Not applicable to deny - policies. when_condition: type: string description: Optional condition when the policy should take effect. @@ -22491,11 +23447,6 @@ components: properties: principal: type: string - principal_id: - type: integer - description: >- - Unique identifier of the principal. For active principals, both - ``principal`` and ``principal_id`` are present. privileges: type: array items: @@ -22563,7 +23514,9 @@ components: properties: key: $ref: '#/components/schemas/RateLimitRateLimitKey' - description: Scope key. Determines whether ``principal`` is required. + description: >- + Scope of the rate limit. Depending on this value, the limit applies + to a principal, the service as a whole, or each user by default. renewal_period: $ref: '#/components/schemas/RateLimitRateLimitRenewalPeriod' description: Renewal period. @@ -22571,31 +23524,18 @@ components: type: string description: >- Principal this limit applies to: user email, group name, or service - principal application ID. Required unless ``key`` is - ``RATE_LIMIT_KEY_SERVICE``, ``RATE_LIMIT_KEY_USER_DEFAULT``, or - ``RATE_LIMIT_KEY_REQUEST_TAG`` (which must not set a principal). - request_tag_key: - type: string - description: >- - Request tag key this limit applies to. Required when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``, forbidden otherwise. - request_tag_value: - type: string - description: >- - Request tag value this limit applies to. Only valid when ``key`` is - ``RATE_LIMIT_KEY_REQUEST_TAG``. Leave unset to apply the limit to - every value of ``request_tag_key`` (an any-value default); a set - value is a specific override for that value. + principal application ID. Required when ``key`` applies to a user, + group, or service principal; otherwise it must be unset. requests: type: integer description: >- - Max requests allowed within a renewal period. Leave unset for no - request limit. + Maximum requests allowed in one renewal period. Leave unset for no + request limit. Set to ``0`` to deny all requests. tokens: type: integer description: >- - Max tokens allowed within a renewal period. Leave unset for no token - limit. + Maximum tokens allowed in one renewal period. Leave unset for no + token limit. Set to ``0`` to deny all requests. required: - key - renewal_period @@ -22852,17 +23792,6 @@ components: objects (catalog.schema.secret) that securely store sensitive credential data such as passwords, tokens, and keys. - SecretDependency: - type: object - properties: - secret_full_name: - type: string - description: >- - Full name of the dependent secret, in the form of - **catalog_name**.**schema_name**.**secret_name**. - required: - - secret_full_name - description: A secret that is dependent on a SQL object. Securable: type: object properties: @@ -22920,8 +23849,80 @@ components: securable: $ref: '#/components/schemas/Securable' description: >- - The securable for which the access request destinations are being - requested. + The securable for which the access request destinations are being + requested. + Skill: + type: object + properties: + bundle_name: + type: string + description: >- + Name from the most recently successfully finalized SKILL.md. It may + differ from the final component of the Skill resource name. Unset + until FinalizeSkill succeeds. + comment: + type: string + description: >- + User-provided comment for the skill. Free-text, user-editable via + UpdateSkill (listed in its ``update_mask``). DISTINCT from + ``description``, which is the server-parsed, OUTPUT_ONLY SKILL.md + frontmatter value: ``comment`` is the customer's own annotation and + is preserved across bundle re-uploads. When ``comment`` is in the + update mask, omitting it clears the field, while an explicitly empty + string is retained. + create_time: + type: string + format: date-time + description: Time the skill was created. + created_by: + type: string + description: Creator identity. + description: + type: string + description: >- + Description from the most recently successfully finalized SKILL.md. + Unset until FinalizeSkill succeeds. + effective_owner: + type: string + description: Owner of the skill. + etag: + type: string + description: >- + Optimistic concurrency token returned on every read. To make an + Update or Delete conditional, pass the last-read value in that + request's ``etag`` field. In REST responses, this value is a base64 + string; URL-encode it when setting the ``etag`` query parameter. + finalize_time: + type: string + format: date-time + description: >- + Time of the most recent successful FinalizeSkill. Unset until one + succeeds. + metastore_id: + type: string + description: Metastore hosting the skill. + name: + type: string + description: >- + Resource name of the skill. Format: + ``skills/{catalog}.{schema}.{skill}``. Each ``{...}`` component is + capped at 255 characters individually. Server-derived on Create from + ``parent`` + ``skill_id``; required and immutable on + Update/Get/Delete. + update_time: + type: string + format: date-time + description: >- + Time of the most recent Skill metadata mutation. Uploading bundle + files alone does not change this value. + updated_by: + type: string + description: Identity of the last updater. + description: >- + A Skill is an agentskills.io bundle registered in Unity Catalog. Clients + transfer bundle bytes + through the Files API. FinalizeSkill reads the uploaded SKILL.md and projects its frontmatter + onto the Skill metadata. SseEncryptionDetails: type: object properties: @@ -23192,11 +24193,10 @@ components: items: $ref: '#/components/schemas/PolicyFunctionArgument' description: >- - The list of additional table columns or literals to be passed as - additional arguments to a row filter function. This is the - replacement of the deprecated input_column_names field and carries - information about the types (alias or constant) of the arguments to - the filter function. + The list of table columns or literals to be passed as additional + arguments to a row filter function, carrying the type (column + reference vs constant literal) of each argument. Deprecated: use + input_column_names instead. required: - function_name - input_column_names @@ -23277,16 +24277,6 @@ components: Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE or the ONLINE_NO_PENDING_UPDATE state. - UcEncryptedToken: - type: object - properties: - encrypted_payload: - type: string - description: Stores encrypted ScopedCloudToken as a base64-encoded string - description: >- - Encrypted token used when we cannot downscope the cloud provider token - appropriately See: - https://docs.google.com/document/d/1hEKDnSckuU5PIS798CtfqBElrMR6OJuR2wgz_BjhMSY UnassignResponse: type: object properties: {} @@ -23450,17 +24440,6 @@ components: result: $ref: '#/components/schemas/ValidationResultResult' description: The results of the tested operation. - VolumeDependency: - type: object - properties: - volume_full_name: - type: string - description: >- - Full name of the dependent volume, in the form of - **catalog_name**.**schema_name**.**volume_name**. - required: - - volume_full_name - description: A volume that is dependent on a SQL object. VolumeInfo: type: object properties: @@ -23529,18 +24508,6 @@ components: description: One of READ_WRITE/READ_ONLY. Default is READ_WRITE. required: - workspace_id - AgentServiceAgentServiceType: - type: string - x-enum: - - AGENT_SERVICE_TYPE_EXTERNAL - description: >- - Type of agent service. Determines how the backing agent surface is - provisioned and how - - invocation routes to the runtime. Nested to scope enum values - (guardrail: - - avoid-generic-enum-names). ArtifactType: type: string x-enum: @@ -23553,7 +24520,6 @@ components: x-enum: - ISOLATED - OPEN - - OPEN_IN_ACCOUNT description: |- Create a collection of name/value pairs. @@ -23612,7 +24578,6 @@ components: - DATE - DECIMAL - DOUBLE - - FILE - FLOAT - GEOGRAPHY - GEOMETRY @@ -23624,9 +24589,7 @@ components: - SHORT - STRING - STRUCT - - TABLEREF_TYPE - TABLE_TYPE - - TIME - TIMESTAMP - TIMESTAMP_NTZ - USER_DEFINED_TYPE @@ -23671,136 +24634,39 @@ components: ConnectionType: type: string x-enum: - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AMPLITUDE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - - BIGLAKE + - AWS_SECRETS_MANAGER + - AZURE_KEY_VAULT - BIGQUERY - - CERIDIAN_DAYFORCE - CONFLUENCE - DATABRICKS - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - GITHUB - - GITLAB - GLUE - - GMAIL - - GONG - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - - GOOGLE_CLOUD_LAKEHOUSE - - GOOGLE_WORKSPACE - - GURU - - HIBOB - HIVE_METASTORE - HTTP - HUBSPOT - - ICEBERG_REST - - IRONCLAD - JDBC - - KINESIS - - LINEAR - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - - NOTION + - NETSUITE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - OUTLOOK - - PAGERDUTY - - PALANTIR - - PARTNERSTACK - - PENDO - POSTGRESQL - POWER_BI - - PUBSUB - - QUICKBOOKS - REDSHIFT - SALESFORCE - SALESFORCE_DATA_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - SMARTSHEET - - SNAPCHAT_ADS - SNOWFLAKE - - SPLUNK - SQLDW - SQLSERVER - - SQUARE - TERADATA + - TIKTOK_ADS - UNKNOWN_CONNECTION_TYPE - - VERKADA - WORKDAY_RAAS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - ConversionInfoState: - type: string - x-enum: - - COMPLETED - - IN_PROGRESS description: |- Create a collection of name/value pairs. @@ -24053,11 +24919,7 @@ components: - ANY_STATIC_CREDENTIAL - BEARER_TOKEN - EDGEGRID_AKAMAI - - GENERIC_TOKEN_EXCHANGE - - INLINE_YAML - OAUTH_ACCESS_TOKEN - - OAUTH_DCR - - OAUTH_GOOGLE_SERVICE_ACCOUNT - OAUTH_M2M - OAUTH_MTLS - OAUTH_REFRESH_TOKEN @@ -24226,48 +25088,6 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - DrReplicationStatus: - type: string - x-enum: - - DR_REPLICATION_STATUS_PRIMARY - - DR_REPLICATION_STATUS_SECONDARY - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. EffectivePredictiveOptimizationFlagInheritedFromType: @@ -24610,7 +25430,6 @@ components: x-enum: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN - - ISOLATION_MODE_OPEN_IN_ACCOUNT description: |- Create a collection of name/value pairs. @@ -24697,12 +25516,12 @@ components: - FULL description: >- Controls which fields are populated on each McpService in the response. - The server treats unset + The server uses - / VIEW_UNSPECIFIED as BASIC. Callers needing the full configuration must - request it explicitly + ``BASIC`` when ``view`` is unset. Callers needing the full configuration + must request it - with ``view = FULL``. + explicitly with ``view = FULL``. ListModelProviderServicesRequestView: type: string x-enum: @@ -24712,7 +25531,7 @@ components: Controls which fields are populated on each ModelProviderService in the response. The server - treats unset / VIEW_UNSPECIFIED as BASIC. Callers needing the full + uses ``BASIC`` when ``view`` is unset. Callers needing the full configuration must request it explicitly with ``view = FULL``. @@ -24723,10 +25542,10 @@ components: - FULL description: >- Controls which fields are populated on each ModelService in the - response. The server treats + response. The server uses - unset / VIEW_UNSPECIFIED as BASIC. Callers needing the full - configuration must request it + ``BASIC`` when ``view`` is unset. Callers needing the full configuration + must request it explicitly with ``view = FULL``. MatchType: @@ -24734,28 +25553,13 @@ components: x-enum: - PREFIX_MATCH description: The artifact pattern matching type - ModelProviderServiceConfigAnthropicProviderRelayedConfigAnthropicRelayedPlanType: - type: string - x-enum: - - ANTHROPIC_RELAYED_PLAN_TYPE_MAX - - ANTHROPIC_RELAYED_PLAN_TYPE_TEAM_ENTERPRISE - description: >- - Which Anthropic subscription tier the relayed OAuth token belongs to. - Immutable after Create - - (switching tiers changes which governance controls the platform - enforces). Only MAX and - - TEAM_ENTERPRISE differ in the governance surface the gateway can - enforce, not in how the token - - is relayed. ModelProviderServiceConfigExternalModelProviderType: type: string x-enum: - EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK - EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC - EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI + - EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE - EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM - EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE - EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY @@ -25038,7 +25842,6 @@ components: - OPTION_MULTILINE_STRING - OPTION_NUMBER - OPTION_SERVICE_CREDENTIAL - - OPTION_STORAGE_CREDENTIAL - OPTION_STRING description: >- Type of the option, we purposely follow JavaScript types so that the UI @@ -25186,70 +25989,42 @@ components: - APPLY_TAG - BROWSE - CREATE - - CREATE_CASE_COLLECTION - CREATE_CATALOG - CREATE_CLEAN_ROOM - CREATE_CONNECTION - - CREATE_DATASOURCE - CREATE_EXTERNAL_LOCATION - CREATE_EXTERNAL_TABLE - CREATE_EXTERNAL_VOLUME - - CREATE_FEATURE - - CREATE_FLOW - CREATE_FOREIGN_CATALOG - CREATE_FOREIGN_SECURABLE - CREATE_FUNCTION - CREATE_MANAGED_STORAGE - CREATE_MATERIALIZED_VIEW - - CREATE_MEMORY_STORE - CREATE_MODEL - CREATE_PROVIDER - CREATE_RECIPIENT - - CREATE_RULE - CREATE_SCHEMA - - CREATE_SEMANTIC_GRAPH - - CREATE_SERVICE - CREATE_SERVICE_CREDENTIAL - CREATE_SHARE - - CREATE_SKILL - CREATE_STORAGE_CREDENTIAL - - CREATE_STREAM - CREATE_TABLE - CREATE_VIEW - CREATE_VOLUME - - DELETE - - DELETE_EVENTS - - DELETE_SECURITY_DATA - EXECUTE - EXECUTE_CLEAN_ROOM_TASK + - EXTERNAL_USE_LOCATION - EXTERNAL_USE_SCHEMA - - INSERT - - INSERT_SECURITY_DATA - MANAGE - - MANAGE_ACCESS - - MANAGE_ACCESS_CONTROL - MANAGE_ALLOWLIST - - MANAGE_GRANTS - MODIFY - MODIFY_CLEAN_ROOM - - READ_EVENTS - - READ_FEATURE - READ_FILES - - READ_FLOW - - READ_MEMORY_STORE - READ_METADATA - READ_PRIVATE_FILES - - READ_SECURITY_DATA - - READ_SEMANTIC_GRAPH - - READ_SKILL - - READ_STREAM - READ_VOLUME - REFRESH - SELECT - SET_SHARE_PERMISSION - - UPDATE - - UPDATE_EVENTS - - UPDATE_SECURITY_DATA - USAGE - USE_CATALOG - USE_CONNECTION @@ -25258,16 +26033,8 @@ components: - USE_RECIPIENT - USE_SCHEMA - USE_SHARE - - USE_VOLUME - - VIEW_ADMIN_METADATA - - VIEW_METADATA - - VIEW_OBJECT - WRITE_FILES - - WRITE_FLOW - - WRITE_MEMORY_STORE - WRITE_PRIVATE_FILES - - WRITE_SEMANTIC_GRAPH - - WRITE_SKILL - WRITE_VOLUME description: |- Create a collection of name/value pairs. @@ -25355,7 +26122,6 @@ components: RateLimitRateLimitKey: type: string x-enum: - - RATE_LIMIT_KEY_REQUEST_TAG - RATE_LIMIT_KEY_SERVICE - RATE_LIMIT_KEY_SERVICE_PRINCIPAL - RATE_LIMIT_KEY_USER @@ -25368,33 +26134,9 @@ components: - RATE_LIMIT_RENEWAL_PERIOD_HOUR - RATE_LIMIT_RENEWAL_PERIOD_MINUTE description: Renewal period for a rate limit. - SchemaFilterType: - type: string - x-enum: - - SCHEMA_FILTER_TYPE_EXCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE - - SCHEMA_FILTER_TYPE_INCLUDE_ALL - description: Determines how a FOREIGN catalog's schema filter items are interpreted. SecurableKind: type: string x-enum: - - CATALOG_FOREIGN_BIGLAKE - - CATALOG_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - - CATALOG_FOREIGN_ICEBERG_REST - - CONNECTION_BIGLAKE_SERVICE_ACCOUNT - - CONNECTION_COMMUNITY_OAUTH_M2M - - CONNECTION_COMMUNITY_OAUTH_U2M - - CONNECTION_COMMUNITY_OAUTH_U2M_MAPPING - - CONNECTION_GOOGLE_CLOUD_LAKEHOUSE_OAUTH_U2M - - CONNECTION_GOOGLE_CLOUD_LAKEHOUSE_SERVICE_ACCOUNT - - CONNECTION_ICEBERG_REST_BEARER_TOKEN - - CONNECTION_ICEBERG_REST_OAUTH_M2M - - RECIPIENT_EMAIL - - RECIPIENT_EMAIL_DATABRICKS - - RECIPIENT_EMAIL_TOKEN - - SCHEMA_FOREIGN_BIGLAKE - - SCHEMA_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - - SCHEMA_FOREIGN_ICEBERG_REST - TABLE_DB_STORAGE - TABLE_DELTA - TABLE_DELTASHARING @@ -25413,12 +26155,10 @@ components: - TABLE_EXTERNAL - TABLE_FEATURE_STORE - TABLE_FEATURE_STORE_EXTERNAL - - TABLE_FOREIGN_BIGLAKE - TABLE_FOREIGN_BIGQUERY - TABLE_FOREIGN_DATABRICKS - TABLE_FOREIGN_DELTASHARING - TABLE_FOREIGN_DELTA_DELTASHARING - - TABLE_FOREIGN_GOOGLE_CLOUD_LAKEHOUSE - TABLE_FOREIGN_HIVE_METASTORE - TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL - TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED @@ -25430,12 +26170,10 @@ components: - TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL - TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED - TABLE_FOREIGN_HIVE_METASTORE_VIEW - - TABLE_FOREIGN_ICEBERG_REST - TABLE_FOREIGN_MONGODB - TABLE_FOREIGN_MYSQL - TABLE_FOREIGN_NETSUITE - TABLE_FOREIGN_ORACLE - - TABLE_FOREIGN_PALANTIR - TABLE_FOREIGN_POSTGRESQL - TABLE_FOREIGN_REDSHIFT - TABLE_FOREIGN_SALESFORCE @@ -25504,6 +26242,7 @@ components: SecurableType: type: string x-enum: + - AGENT_SERVICE - CATALOG - CLEAN_ROOM - CONNECTION @@ -25511,12 +26250,17 @@ components: - EXTERNAL_LOCATION - EXTERNAL_METADATA - FUNCTION + - MCP_SERVICE - METASTORE + - MODEL + - MODEL_PROVIDER_SERVICE + - MODEL_SERVICE - PIPELINE - PROVIDER - RECIPIENT - SCHEMA - SHARE + - SKILL - STAGING_TABLE - STORAGE_CREDENTIAL - TABLE @@ -25895,67 +26639,105 @@ components: ``credentials_common.proto``. x-stackQL-resources: - ai_gateway_agent_services: - id: databricks_workspace.catalog.ai_gateway_agent_services - name: ai_gateway_agent_services - title: Ai Gateway Agent Services + ai_gateway_mcp_services: + id: databricks_workspace.catalog.ai_gateway_mcp_services + name: ai_gateway_mcp_services + title: Ai Gateway Mcp Services methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1agent-services/post' + $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1agent-services/get' + $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.mcp_services + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.agent_services sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/ai_gateway_agent_services/methods/list + #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/get + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/ai_gateway_agent_services/methods/create - update: [] - delete: [] + #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/delete replace: [] - ai_gateway_mcp_services: - id: databricks_workspace.catalog.ai_gateway_mcp_services - name: ai_gateway_mcp_services - title: Ai Gateway Mcp Services + ai_gateway_mcp_service_user_credentials: + id: databricks_workspace.catalog.ai_gateway_mcp_service_user_credentials + name: ai_gateway_mcp_service_user_credentials + title: Ai Gateway Mcp Service User Credentials methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services/post' + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}~1user-credentials/post response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1mcp-services/get' + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}~1user-credentials/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1mcp-services~1{full_name}~1user-credentials/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.mcp_services sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/list + #/components/x-stackQL-resources/ai_gateway_mcp_service_user_credentials/methods/get insert: - $ref: >- - #/components/x-stackQL-resources/ai_gateway_mcp_services/methods/create + #/components/x-stackQL-resources/ai_gateway_mcp_service_user_credentials/methods/create update: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_mcp_service_user_credentials/methods/delete replace: [] ai_gateway_model_provider_services: id: databricks_workspace.catalog.ai_gateway_model_provider_services @@ -25978,15 +26760,45 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.model_provider_services + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1model-provider-services~1{full_name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1model-provider-services~1{full_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1model-provider-services~1{full_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_model_provider_services/methods/get - $ref: >- #/components/x-stackQL-resources/ai_gateway_model_provider_services/methods/list insert: - $ref: >- #/components/x-stackQL-resources/ai_gateway_model_provider_services/methods/create - update: [] - delete: [] + update: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_model_provider_services/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/ai_gateway_model_provider_services/methods/delete replace: [] ai_gateway_model_services: id: databricks_workspace.catalog.ai_gateway_model_services @@ -26011,13 +26823,14 @@ components: objectKey: $.model_services delete: operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1{name}/delete' + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1model-services~1{full_name}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1{name}/get' + $ref: '#/paths/~1api~12.1~1unity-catalog~1model-services~1{full_name}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -26026,7 +26839,8 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1unity-catalog~1{name}/patch' + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1model-services~1{full_name}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -26046,6 +26860,66 @@ components: - $ref: >- #/components/x-stackQL-resources/ai_gateway_model_services/methods/delete replace: [] + ai_gateway_skills: + id: databricks_workspace.catalog.ai_gateway_skills + name: ai_gateway_skills + title: Ai Gateway Skills + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1skills/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1skills/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.skills + delete: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1skills~1{full_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1skills~1{full_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.1~1unity-catalog~1skills~1{full_name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + finalize: + operation: + $ref: >- + #/paths/~1api~12.1~1unity-catalog~1skills~1{full_name}~1finalize/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ai_gateway_skills/methods/get' + - $ref: '#/components/x-stackQL-resources/ai_gateway_skills/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/ai_gateway_skills/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/ai_gateway_skills/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/ai_gateway_skills/methods/delete' + replace: [] artifact_allowlists: id: databricks_workspace.catalog.artifact_allowlists name: artifact_allowlists diff --git a/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml index 8f1f1b74..eee25ed7 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.cleanrooms servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type.value}/{name}/revisions/{etag}: get: @@ -211,289 +228,272 @@ paths: schema: type: object properties: - asset: + name: + type: string + description: >- + A fully qualified name that uniquely identifies the asset + within the clean room. This is also the name displayed in + the clean room UI. For UC securable assets (tables, volumes, + etc.), the format is + *shared_catalog*.*shared_schema*.*asset_name* For notebooks, + the name is the notebook file name. For jar analyses, the + name is the jar analysis name. For Genie spaces, the name is + derived from the clean room; the caller does not choose it. + asset_type: + type: string + x-enum: + - FOREIGN_TABLE + - JAR_ANALYSIS + - NOTEBOOK_FILE + - TABLE + - VIEW + - VOLUME + description: The type of the asset. + added_at: + type: integer + description: >- + When the asset is added to the clean room, in epoch + milliseconds. + clean_room_name: + type: string + description: >- + The name of the clean room this asset belongs to. This field + is required for create operations and populated by the + server for responses. + foreign_table: type: object properties: - name: + columns: type: string - description: >- - A fully qualified name that uniquely identifies the - asset within the clean room. This is also the name - displayed in the clean room UI. For UC securable assets - (tables, volumes, etc.), the format is - *shared_catalog*.*shared_schema*.*asset_name* For - notebooks, the name is the notebook file name. For jar - analyses, the name is the jar analysis name. - asset_type: + description: >- + Foreign table details available to all collaborators of the + clean room. Present if and only if **asset_type** is + **FOREIGN_TABLE** + foreign_table_local_details: + type: object + properties: + local_name: type: string - x-enum: - - FOREIGN_TABLE - - GENIE_SPACE - - JAR_ANALYSIS - - NOTEBOOK_FILE - - TABLE - - VIEW - - VOLUME - description: The type of the asset. - added_at: - type: integer - description: >- - When the asset is added to the clean room, in epoch - milliseconds. - clean_room_name: + required: + - local_name + description: >- + Local details for a foreign that are only available to its + owner. Present if and only if **asset_type** is + **FOREIGN_TABLE** + jar_analysis: + type: object + properties: + central_jar_file_paths: + type: array + items: + type: string + description: type: string description: >- - The name of the clean room this asset belongs to. This - field is required for create operations and populated by - the server for responses. - foreign_table: - type: object - properties: - columns: - type: string + Optional description of the jar analysis shown to all + collaborators. + environment_version: + type: string description: >- - Foreign table details available to all collaborators of - the clean room. Present if and only if **asset_type** is - **FOREIGN_TABLE** - foreign_table_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name + The serverless environment version used to execute the + JAR analysis (e.g. "4"). If not specified, uses the + service-configured JAR analysis default. + etag: + type: string description: >- - Local details for a foreign that are only available to - its owner. Present if and only if **asset_type** is - **FOREIGN_TABLE** - genie_space: - type: object - properties: {} + Server generated etag that represents the jar analysis + version. + main_class_name: + type: string description: >- - Genie space details. The space_id sub-field is only - returned to the owner; other fields (e.g. - prompts_limit_per_day) are visible to all collaborators. - Present if and only if **asset_type** is **GENIE_SPACE** - jar_analysis: - type: object - properties: - central_jar_file_paths: - type: array - items: + The full name of the class containing the main method to + be executed. This class must be contained in a JAR + provided as a library The code must use + ``SparkContext.getOrCreate`` to obtain a Spark context; + otherwise, runs of the job fail + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: Top-level status derived from all reviews. + reviews: + type: array + items: + type: object + properties: + comment: type: string - description: - type: string - description: >- - Optional description of the jar analysis shown to - all collaborators. - environment_version: - type: string - description: >- - The serverless environment version used to execute - the JAR analysis (e.g. "4"). Defaults to - "4-scala-preview" if not specified. - etag: - type: string - description: >- - Server generated etag that represents the jar - analysis version. - main_class_name: - type: string - description: >- - The full name of the class containing the main - method to be executed. This class must be contained - in a JAR provided as a library The code must use - ``SparkContext.getOrCreate`` to obtain a Spark - context; otherwise, runs of the job fail - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Top-level status derived from all reviews. - reviews: - type: array - items: - type: object - properties: - comment: - type: string - description: review comment - created_at_millis: - type: integer - description: timestamp of when the review was submitted - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: review outcome - review_sub_reason: - type: string - x-enum: - - AUTO_APPROVED - description: >- - specified when the review was not explicitly - made by a user - reviewer_collaborator_alias: - type: string - description: collaborator alias of the reviewer + description: review comment + created_at_millis: + type: integer + description: timestamp of when the review was submitted + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: review outcome + review_sub_reason: + type: string + x-enum: + - AUTO_APPROVED description: >- - This only applies to a JAR Analysis as a - first-class asset in the Clean Room, and not to - Volumes - description: All existing approvals or rejections. - runner_collaborator_aliases: - type: array - items: + specified when the review was not explicitly made + by a user + reviewer_collaborator_alias: type: string - description: Collaborators that can run the jar. + description: collaborator alias of the reviewer + description: >- + This only applies to a JAR Analysis as a first-class + asset in the Clean Room, and not to Volumes + description: All existing approvals or rejections. + runner_collaborator_aliases: + type: array + items: + type: string + description: Collaborators that can run the jar. + description: >- + Jar analysis details available to all collaborators of the + clean room. Present if and only if **asset_type** is + **JAR_ANALYSIS** + notebook: + type: object + properties: + notebook_content: + type: string + description: + type: string description: >- - Jar analysis details available to all collaborators of - the clean room. Present if and only if **asset_type** is - **JAR_ANALYSIS** - notebook: - type: object - properties: - notebook_content: - type: string - description: - type: string - description: >- - Optional description of the notebook shown to all - collaborators. - environment_version: - type: string - description: >- - The serverless environment version used to execute - the notebook (e.g. "4"). Defaults to "2" if not - specified. - etag: - type: string - description: >- - Server generated etag that represents the notebook - version. - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Top-level status derived from all reviews - reviews: - type: array - items: - type: object - properties: - comment: - type: string - created_at_millis: - type: integer - description: >- - When the review was submitted, in epoch - milliseconds - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Review outcome - review_sub_reason: - type: string - x-enum: - - AUTO_APPROVED - - BACKFILLED - description: >- - Specified when the review was not explicitly - made by a user - reviewer_collaborator_alias: - type: string - description: Collaborator alias of the reviewer - description: All existing approvals or rejections - runner_collaborator_aliases: - type: array - items: - type: string - description: Aliases of collaborators that can run the notebook. - required: - - notebook_content + Optional description of the notebook shown to all + collaborators. + environment_version: + type: string description: >- - Notebook details available to all collaborators of the - clean room. Present if and only if **asset_type** is - **NOTEBOOK_FILE** - owner_collaborator_alias: + The serverless environment version used to execute the + notebook (e.g. "4"). Defaults to "2" if not specified. + etag: type: string - description: The alias of the collaborator who owns this asset - status: + description: >- + Server generated etag that represents the notebook + version. + review_state: type: string x-enum: - - ACTIVE + - APPROVED - PENDING - - PERMISSION_DENIED - description: Status of the asset - table: - type: object - properties: - columns: - type: string - description: >- - Table details available to all collaborators of the - clean room. Present if and only if **asset_type** is - **TABLE** - table_local_details: - type: object - properties: - local_name: - type: string - partitions: - type: string - description: >- - Partition filtering specification for a shared - table. - required: - - local_name - description: >- - Local details for a table that are only available to its - owner. Present if and only if **asset_type** is - **TABLE** - view: - type: object - properties: - columns: - type: string - description: >- - View details available to all collaborators of the clean - room. Present if and only if **asset_type** is **VIEW** - view_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name - description: >- - Local details for a view that are only available to its - owner. Present if and only if **asset_type** is **VIEW** - volume_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name - description: >- - Local details for a volume that are only available to - its owner. Present if and only if **asset_type** is - **VOLUME** + - REJECTED + description: Top-level status derived from all reviews + reviews: + type: array + items: + type: object + properties: + comment: + type: string + created_at_millis: + type: integer + description: >- + When the review was submitted, in epoch + milliseconds + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: Review outcome + review_sub_reason: + type: string + x-enum: + - AUTO_APPROVED + - BACKFILLED + description: >- + Specified when the review was not explicitly made + by a user + reviewer_collaborator_alias: + type: string + description: Collaborator alias of the reviewer + description: All existing approvals or rejections + runner_collaborator_aliases: + type: array + items: + type: string + description: Aliases of collaborators that can run the notebook. + required: + - notebook_content + description: >- + Notebook details available to all collaborators of the clean + room. Present if and only if **asset_type** is + **NOTEBOOK_FILE** + owner_collaborator_alias: + type: string + description: The alias of the collaborator who owns this asset + status: + type: string + x-enum: + - ACTIVE + - PENDING + - PERMISSION_DENIED + description: Status of the asset + table: + type: object + properties: + columns: + type: string + description: >- + Table details available to all collaborators of the clean + room. Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: string + description: Partition filtering specification for a shared table. + required: + - local_name + description: >- + Local details for a table that are only available to its + owner. Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** + view: + type: object + properties: + columns: + type: string + description: >- + View details available to all collaborators of the clean + room. Present if and only if **asset_type** is **VIEW** or + **METRIC_VIEW** + view_local_details: + type: object + properties: + local_name: + type: string + required: + - local_name + description: >- + Local details for a view that are only available to its + owner. Present if and only if **asset_type** is **VIEW** or + **METRIC_VIEW** + volume_local_details: + type: object + properties: + local_name: + type: string required: - - name - - asset_type - description: Metadata of the clean room asset + - local_name + description: >- + Local details for a volume that are only available to its + owner. Present if and only if **asset_type** is **VOLUME** required: - - asset + - name + - asset_type responses: '200': description: Success @@ -608,7 +608,6 @@ paths: type: string x-enum: - FOREIGN_TABLE - - GENIE_SPACE - JAR_ANALYSIS - NOTEBOOK_FILE - TABLE @@ -818,7 +817,7 @@ paths: *shared_catalog*.*shared_schema*.*asset_name* For notebooks, the name is the notebook file name. For jar analyses, the name is the jar analysis - name. + name. For Genie spaces, the name is derived from the clean room; the caller does not choose it. :param asset: :class:`CleanRoomAsset` The asset to update. The asset's ``name`` and ``asset_type`` fields are used to identify the asset to update. @@ -847,310 +846,281 @@ paths: For UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name* For notebooks, the name is the notebook file name. For jar analyses, the name is the - jar analysis name. + jar analysis name. For Genie spaces, the name is derived from the + clean room; the caller does not choose it. requestBody: content: application/json: schema: type: object properties: + name: + type: string + description: >- + A fully qualified name that uniquely identifies the asset + within the clean room. This is also the name displayed in + the clean room UI. For UC securable assets (tables, volumes, + etc.), the format is + *shared_catalog*.*shared_schema*.*asset_name* For notebooks, + the name is the notebook file name. For jar analyses, the + name is the jar analysis name. For Genie spaces, the name is + derived from the clean room; the caller does not choose it. asset_type: type: string x-enum: - FOREIGN_TABLE - - GENIE_SPACE - JAR_ANALYSIS - NOTEBOOK_FILE - TABLE - VIEW - VOLUME description: The type of the asset. - asset: + added_at: + type: integer + description: >- + When the asset is added to the clean room, in epoch + milliseconds. + clean_room_name: + type: string + description: >- + The name of the clean room this asset belongs to. This field + is required for create operations and populated by the + server for responses. + foreign_table: type: object properties: - name: + columns: + type: string + description: >- + Foreign table details available to all collaborators of the + clean room. Present if and only if **asset_type** is + **FOREIGN_TABLE** + foreign_table_local_details: + type: object + properties: + local_name: + type: string + required: + - local_name + description: >- + Local details for a foreign that are only available to its + owner. Present if and only if **asset_type** is + **FOREIGN_TABLE** + jar_analysis: + type: object + properties: + central_jar_file_paths: + type: array + items: + type: string + description: type: string description: >- - A fully qualified name that uniquely identifies the - asset within the clean room. This is also the name - displayed in the clean room UI. For UC securable assets - (tables, volumes, etc.), the format is - *shared_catalog*.*shared_schema*.*asset_name* For - notebooks, the name is the notebook file name. For jar - analyses, the name is the jar analysis name. - asset_type: + Optional description of the jar analysis shown to all + collaborators. + environment_version: type: string - x-enum: - - FOREIGN_TABLE - - GENIE_SPACE - - JAR_ANALYSIS - - NOTEBOOK_FILE - - TABLE - - VIEW - - VOLUME - description: The type of the asset. - added_at: - type: integer description: >- - When the asset is added to the clean room, in epoch - milliseconds. - clean_room_name: + The serverless environment version used to execute the + JAR analysis (e.g. "4"). If not specified, uses the + service-configured JAR analysis default. + etag: type: string description: >- - The name of the clean room this asset belongs to. This - field is required for create operations and populated by - the server for responses. - foreign_table: - type: object - properties: - columns: - type: string + Server generated etag that represents the jar analysis + version. + main_class_name: + type: string description: >- - Foreign table details available to all collaborators of - the clean room. Present if and only if **asset_type** is - **FOREIGN_TABLE** - foreign_table_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name + The full name of the class containing the main method to + be executed. This class must be contained in a JAR + provided as a library The code must use + ``SparkContext.getOrCreate`` to obtain a Spark context; + otherwise, runs of the job fail + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: Top-level status derived from all reviews. + reviews: + type: array + items: + type: object + properties: + comment: + type: string + description: review comment + created_at_millis: + type: integer + description: timestamp of when the review was submitted + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: review outcome + review_sub_reason: + type: string + x-enum: + - AUTO_APPROVED + description: >- + specified when the review was not explicitly made + by a user + reviewer_collaborator_alias: + type: string + description: collaborator alias of the reviewer + description: >- + This only applies to a JAR Analysis as a first-class + asset in the Clean Room, and not to Volumes + description: All existing approvals or rejections. + runner_collaborator_aliases: + type: array + items: + type: string + description: Collaborators that can run the jar. + description: >- + Jar analysis details available to all collaborators of the + clean room. Present if and only if **asset_type** is + **JAR_ANALYSIS** + notebook: + type: object + properties: + notebook_content: + type: string + description: + type: string description: >- - Local details for a foreign that are only available to - its owner. Present if and only if **asset_type** is - **FOREIGN_TABLE** - genie_space: - type: object - properties: {} + Optional description of the notebook shown to all + collaborators. + environment_version: + type: string description: >- - Genie space details. The space_id sub-field is only - returned to the owner; other fields (e.g. - prompts_limit_per_day) are visible to all collaborators. - Present if and only if **asset_type** is **GENIE_SPACE** - jar_analysis: - type: object - properties: - central_jar_file_paths: - type: array - items: + The serverless environment version used to execute the + notebook (e.g. "4"). Defaults to "2" if not specified. + etag: + type: string + description: >- + Server generated etag that represents the notebook + version. + review_state: + type: string + x-enum: + - APPROVED + - PENDING + - REJECTED + description: Top-level status derived from all reviews + reviews: + type: array + items: + type: object + properties: + comment: type: string - description: - type: string - description: >- - Optional description of the jar analysis shown to - all collaborators. - environment_version: - type: string - description: >- - The serverless environment version used to execute - the JAR analysis (e.g. "4"). Defaults to - "4-scala-preview" if not specified. - etag: - type: string - description: >- - Server generated etag that represents the jar - analysis version. - main_class_name: - type: string - description: >- - The full name of the class containing the main - method to be executed. This class must be contained - in a JAR provided as a library The code must use - ``SparkContext.getOrCreate`` to obtain a Spark - context; otherwise, runs of the job fail - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Top-level status derived from all reviews. - reviews: - type: array - items: - type: object - properties: - comment: - type: string - description: review comment - created_at_millis: - type: integer - description: timestamp of when the review was submitted - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: review outcome - review_sub_reason: - type: string - x-enum: - - AUTO_APPROVED - description: >- - specified when the review was not explicitly - made by a user - reviewer_collaborator_alias: - type: string - description: collaborator alias of the reviewer + created_at_millis: + type: integer description: >- - This only applies to a JAR Analysis as a - first-class asset in the Clean Room, and not to - Volumes - description: All existing approvals or rejections. - runner_collaborator_aliases: - type: array - items: + When the review was submitted, in epoch + milliseconds + review_state: type: string - description: Collaborators that can run the jar. - description: >- - Jar analysis details available to all collaborators of - the clean room. Present if and only if **asset_type** is - **JAR_ANALYSIS** - notebook: - type: object - properties: - notebook_content: - type: string - description: - type: string - description: >- - Optional description of the notebook shown to all - collaborators. - environment_version: - type: string - description: >- - The serverless environment version used to execute - the notebook (e.g. "4"). Defaults to "2" if not - specified. - etag: - type: string - description: >- - Server generated etag that represents the notebook - version. - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Top-level status derived from all reviews - reviews: - type: array - items: - type: object - properties: - comment: - type: string - created_at_millis: - type: integer - description: >- - When the review was submitted, in epoch - milliseconds - review_state: - type: string - x-enum: - - APPROVED - - PENDING - - REJECTED - description: Review outcome - review_sub_reason: - type: string - x-enum: - - AUTO_APPROVED - - BACKFILLED - description: >- - Specified when the review was not explicitly - made by a user - reviewer_collaborator_alias: - type: string - description: Collaborator alias of the reviewer - description: All existing approvals or rejections - runner_collaborator_aliases: - type: array - items: + x-enum: + - APPROVED + - PENDING + - REJECTED + description: Review outcome + review_sub_reason: type: string - description: Aliases of collaborators that can run the notebook. - required: - - notebook_content - description: >- - Notebook details available to all collaborators of the - clean room. Present if and only if **asset_type** is - **NOTEBOOK_FILE** - owner_collaborator_alias: + x-enum: + - AUTO_APPROVED + - BACKFILLED + description: >- + Specified when the review was not explicitly made + by a user + reviewer_collaborator_alias: + type: string + description: Collaborator alias of the reviewer + description: All existing approvals or rejections + runner_collaborator_aliases: + type: array + items: + type: string + description: Aliases of collaborators that can run the notebook. + required: + - notebook_content + description: >- + Notebook details available to all collaborators of the clean + room. Present if and only if **asset_type** is + **NOTEBOOK_FILE** + owner_collaborator_alias: + type: string + description: The alias of the collaborator who owns this asset + status: + type: string + x-enum: + - ACTIVE + - PENDING + - PERMISSION_DENIED + description: Status of the asset + table: + type: object + properties: + columns: type: string - description: The alias of the collaborator who owns this asset - status: + description: >- + Table details available to all collaborators of the clean + room. Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** + table_local_details: + type: object + properties: + local_name: + type: string + partitions: + type: string + description: Partition filtering specification for a shared table. + required: + - local_name + description: >- + Local details for a table that are only available to its + owner. Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** + view: + type: object + properties: + columns: + type: string + description: >- + View details available to all collaborators of the clean + room. Present if and only if **asset_type** is **VIEW** or + **METRIC_VIEW** + view_local_details: + type: object + properties: + local_name: type: string - x-enum: - - ACTIVE - - PENDING - - PERMISSION_DENIED - description: Status of the asset - table: - type: object - properties: - columns: - type: string - description: >- - Table details available to all collaborators of the - clean room. Present if and only if **asset_type** is - **TABLE** - table_local_details: - type: object - properties: - local_name: - type: string - partitions: - type: string - description: >- - Partition filtering specification for a shared - table. - required: - - local_name - description: >- - Local details for a table that are only available to its - owner. Present if and only if **asset_type** is - **TABLE** - view: - type: object - properties: - columns: - type: string - description: >- - View details available to all collaborators of the clean - room. Present if and only if **asset_type** is **VIEW** - view_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name - description: >- - Local details for a view that are only available to its - owner. Present if and only if **asset_type** is **VIEW** - volume_local_details: - type: object - properties: - local_name: - type: string - required: - - local_name - description: >- - Local details for a volume that are only available to - its owner. Present if and only if **asset_type** is - **VOLUME** required: - - name - - asset_type + - local_name description: >- - The asset to update. The asset's ``name`` and ``asset_type`` - fields are used to identify the asset to update. + Local details for a view that are only available to its + owner. Present if and only if **asset_type** is **VIEW** or + **METRIC_VIEW** + volume_local_details: + type: object + properties: + local_name: + type: string + required: + - local_name + description: >- + Local details for a volume that are only available to its + owner. Present if and only if **asset_type** is **VOLUME** required: + - name + - asset_type - asset_type - - asset responses: '200': description: Success @@ -1421,43 +1391,35 @@ paths: schema: type: object properties: - auto_approval_rule: - type: object - properties: - author_collaborator_alias: - type: string - author_scope: - type: string - x-enum: - - ANY_AUTHOR - description: >- - Scope of authors covered by the rule. Only one of - ``author_collaborator_alias`` and ``author_scope`` can - be set. - clean_room_name: - type: string - description: >- - The name of the clean room this auto-approval rule - belongs to. - created_at: - type: integer - description: >- - Timestamp of when the rule was created, in epoch - milliseconds. - rule_id: - type: string - description: A generated UUID identifying the rule. - rule_owner_collaborator_alias: - type: string - description: The owner of the rule to whom the rule applies. - runner_collaborator_alias: - type: string - description: Collaborator alias of the runner covered by the rule. + author_collaborator_alias: + type: string + author_scope: + type: string + x-enum: + - ANY_AUTHOR description: >- - The auto-approval rule to update. The rule_id field is used - to identify the rule to update. - required: - - auto_approval_rule + Scope of authors covered by the rule. Only one of + ``author_collaborator_alias`` and ``author_scope`` can be + set. + clean_room_name: + type: string + description: >- + The name of the clean room this auto-approval rule belongs + to. + created_at: + type: integer + description: >- + Timestamp of when the rule was created, in epoch + milliseconds. + rule_id: + type: string + description: A generated UUID identifying the rule. + rule_owner_collaborator_alias: + type: string + description: The owner of the rule to whom the rule applies. + runner_collaborator_alias: + type: string + description: Collaborator alias of the runner covered by the rule. responses: '200': description: Success @@ -1645,396 +1607,347 @@ paths: The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the metastore. - - :param clean_room: :class:`CleanRoom` - - - :returns: - Long-running operation waiter for :class:`CleanRoom`. - See :method:wait_get_clean_room_active for more details. - requestBody: - content: - application/json: - schema: - type: object - properties: - clean_room: - type: object - properties: - access_restricted: - type: string - x-enum: - - CSP_MISMATCH - - NO_RESTRICTION - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members can - have their own - - attributes -- see the documentation for details. - comment: - type: string - created_at: - type: integer - description: When the clean room was created, in epoch milliseconds. - enable_shared_output: - type: boolean - description: >- - Whether allow task to write to shared output schema. - When enabled, clean room task runs triggered by the - current collaborator can write to the run-scoped shared - output schema which is accessible by all collaborators. - local_collaborator_alias: - type: string - description: >- - The alias of the collaborator tied to the local clean - room. - name: - type: string - description: >- - The name of the clean room. It should follow `UC - securable naming requirements - `__. - output_catalog: - type: object - properties: - catalog_name: - type: string - status: - type: string - x-enum: - - CREATED - - NOT_CREATED - - NOT_ELIGIBLE - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members - can have their own - - attributes -- see the documentation for details. - description: >- - Output catalog of the clean room. It is an output only - field. Output catalog is manipulated using the separate - CreateCleanRoomOutputCatalog API. - owner: - type: string - description: >- - This is the Databricks username of the owner of the - local clean room securable for permission management. - remote_detailed_info: - type: object - properties: - central_clean_room_id: - type: string - description: Central clean room ID. - cloud_vendor: - type: string - description: >- - Cloud vendor (aws,azure,gcp) of the central clean - room. - collaborators: - type: array - items: - type: object - properties: - collaborator_alias: - type: string - description: >- - Collaborator alias specified by the clean room - creator. It is unique across all collaborators - of this clean room, and used to derive - multiple values internally such as catalog - alias and clean room name for single metastore - clean rooms. It should follow `UC securable - naming requirements - `__. - display_name: - type: string - description: >- - Generated display name for the collaborator. - In the case of a single metastore clean room, - it is the clean room name. For x-metastore - clean rooms, it is the organization name of - the metastore. It is not restricted to these - values and could change in the future - global_metastore_id: - type: string - description: >- - The global Unity Catalog metastore ID of the - collaborator. The identifier is of format - cloud:region:metastore-uuid. - invite_recipient_email: - type: string - description: >- - Email of the user who is receiving the clean - room "invitation". It should be empty for the - creator of the clean room, and non-empty for - the invitees of the clean room. It is only - returned in the output when clean room creator - calls GET - invite_recipient_workspace_id: - type: integer - description: >- - Workspace ID of the user who is receiving the - clean room "invitation". Must be specified if - invite_recipient_email is specified. It should - be empty when the collaborator is the creator - of the clean room. - organization_name: - type: string - description: >- - [Organization - name](:method:metastores/list#metastores-delta_sharing_organization_name) - configured in the metastore - required: - - collaborator_alias - description: Publicly visible clean room collaborator. - description: >- - Collaborators in the central clean room. There - should one and only one collaborator in the list - that satisfies the owner condition: 1. It has the - creator's global_metastore_id (determined by caller - of CreateCleanRoom). 2. Its invite_recipient_email - is empty. - compliance_security_profile: - type: object - properties: - compliance_standards: - type: string - description: >- - The list of compliance standards that the - compliance security profile is configured to - enforce. - is_enabled: - type: boolean - description: >- - Whether the compliance security profile is - enabled. - description: >- - The compliance security profile used to process - regulated data following compliance standards. - creator: - type: object - properties: - collaborator_alias: - type: string - description: >- - Collaborator alias specified by the clean room - creator. It is unique across all collaborators - of this clean room, and used to derive multiple - values internally such as catalog alias and - clean room name for single metastore clean - rooms. It should follow `UC securable naming - requirements - `__. - display_name: - type: string - description: >- - Generated display name for the collaborator. In - the case of a single metastore clean room, it is - the clean room name. For x-metastore clean - rooms, it is the organization name of the - metastore. It is not restricted to these values - and could change in the future - global_metastore_id: - type: string - description: >- - The global Unity Catalog metastore ID of the - collaborator. The identifier is of format - cloud:region:metastore-uuid. - invite_recipient_email: - type: string - description: >- - Email of the user who is receiving the clean - room "invitation". It should be empty for the - creator of the clean room, and non-empty for the - invitees of the clean room. It is only returned - in the output when clean room creator calls GET - invite_recipient_workspace_id: - type: integer - description: >- - Workspace ID of the user who is receiving the - clean room "invitation". Must be specified if - invite_recipient_email is specified. It should - be empty when the collaborator is the creator of - the clean room. - organization_name: - type: string - description: >- - [Organization - name](:method:metastores/list#metastores-delta_sharing_organization_name) - configured in the metastore - required: - - collaborator_alias - description: Collaborator who creates the clean room. - egress_network_policy: + + :param clean_room: :class:`CleanRoom` + + + :returns: + Long-running operation waiter for :class:`CleanRoom`. + See :method:wait_get_clean_room_active for more details. + requestBody: + content: + application/json: + schema: + type: object + properties: + access_restricted: + type: string + x-enum: + - CSP_MISMATCH + - NO_RESTRICTION + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members + they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + comment: + type: string + created_at: + type: integer + description: When the clean room was created, in epoch milliseconds. + enable_shared_output: + type: boolean + description: >- + Whether allow task to write to shared output schema. When + enabled, clean room task runs triggered by the current + collaborator can write to the run-scoped shared output + schema which is accessible by all collaborators. + local_collaborator_alias: + type: string + description: The alias of the collaborator tied to the local clean room. + name: + type: string + description: >- + The name of the clean room. It should follow `UC securable + naming requirements + `__. + output_catalog: + type: object + properties: + catalog_name: + type: string + status: + type: string + x-enum: + - CREATED + - NOT_CREATED + - NOT_ELIGIBLE + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can + have their own + + attributes -- see the documentation for details. + description: >- + Output catalog of the clean room. It is an output only + field. Output catalog is manipulated using the separate + CreateCleanRoomOutputCatalog API. + owner: + type: string + description: >- + This is the Databricks username of the owner of the local + clean room securable for permission management. + remote_detailed_info: + type: object + properties: + central_clean_room_id: + type: string + description: Central clean room ID. + cloud_vendor: + type: string + description: Cloud vendor (aws,azure,gcp) of the central clean room. + collaborators: + type: array + items: + type: object + properties: + collaborator_alias: + type: string + description: >- + Collaborator alias specified by the clean room + creator. It is unique across all collaborators of + this clean room, and used to derive multiple + values internally such as catalog alias and clean + room name for single metastore clean rooms. It + should follow `UC securable naming requirements + `__. + display_name: + type: string + description: >- + Generated display name for the collaborator. In + the case of a single metastore clean room, it is + the clean room name. For x-metastore clean rooms, + it is the organization name of the metastore. It + is not restricted to these values and could change + in the future + global_metastore_id: + type: string + description: >- + The global Unity Catalog metastore ID of the + collaborator. The identifier is of format + cloud:region:metastore-uuid. + invite_recipient_email: + type: string + description: >- + Email of the user who is receiving the clean room + "invitation". It should be empty for the creator + of the clean room, and non-empty for the invitees + of the clean room. It is only returned in the + output when clean room creator calls GET + invite_recipient_workspace_id: + type: integer + description: >- + Workspace ID of the user who is receiving the + clean room "invitation". Must be specified if + invite_recipient_email is specified. It should be + empty when the collaborator is the creator of the + clean room. + organization_name: + type: string + description: >- + [Organization + name](:method:metastores/list#metastores-delta_sharing_organization_name) + configured in the metastore + required: + - collaborator_alias + description: Publicly visible clean room collaborator. + description: >- + Collaborators in the central clean room. There should + one and only one collaborator in the list that satisfies + the owner condition: 1. It has the creator's + global_metastore_id (determined by caller of + CreateCleanRoom). 2. Its invite_recipient_email is + empty. + compliance_security_profile: + type: object + properties: + compliance_standards: type: string description: >- - Egress network policy to apply to the central clean - room workspace. - enable_shared_output: + The list of compliance standards that the compliance + security profile is configured to enforce. + is_enabled: type: boolean + description: Whether the compliance security profile is enabled. + description: >- + The compliance security profile used to process + regulated data following compliance standards. + creator: + type: object + properties: + collaborator_alias: + type: string description: >- - Whether to enable shared output for the central - clean room. When enabled, clean room task runs can - write to the run-scoped shared output schema which - is accessible by all collaborators. - package_provider_collaborator_alias: + Collaborator alias specified by the clean room + creator. It is unique across all collaborators of + this clean room, and used to derive multiple values + internally such as catalog alias and clean room name + for single metastore clean rooms. It should follow + `UC securable naming requirements + `__. + display_name: type: string description: >- - Alias of the provider collaborator. If set, packaged - clean rooms mode is enabled. The consumer's - experience is restricted: they can view notebook - names and READMEs, add their own data assets, and - trigger runs, but cannot view notebook code, - provider data assets, or notebook run output. - region: + Generated display name for the collaborator. In the + case of a single metastore clean room, it is the + clean room name. For x-metastore clean rooms, it is + the organization name of the metastore. It is not + restricted to these values and could change in the + future + global_metastore_id: type: string - description: Region of the central clean room. - description: >- - Central clean room details. During creation, users need - to specify cloud_vendor, region, and - collaborators.global_metastore_id. This field will not - be filled in the ListCleanRooms call. - replication_config: - type: object - properties: - enabled: - type: boolean description: >- - Whether this collaborator's input share is - replicated into the central clean-room region. - schedule: - type: object - properties: - interval: - type: object - properties: - duration: - type: string - description: >- - How often the collaborator's input-share - data should be replicated. When unset, the - service-default interval applies. - description: Fixed-interval replication schedule. + The global Unity Catalog metastore ID of the + collaborator. The identifier is of format + cloud:region:metastore-uuid. + invite_recipient_email: + type: string + description: >- + Email of the user who is receiving the clean room + "invitation". It should be empty for the creator of + the clean room, and non-empty for the invitees of + the clean room. It is only returned in the output + when clean room creator calls GET + invite_recipient_workspace_id: + type: integer + description: >- + Workspace ID of the user who is receiving the clean + room "invitation". Must be specified if + invite_recipient_email is specified. It should be + empty when the collaborator is the creator of the + clean room. + organization_name: + type: string description: >- - Optional schedule describing when replication runs. - When unset, the service-default schedule (currently - every hour) applies. + [Organization + name](:method:metastores/list#metastores-delta_sharing_organization_name) + configured in the metastore + required: + - collaborator_alias + description: Collaborator who creates the clean room. + egress_network_policy: + type: string description: >- - Replication setting for the calling collaborator's input - share. Set via UpdateCleanRoom before the collaborator - adds their first asset (immutable thereafter), and read - back on GetCleanRoom. When enabled, that collaborator's - input data is replicated into the central clean-room - region. - status: + Egress network policy to apply to the central clean room + workspace. + enable_shared_output: + type: boolean + description: >- + Whether to enable shared output for the central clean + room. When enabled, clean room task runs can write to + the run-scoped shared output schema which is accessible + by all collaborators. + package_provider_collaborator_alias: type: string - x-enum: - - ACTIVE - - DELETED - - FAILED - - PROVISIONING - description: Clean room status. - updated_at: - type: integer description: >- - When the clean room was last updated, in epoch - milliseconds. - required: - - clean_room + Alias of the provider collaborator. If set, packaged + clean rooms mode is enabled. The consumer's experience + is restricted: they can view notebook names and READMEs, + add their own data assets, and trigger runs, but cannot + view notebook code, provider data assets, or notebook + run output. + region: + type: string + description: Region of the central clean room. + description: >- + Central clean room details. During creation, users need to + specify cloud_vendor, region, and + collaborators.global_metastore_id. This field will not be + filled in the ListCleanRooms call. + status: + type: string + x-enum: + - ACTIVE + - DELETED + - FAILED + - PROVISIONING + description: Clean room status. + updated_at: + type: integer + description: When the clean room was last updated, in epoch milliseconds. responses: '200': description: Success @@ -2137,71 +2050,66 @@ paths: schema: type: object properties: - output_catalog: - type: object - properties: - catalog_name: - type: string - status: - type: string - x-enum: - - CREATED - - NOT_CREATED - - NOT_ELIGIBLE - description: >- - Create a collection of name/value pairs. + catalog_name: + type: string + status: + type: string + x-enum: + - CREATED + - NOT_CREATED + - NOT_ELIGIBLE + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many members + they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members can - have their own + Methods can be added to enumerations, and members can have + their own - attributes -- see the documentation for details. - required: - - output_catalog + attributes -- see the documentation for details. responses: '200': description: Success @@ -2670,38 +2578,6 @@ paths: to specify cloud_vendor, region, and collaborators.global_metastore_id. This field will not be filled in the ListCleanRooms call. - replication_config: - type: object - properties: - enabled: - type: boolean - description: >- - Whether this collaborator's input share is - replicated into the central clean-room region. - schedule: - type: object - properties: - interval: - type: object - properties: - duration: - type: string - description: >- - How often the collaborator's input-share - data should be replicated. When unset, the - service-default interval applies. - description: Fixed-interval replication schedule. - description: >- - Optional schedule describing when replication runs. - When unset, the service-default schedule (currently - every hour) applies. - description: >- - Replication setting for the calling collaborator's input - share. Set via UpdateCleanRoom before the collaborator - adds their first asset (immutable thereafter), and read - back on GetCleanRoom. When enabled, that collaborator's - input data is replicated into the central clean-room - region. status: type: string x-enum: @@ -2779,14 +2655,6 @@ components: Central clean room details. During creation, users need to specify cloud_vendor, region, and collaborators.global_metastore_id. This field will not be filled in the ListCleanRooms call. - replication_config: - $ref: '#/components/schemas/ReplicationConfig' - description: >- - Replication setting for the calling collaborator's input share. Set - via UpdateCleanRoom before the collaborator adds their first asset - (immutable thereafter), and read back on GetCleanRoom. When enabled, - that collaborator's input data is replicated into the central - clean-room region. status: $ref: '#/components/schemas/CleanRoomStatusEnum' description: Clean room status. @@ -2804,7 +2672,8 @@ components: For UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name* For notebooks, the name is the notebook file name. For jar analyses, the name is the - jar analysis name. + jar analysis name. For Genie spaces, the name is derived from the + clean room; the caller does not choose it. asset_type: $ref: '#/components/schemas/CleanRoomAssetAssetType' description: The type of the asset. @@ -2827,13 +2696,6 @@ components: description: >- Local details for a foreign that are only available to its owner. Present if and only if **asset_type** is **FOREIGN_TABLE** - genie_space: - $ref: '#/components/schemas/CleanRoomAssetGenieSpace' - description: >- - Genie space details. The space_id sub-field is only returned to the - owner; other fields (e.g. prompts_limit_per_day) are visible to all - collaborators. Present if and only if **asset_type** is - **GENIE_SPACE** jar_analysis: $ref: '#/components/schemas/CleanRoomAssetJarAnalysis' description: >- @@ -2854,22 +2716,24 @@ components: $ref: '#/components/schemas/CleanRoomAssetTable' description: >- Table details available to all collaborators of the clean room. - Present if and only if **asset_type** is **TABLE** + Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** table_local_details: $ref: '#/components/schemas/CleanRoomAssetTableLocalDetails' description: >- Local details for a table that are only available to its owner. - Present if and only if **asset_type** is **TABLE** + Present if and only if **asset_type** is **TABLE** or + **STREAMING_TABLE** view: $ref: '#/components/schemas/CleanRoomAssetView' description: >- View details available to all collaborators of the clean room. - Present if and only if **asset_type** is **VIEW** + Present if and only if **asset_type** is **VIEW** or **METRIC_VIEW** view_local_details: $ref: '#/components/schemas/CleanRoomAssetViewLocalDetails' description: >- Local details for a view that are only available to its owner. - Present if and only if **asset_type** is **VIEW** + Present if and only if **asset_type** is **VIEW** or **METRIC_VIEW** volume_local_details: $ref: '#/components/schemas/CleanRoomAssetVolumeLocalDetails' description: >- @@ -2891,9 +2755,6 @@ components: type: string required: - local_name - CleanRoomAssetGenieSpace: - type: object - properties: {} CleanRoomAssetJarAnalysis: type: object properties: @@ -2908,7 +2769,8 @@ components: type: string description: >- The serverless environment version used to execute the JAR analysis - (e.g. "4"). Defaults to "4-scala-preview" if not specified. + (e.g. "4"). If not specified, uses the service-configured JAR + analysis default. etag: type: string description: Server generated etag that represents the jar analysis version. @@ -3425,52 +3287,6 @@ components: required: - etag - review_state - ReplicationConfig: - type: object - properties: - enabled: - type: boolean - description: >- - Whether this collaborator's input share is replicated into the - central clean-room region. - schedule: - $ref: '#/components/schemas/ReplicationSchedule' - description: >- - Optional schedule describing when replication runs. When unset, the - service-default schedule (currently every hour) applies. - description: >- - Replication setting for a collaborator's input share. When enabled, that - collaborator's input - data is replicated into the central clean-room region so the clean room can run locally against - replicated data instead of reaching across regions to the source. - - This is settable (via UpdateCleanRoom) until the collaborator adds their first asset, and is - immutable thereafter. Copied from (not imported) the managed-catalog share-level - ReplicationConfig. - ReplicationInterval: - type: object - properties: - duration: - type: string - description: >- - How often the collaborator's input-share data should be replicated. - When unset, the service-default interval applies. - description: |- - How often a collaborator's replicated input share is refreshed. - - Copied from (not imported) the managed-catalog share-level ReplicationInterval so the clean-room - API and the Delta Sharing API stay independently evolvable. - ReplicationSchedule: - type: object - properties: - interval: - $ref: '#/components/schemas/ReplicationInterval' - description: Fixed-interval replication schedule. - description: >- - Schedule describing when a collaborator's replicated input share is - refreshed. - - Copied from (not imported) the managed-catalog share-level ReplicationSchedule. CleanRoomAccessRestricted: type: string x-enum: @@ -3517,7 +3333,6 @@ components: type: string x-enum: - FOREIGN_TABLE - - GENIE_SPACE - JAR_ANALYSIS - NOTEBOOK_FILE - TABLE diff --git a/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml index 5bda10d3..285c6a9b 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.compute servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/policies/clusters/create: post: @@ -22,26 +39,9 @@ paths: tags: - compute - cluster_policies - description: >- + description: |- Creates a new policy with prescribed settings. - - :param auto_enforcement_config: :class:`PolicyAutoEnforcementConfig` - (optional) - If present, auto enforcement is enabled for the policy. After the policy is edited, a background - operation may be scheduled to scan and edit all clusters and jobs using this policy to be in - compliance with the policy. - - The background operation is created when a policy edit does one of the following: - - - Changes the policy definition, or - - Changes auto enforcement from disabled to enabled Additionally, changes to the policy definition - or auto enforcement configuration may cause an in-progress operation to be restarted. - - To cancel an in-progress operation, edit the policy to delete this auto enforcement configuration. - - The background operation status is reported via the ``background_enforcement`` field when reading - the policy. :param definition: str (optional) Policy definition document expressed in `Databricks Cluster Policy Definition Language `__. @@ -77,31 +77,6 @@ paths: schema: type: object properties: - auto_enforcement_config: - type: object - properties: - enforce_mode: - type: string - x-enum: - - ENFORCE_IMMEDIATELY - - WAIT_FOR_TERMINATION - description: >- - For running clusters, whether to defer enforcement until - the cluster terminates or to restart it immediately. - description: >- - If present, auto enforcement is enabled for the policy. - After the policy is edited, a background operation may be - scheduled to scan and edit all clusters and jobs using this - policy to be in compliance with the policy. The background - operation is created when a policy edit does one of the - following: - Changes the policy definition, or - Changes - auto enforcement from disabled to enabled Additionally, - changes to the policy definition or auto enforcement - configuration may cause an in-progress operation to be - restarted. To cancel an in-progress operation, edit the - policy to delete this auto enforcement configuration. The - background operation status is reported via the - ``background_enforcement`` field when reading the policy. definition: type: string description: >- @@ -320,22 +295,6 @@ paths: :param policy_id: str The ID of the policy to update. - :param auto_enforcement_config: :class:`PolicyAutoEnforcementConfig` - (optional) - If present, auto enforcement is enabled for the policy. After the policy is edited, a background - operation may be scheduled to scan and edit all clusters and jobs using this policy to be in - compliance with the policy. - - The background operation is created when a policy edit does one of the following: - - - Changes the policy definition, or - - Changes auto enforcement from disabled to enabled Additionally, changes to the policy definition - or auto enforcement configuration may cause an in-progress operation to be restarted. - - To cancel an in-progress operation, edit the policy to delete this auto enforcement configuration. - - The background operation status is reported via the ``background_enforcement`` field when reading - the policy. :param definition: str (optional) Policy definition document expressed in `Databricks Cluster Policy Definition Language `__. @@ -372,31 +331,6 @@ paths: policy_id: type: string description: The ID of the policy to update. - auto_enforcement_config: - type: object - properties: - enforce_mode: - type: string - x-enum: - - ENFORCE_IMMEDIATELY - - WAIT_FOR_TERMINATION - description: >- - For running clusters, whether to defer enforcement until - the cluster terminates or to restart it immediately. - description: >- - If present, auto enforcement is enabled for the policy. - After the policy is edited, a background operation may be - scheduled to scan and edit all clusters and jobs using this - policy to be in compliance with the policy. The background - operation is created when a policy edit does one of the - following: - Changes the policy definition, or - Changes - auto enforcement from disabled to enabled Additionally, - changes to the policy definition or auto enforcement - configuration may cause an in-progress operation to be - restarted. To cancel an in-progress operation, edit the - policy to delete this auto enforcement configuration. The - background operation status is reported via the - ``background_enforcement`` field when reading the policy. definition: type: string description: >- @@ -569,8 +503,6 @@ paths: :param policy_id: str Canonical unique identifier for the Cluster Policy. - :param policy_view: :class:`PolicyView` (optional) - Controls which fields are returned. :returns: :class:`Policy` parameters: @@ -580,12 +512,6 @@ paths: schema: type: string description: Canonical unique identifier for the Cluster Policy. - - name: policy_view - in: query - required: false - schema: - $ref: '#/components/schemas/PolicyView' - description: Controls which fields are returned. responses: '200': description: Success @@ -1045,10 +971,6 @@ paths: :param driver_node_type_id: str (optional) The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as ``node_type_id`` defined above. - - This field, along with node_type_id, should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and - node_type_id take precedence. :param enable_elastic_disk: bool (optional) Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space. @@ -1121,8 +1043,7 @@ paths: private keys can be used to login with the user name ``ubuntu`` on port ``2200``. Up to 10 keys can be specified. :param total_initial_remote_disk_size: int (optional) - If set, what the total initial volume size (in GB) of the remote disks should be. Currently only - supported for GCP HYPERDISK_BALANCED disks. + If set, what the total initial volume size (in GB) of the remote disks should be. Supported for GCP. :param use_ml_runtime: bool (optional) This field can only be used when ``kind = CLASSIC_PREVIEW``. @@ -1607,17 +1528,19 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), + the value is passed to AWS CreateFleet API to create the + EC2 Fleet. description: Flexible node type configuration for the driver node. driver_node_type_id: type: string description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the - same value as ``node_type_id`` defined above. This field, - along with node_type_id, should not be set if - virtual_cluster_size is set. If both driver_node_type_id, - node_type_id, and virtual_cluster_size are specified, - driver_node_type_id and node_type_id take precedence. + same value as ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -1999,8 +1922,7 @@ paths: type: integer description: >- If set, what the total initial volume size (in GB) of the - remote disks should be. Currently only supported for GCP - HYPERDISK_BALANCED disks. + remote disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -2019,6 +1941,12 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), + the value is passed to AWS CreateFleet API to create the + EC2 Fleet. description: Flexible node type configuration for worker nodes. workload_type: type: object @@ -2203,10 +2131,6 @@ paths: :param driver_node_type_id: str (optional) The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as ``node_type_id`` defined above. - - This field, along with node_type_id, should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and - node_type_id take precedence. :param enable_elastic_disk: bool (optional) Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk space when its Spark workers are running low on disk space. @@ -2279,8 +2203,7 @@ paths: private keys can be used to login with the user name ``ubuntu`` on port ``2200``. Up to 10 keys can be specified. :param total_initial_remote_disk_size: int (optional) - If set, what the total initial volume size (in GB) of the remote disks should be. Currently only - supported for GCP HYPERDISK_BALANCED disks. + If set, what the total initial volume size (in GB) of the remote disks should be. Supported for GCP. :param use_ml_runtime: bool (optional) This field can only be used when ``kind = CLASSIC_PREVIEW``. @@ -2758,17 +2681,19 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), + the value is passed to AWS CreateFleet API to create the + EC2 Fleet. description: Flexible node type configuration for the driver node. driver_node_type_id: type: string description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the - same value as ``node_type_id`` defined above. This field, - along with node_type_id, should not be set if - virtual_cluster_size is set. If both driver_node_type_id, - node_type_id, and virtual_cluster_size are specified, - driver_node_type_id and node_type_id take precedence. + same value as ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -3150,8 +3075,7 @@ paths: type: integer description: >- If set, what the total initial volume size (in GB) of the - remote disks should be. Currently only supported for GCP - HYPERDISK_BALANCED disks. + remote disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -3170,6 +3094,12 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), + the value is passed to AWS CreateFleet API to create the + EC2 Fleet. description: Flexible node type configuration for worker nodes. workload_type: type: object @@ -3478,71 +3408,6 @@ paths: message: type: string x-stackql-sdk-source: ClustersAPI - /api/2.1/{name}/diagnostics: - get: - operationId: clusters_get_diagnostic - summary: Returns the most recent cluster diagnostics result for a cluster. - tags: - - compute - - clusters - description: >- - Returns the most recent cluster diagnostics result for a cluster. - - - Cluster diagnostics are a set of environment checks -- for example, - network reachability to the - - control plane, storage, DNS, and the SCC tunnel -- that verify the - cluster's environment is set up - - correctly for the cluster to provision. The checks run automatically - while the cluster is starting, - - once per cluster start, and their results are stored. - - - This method only reads the latest stored result; it does NOT run the - checks. The response reports an - - overall status plus a per-check breakdown (check status, failure reason, - remediation, and - - description). If diagnostics have not run for the cluster, the overall - status is NOT_RUN. - - - :param name: str - The resource name of the cluster whose diagnostics to retrieve. Format: clusters/{cluster_id} - - :returns: :class:`Diagnostic` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: >- - The resource name of the cluster whose diagnostics to retrieve. - Format: clusters/{cluster_id} - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Diagnostic' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: ClustersAPI /api/2.0/permissions/clusters/{cluster_id}/permissionLevels: get: operationId: clusters_get_permission_levels @@ -4844,6 +4709,12 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set + (non-empty), the value is passed to AWS CreateFleet + API to create the EC2 Fleet. description: Flexible node type configuration for the driver node. driver_node_type_id: type: string @@ -4851,11 +4722,6 @@ paths: The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as ``node_type_id`` defined above. - This field, along with node_type_id, should not be set - if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and - virtual_cluster_size are specified, driver_node_type_id - and node_type_id take precedence. enable_elastic_disk: type: boolean description: >- @@ -5254,8 +5120,7 @@ paths: type: integer description: >- If set, what the total initial volume size (in GB) of - the remote disks should be. Currently only supported for - GCP HYPERDISK_BALANCED disks. + the remote disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -5274,6 +5139,12 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set + (non-empty), the value is passed to AWS CreateFleet + API to create the EC2 Fleet. description: Flexible node type configuration for worker nodes. workload_type: type: object @@ -6055,11 +5926,6 @@ paths: - Currently, Databricks allows at most 45 custom tags :param disk_spec: :class:`DiskSpec` (optional) Defines the specification of the disks that will be attached to all spark containers. - :param enable_auto_alternate_node_types: bool (optional) - For pools with node type flexibility (Fleet-V2), whether auto generated alternate node type ids are - enabled. This field should not be true if node_type_flexibility is set. DEPRECATED: This field was - deprecated before entering PuPr and should no longer be used. TODO(CJ-71514): Remove this field - after sufficient time has passed for all clients to migrate. :param enable_elastic_disk: bool (optional) Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space. In AWS, this feature @@ -6126,7 +5992,14 @@ paths: x-enum: - ON_DEMAND - SPOT - description: Availability type used for the spot nodes. + description: >- + Availability type used for the instances in the pool. + Supports on-demand, spot, and spot-with-fallback (the + pool acquires spot instances first, and falls back to + on-demand instances when spot capacity is unavailable). + You can change this value on an existing pool. New + clusters use the updated availability, and existing + clusters keep the availability they launched with. instance_profile_arn: type: string description: >- @@ -6157,7 +6030,9 @@ paths: for this cluster, only spot instances whose bid price percentage matches this field will be considered. Note that, for safety, we enforce this field to be no more - than 10000. + than 10000. You can change this value on an existing + pool. New clusters use the updated bid price, and + existing clusters keep the bid price they launched with. zone_id: type: string description: >- @@ -6170,7 +6045,17 @@ paths: This is an optional field at cluster creation, and if not specified, a default zone will be used. The list of available zones as well as the default value can be - found by using the ``List Zones`` method. + found by using the ``List Zones`` method. Set this field + to "auto" to enable Auto-AZ, in which case Databricks + selects the availability zone for each cluster + independently when the cluster launches, and retries + another zone if the cluster can't be fulfilled because + of insufficient capacity or quota. All nodes in a + cluster land in the same zone, and different clusters + backed by the pool can run in different zones. You can + change the zone on an existing pool. New clusters use + the updated zone, and existing clusters keep the zone + they launched with. description: >- Attributes related to instance pools running on Amazon Web Services. If not specified at pool creation, a set of @@ -6183,7 +6068,14 @@ paths: x-enum: - ON_DEMAND_AZURE - SPOT_AZURE - description: Availability type used for the spot nodes. + description: >- + Availability type used for the instances in the pool. + Supports on-demand, spot, and spot-with-fallback (the + pool acquires spot instances first, and falls back to + on-demand instances when spot capacity is unavailable). + You can change this value on an existing pool. New + clusters use the updated availability, and existing + clusters keep the availability they launched with. capacity_reservation_group: type: string description: >- @@ -6215,6 +6107,9 @@ paths: price. The price for the VM will be the current price for spot or the price for a standard VM, which ever is less, as long as there is capacity and quota available. + You can change this value on an existing pool. New + clusters use the updated max price, and existing + clusters keep the max price they launched with. description: >- Attributes related to instance pools running on Azure. If not specified at pool creation, a set of default values will @@ -6288,16 +6183,6 @@ paths: description: >- Defines the specification of the disks that will be attached to all spark containers. - enable_auto_alternate_node_types: - type: boolean - description: >- - For pools with node type flexibility (Fleet-V2), whether - auto generated alternate node type ids are enabled. This - field should not be true if node_type_flexibility is set. - DEPRECATED: This field was deprecated before entering PuPr - and should no longer be used. TODO(CJ-71514): Remove this - field after sufficient time has passed for all clients to - migrate. enable_elastic_disk: type: boolean description: >- @@ -6317,11 +6202,13 @@ paths: - PREEMPTIBLE_GCP - PREEMPTIBLE_WITH_FALLBACK_GCP description: >- - This field determines whether the instance pool will - contain preemptible VMs, on-demand VMs, or - - preemptible VMs with a fallback to on-demand VMs if the - former is unavailable. + Availability type for the instances in the pool. One of: + - ``ON_DEMAND_GCP``: the pool uses on-demand instances + only. - ``PREEMPTIBLE_GCP``: the pool uses preemptible + instances only. - ``PREEMPTIBLE_WITH_FALLBACK_GCP``: the + pool acquires preemptible instances first, and falls + back to on-demand instances when preemptible capacity is + unavailable. local_ssd_count: type: integer description: >- @@ -6344,12 +6231,21 @@ paths: if not specified, a default zone will be used. This field can be one of the following: - "HA" => High availability, spread nodes across availability zones for - a Databricks deployment region - A GCP availability zone - => Pick One of the available zones for (machine type + - region) from + a Databricks deployment region - "auto" => Auto-AZ. + Databricks selects the availability zone for each + cluster independently when the cluster launches, and + retries another zone if the cluster can't be fulfilled + because of insufficient capacity or quota. All nodes in + a cluster land in the same zone, and different clusters + backed by the pool can run in different zones. - A GCP + availability zone => Pick One of the available zones for + (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. "us-west1-a"). If empty, Databricks picks an - availability zone to schedule the cluster on. + availability zone to schedule the cluster on. You can + change the zone on an existing pool. New clusters use + the updated zone, and existing clusters keep the zone + they launched with. description: >- Attributes related to instance pools running on Google Cloud Platform. If not specified at pool creation, a set of @@ -6387,6 +6283,12 @@ paths: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), + the value is passed to AWS CreateFleet API to create the + EC2 Fleet. description: Flexible node type configuration for the pool. preloaded_docker_images: type: array @@ -6519,11 +6421,6 @@ paths: EBS volumes) with these tags in addition to ``default_tags``. Notes: - Currently, Databricks allows at most 45 custom tags - :param enable_auto_alternate_node_types: bool (optional) - For pools with node type flexibility (Fleet-V2), whether auto generated alternate node type ids are - enabled. This field should not be true if node_type_flexibility is set. DEPRECATED: This field was - deprecated before entering PuPr and should no longer be used. TODO(CJ-71514): Remove this field - after sufficient time has passed for all clients to migrate. :param idle_instance_autotermination_minutes: int (optional) Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met. If not set, the extra pool instances @@ -6574,16 +6471,6 @@ paths: pool resources (e.g., AWS instances and EBS volumes) with these tags in addition to ``default_tags``. Notes: - Currently, Databricks allows at most 45 custom tags - enable_auto_alternate_node_types: - type: boolean - description: >- - For pools with node type flexibility (Fleet-V2), whether - auto generated alternate node type ids are enabled. This - field should not be true if node_type_flexibility is set. - DEPRECATED: This field was deprecated before entering PuPr - and should no longer be used. TODO(CJ-71514): Remove this - field after sufficient time has passed for all clients to - migrate. idle_instance_autotermination_minutes: type: integer description: >- @@ -7306,1003 +7193,168 @@ paths: message: type: string x-stackql-sdk-source: LibrariesAPI - /api/2.0/default-base-environments: + /api/2.0/libraries/install: post: - operationId: libraries_create_default_base_environment + operationId: libraries_install summary: >- - Create a default base environment within workspaces to define the - environment version and a list of + Add libraries to install on a cluster. The installation is asynchronous; + it happens in the background tags: - compute - libraries description: >- - Create a default base environment within workspaces to define the - environment version and a list of - - dependencies to be used in serverless notebooks and jobs. This process - will asynchronously generate a - - cache to optimize dependency resolution. - - - :param default_base_environment: :class:`DefaultBaseEnvironment` + Add libraries to install on a cluster. The installation is asynchronous; + it happens in the background - :param request_id: str (optional) - A unique identifier for this request. A random UUID is recommended. This request is only idempotent - if a ``request_id`` is provided. - :param workspace_base_environment_id: str (optional) + after the completion of this request. - :returns: :class:`DefaultBaseEnvironment` + :param cluster_id: str + Unique identifier for the cluster on which to install these libraries. + :param libraries: List[:class:`Library`] + The libraries to install. requestBody: content: application/json: schema: type: object properties: - default_base_environment: - type: object - properties: - base_environment_cache: - type: array - items: + cluster_id: + type: string + description: >- + Unique identifier for the cluster on which to install these + libraries. + libraries: + type: array + items: + type: object + properties: + cran: type: object properties: - indefinite_materialized_environment: - type: object - properties: - last_updated_timestamp: - type: integer - description: >- - The timestamp (in epoch milliseconds) when the - materialized env is updated. + package: + type: string + repo: + type: string description: >- - Materialized Environment information enables - environment sharing and reuse via Environment - Caching during library installations. Currently this feature is only supported for Python - libraries. - - - If the env cache entry in LMv2 DB doesn't exist or invalid, library installations and - environment materialization will occur. A new Materialized Environment metadata will be sent - from DP upon successful library installations and env materialization, and is persisted into - database by LMv2. - - If the env cache entry in LMv2 DB is valid, the Materialized Environment will be sent to DP by - LMv2, and DP will restore the cached environment from a store instead of reinstalling - libraries from scratch. - - If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto with new version - If changed, also update estore/namespaces/envspecenvironments/latest.proto with new version - materialized_environment: - type: object - properties: - last_updated_timestamp: - type: integer - description: >- - The timestamp (in epoch milliseconds) when the - materialized env is updated. + The repository where the package can be found. If + not specified, the default CRAN repo is used. + required: + - package + egg: + type: string + 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. + jar: + type: string + description: >- + URI of the JAR library to install. Supported URIs + include Workspace paths, Unity Catalog Volumes paths, + and S3 URIs. For example: ``{ "jar": + "/Workspace/path/to/library.jar" }``, ``{ "jar" : + "/Volumes/path/to/library.jar" }`` or ``{ "jar": + "s3://my-bucket/library.jar" }``. If S3 is used, + please make sure the cluster has read access on the + library. You may need to launch the cluster with an + IAM role to access the S3 URI. + maven: + type: object + properties: + coordinates: + type: string + exclusions: + type: array + items: + type: string + description: >- + List of dependences to exclude. For example: + ``["slf4j:slf4j", "*:hadoop-client"]``. Maven + dependency exclusions: + https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. + repo: + type: string description: >- - Materialized Environment information enables - environment sharing and reuse via Environment - Caching during library installations. Currently this feature is only supported for Python - libraries. - - - If the env cache entry in LMv2 DB doesn't exist or invalid, library installations and - environment materialization will occur. A new Materialized Environment metadata will be sent - from DP upon successful library installations and env materialization, and is persisted into - database by LMv2. - - If the env cache entry in LMv2 DB is valid, the Materialized Environment will be sent to DP by - LMv2, and DP will restore the cached environment from a store instead of reinstalling - libraries from scratch. - - If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto with new version - If changed, also update estore/namespaces/envspecenvironments/latest.proto with new version - message: + Maven repo to install the Maven package from. If + omitted, both Maven Central Repository and Spark + Packages are searched. + required: + - coordinates + description: >- + Specification of a maven library to be installed. For + example: ``{ "coordinates": "org.jsoup:jsoup:1.7.2" + }`` + pypi: + type: object + properties: + package: type: string - status: + repo: type: string - x-enum: - - CREATED - - EXPIRED - - FAILED - - INVALID - - PENDING - - REFRESHING description: >- - Create a collection of name/value pairs. - - - Example enumeration: - + The repository where the package can be found. If + not specified, the default pip index is used. + required: + - package + description: >- + Specification of a PyPi library to be installed. For + example: ``{ "package": "simplejson" }`` + requirements: + type: string + description: >- + 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" + }`` + whl: + type: string + description: >- + URI of the wheel library to install. Supported URIs + include Workspace paths, Unity Catalog Volumes paths, + and S3 URIs. For example: ``{ "whl": + "/Workspace/path/to/library.whl" }``, ``{ "whl" : + "/Volumes/path/to/library.whl" }`` or ``{ "whl": + "s3://my-bucket/library.whl" }``. If S3 is used, + please make sure the cluster has read access on the + library. You may need to launch the cluster with an + IAM role to access the S3 URI. + description: The libraries to install. + required: + - cluster_id + - libraries + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: LibrariesAPI + /api/2.0/libraries/uninstall: + post: + operationId: libraries_uninstall + summary: >- + Set libraries to uninstall from a cluster. The libraries won't be + uninstalled until the cluster is + tags: + - compute + - libraries + description: >- + Set libraries to uninstall from a cluster. The libraries won't be + uninstalled until the cluster is - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how - many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members - can have their own - - attributes -- see the documentation for details. - base_environment_type: - type: string - x-enum: - - CPU - - GPU - description: >- - If changed, also update - estore/namespaces/defaultbaseenvironments/latest.proto - created_timestamp: - type: integer - creator_user_id: - type: integer - environment: - type: object - properties: - base_environment: - type: string - description: >- - The base environment this environment is built on - top of. A base environment defines the environment - version and a list of dependencies for serverless - compute. The value can be a file path to a custom - ``env.yaml`` file (e.g., - ``/Workspace/path/to/env.yaml``). Support for a - Databricks-provided base environment ID (e.g., - ``workspace-base-environments/databricks_ai_v4``) - and workspace base environment ID (e.g., - ``workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7``) - is in Beta. Either ``environment_version`` or - ``base_environment`` can be provided. For more - information about Databricks-provided base - environments, see the [list workspace base - environments](:method:Environments/ListWorkspaceBaseEnvironments) - API. For more information, see - client: - type: string - description: Use ``environment_version`` instead. - dependencies: - type: array - items: - type: string - description: >- - List of pip dependencies, as supported by the - version of pip in this environment. Each dependency - is a valid pip requirements file line per - https://pip.pypa.io/en/stable/reference/requirements-file-format/. - Allowed dependencies include a requirement - specifier, an archive URL, a local project path - (such as WSFS or UC Volumes in Databricks), or a VCS - project URL. - environment_version: - type: string - description: >- - Either ``environment_version`` or - ``base_environment`` needs to be provided. - Environment version used by the environment. Each - version comes with a specific Python version and a - set of Python packages. The version is a string, - consisting of an integer. - java_dependencies: - type: array - items: - type: string - description: >- - List of java dependencies. Each dependency is a - string representing a java library path. For - example: ``/Volumes/path/to/test.jar``. - description: >- - Note: we made ``environment`` non-internal because we - need to expose its ``client`` field. All other fields - should be treated as internal. - filepath: - type: string - id: - type: string - is_default: - type: boolean - last_updated_timestamp: - type: integer - last_updated_user_id: - type: integer - message: - type: string - name: - type: string - principal_ids: - type: array - items: - type: integer - status: - type: string - x-enum: - - CREATED - - EXPIRED - - FAILED - - INVALID - - PENDING - - REFRESHING - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members can - have their own - - attributes -- see the documentation for details. - request_id: - type: string - description: >- - A unique identifier for this request. A random UUID is - recommended. This request is only idempotent if a - ``request_id`` is provided. - workspace_base_environment_id: - type: string - required: - - default_base_environment - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DefaultBaseEnvironment' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - get: - operationId: libraries_list_default_base_environments - summary: >- - List default base environments defined in the workspaces for the - requested user. - tags: - - compute - - libraries - description: >- - List default base environments defined in the workspaces for the - requested user. - - - :param page_size: int (optional) - - :param page_token: str (optional) - - - :returns: Iterator over :class:`DefaultBaseEnvironment` - parameters: - - name: page_size - in: query - required: false - schema: - type: integer - - name: page_token - in: query - required: false - schema: - type: string - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListDefaultBaseEnvironmentsResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/default-base-environments/{id}: - delete: - operationId: libraries_delete_default_base_environment - summary: >- - Delete the default base environment given an ID. The default base - environment may be used by - tags: - - compute - - libraries - description: >- - Delete the default base environment given an ID. The default base - environment may be used by - - downstream workloads. Please ensure that the deletion is intentional. - - - :param id: str - parameters: - - name: id - in: path - required: true - schema: - type: string - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - patch: - operationId: libraries_update_default_base_environment - summary: >- - Update the default base environment for the given ID. This process will - asynchronously regenerate the - tags: - - compute - - libraries - description: >- - Update the default base environment for the given ID. This process will - asynchronously regenerate the - - cache. The existing cache remains available until it expires. - - - :param id: str - - :param default_base_environment: :class:`DefaultBaseEnvironment` - - - :returns: :class:`DefaultBaseEnvironment` - parameters: - - name: id - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - default_base_environment: - type: object - properties: - base_environment_cache: - type: array - items: - type: object - properties: - indefinite_materialized_environment: - type: object - properties: - last_updated_timestamp: - type: integer - description: >- - The timestamp (in epoch milliseconds) when the - materialized env is updated. - description: >- - Materialized Environment information enables - environment sharing and reuse via Environment - Caching during library installations. Currently this feature is only supported for Python - libraries. - - - If the env cache entry in LMv2 DB doesn't exist or invalid, library installations and - environment materialization will occur. A new Materialized Environment metadata will be sent - from DP upon successful library installations and env materialization, and is persisted into - database by LMv2. - - If the env cache entry in LMv2 DB is valid, the Materialized Environment will be sent to DP by - LMv2, and DP will restore the cached environment from a store instead of reinstalling - libraries from scratch. - - If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto with new version - If changed, also update estore/namespaces/envspecenvironments/latest.proto with new version - materialized_environment: - type: object - properties: - last_updated_timestamp: - type: integer - description: >- - The timestamp (in epoch milliseconds) when the - materialized env is updated. - description: >- - Materialized Environment information enables - environment sharing and reuse via Environment - Caching during library installations. Currently this feature is only supported for Python - libraries. - - - If the env cache entry in LMv2 DB doesn't exist or invalid, library installations and - environment materialization will occur. A new Materialized Environment metadata will be sent - from DP upon successful library installations and env materialization, and is persisted into - database by LMv2. - - If the env cache entry in LMv2 DB is valid, the Materialized Environment will be sent to DP by - LMv2, and DP will restore the cached environment from a store instead of reinstalling - libraries from scratch. - - If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto with new version - If changed, also update estore/namespaces/envspecenvironments/latest.proto with new version - message: - type: string - status: - type: string - x-enum: - - CREATED - - EXPIRED - - FAILED - - INVALID - - PENDING - - REFRESHING - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how - many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members - can have their own - - attributes -- see the documentation for details. - base_environment_type: - type: string - x-enum: - - CPU - - GPU - description: >- - If changed, also update - estore/namespaces/defaultbaseenvironments/latest.proto - created_timestamp: - type: integer - creator_user_id: - type: integer - environment: - type: object - properties: - base_environment: - type: string - description: >- - The base environment this environment is built on - top of. A base environment defines the environment - version and a list of dependencies for serverless - compute. The value can be a file path to a custom - ``env.yaml`` file (e.g., - ``/Workspace/path/to/env.yaml``). Support for a - Databricks-provided base environment ID (e.g., - ``workspace-base-environments/databricks_ai_v4``) - and workspace base environment ID (e.g., - ``workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7``) - is in Beta. Either ``environment_version`` or - ``base_environment`` can be provided. For more - information about Databricks-provided base - environments, see the [list workspace base - environments](:method:Environments/ListWorkspaceBaseEnvironments) - API. For more information, see - client: - type: string - description: Use ``environment_version`` instead. - dependencies: - type: array - items: - type: string - description: >- - List of pip dependencies, as supported by the - version of pip in this environment. Each dependency - is a valid pip requirements file line per - https://pip.pypa.io/en/stable/reference/requirements-file-format/. - Allowed dependencies include a requirement - specifier, an archive URL, a local project path - (such as WSFS or UC Volumes in Databricks), or a VCS - project URL. - environment_version: - type: string - description: >- - Either ``environment_version`` or - ``base_environment`` needs to be provided. - Environment version used by the environment. Each - version comes with a specific Python version and a - set of Python packages. The version is a string, - consisting of an integer. - java_dependencies: - type: array - items: - type: string - description: >- - List of java dependencies. Each dependency is a - string representing a java library path. For - example: ``/Volumes/path/to/test.jar``. - description: >- - Note: we made ``environment`` non-internal because we - need to expose its ``client`` field. All other fields - should be treated as internal. - filepath: - type: string - id: - type: string - is_default: - type: boolean - last_updated_timestamp: - type: integer - last_updated_user_id: - type: integer - message: - type: string - name: - type: string - principal_ids: - type: array - items: - type: integer - status: - type: string - x-enum: - - CREATED - - EXPIRED - - FAILED - - INVALID - - PENDING - - REFRESHING - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many - members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , ] - - - Methods can be added to enumerations, and members can - have their own - - attributes -- see the documentation for details. - required: - - default_base_environment - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DefaultBaseEnvironment' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/default-base-environments:getDefaultBaseEnvironment: - get: - operationId: libraries_get_default_base_environment - summary: Return the default base environment details for a given ID. - tags: - - compute - - libraries - description: |- - Return the default base environment details for a given ID. - - :param id: str - :param trace_id: str (optional) - Deprecated: use ctx.requestId instead - - :returns: :class:`DefaultBaseEnvironment` - parameters: - - name: id - in: query - required: true - schema: - type: string - - name: trace_id - in: query - required: false - schema: - type: string - description: 'Deprecated: use ctx.requestId instead' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DefaultBaseEnvironment' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/libraries/install: - post: - operationId: libraries_install - summary: >- - Add libraries to install on a cluster. The installation is asynchronous; - it happens in the background - tags: - - compute - - libraries - description: >- - Add libraries to install on a cluster. The installation is asynchronous; - it happens in the background - - after the completion of this request. - - - :param cluster_id: str - Unique identifier for the cluster on which to install these libraries. - :param libraries: List[:class:`Library`] - The libraries to install. - requestBody: - content: - application/json: - schema: - type: object - properties: - cluster_id: - type: string - description: >- - Unique identifier for the cluster on which to install these - libraries. - libraries: - type: array - items: - type: object - properties: - cran: - type: object - properties: - package: - type: string - repo: - type: string - description: >- - The repository where the package can be found. If - not specified, the default CRAN repo is used. - required: - - package - egg: - type: string - 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. - jar: - type: string - description: >- - URI of the JAR library to install. Supported URIs - include Workspace paths, Unity Catalog Volumes paths, - and S3 URIs. For example: ``{ "jar": - "/Workspace/path/to/library.jar" }``, ``{ "jar" : - "/Volumes/path/to/library.jar" }`` or ``{ "jar": - "s3://my-bucket/library.jar" }``. If S3 is used, - please make sure the cluster has read access on the - library. You may need to launch the cluster with an - IAM role to access the S3 URI. - maven: - type: object - properties: - coordinates: - type: string - exclusions: - type: array - items: - type: string - description: >- - List of dependences to exclude. For example: - ``["slf4j:slf4j", "*:hadoop-client"]``. Maven - dependency exclusions: - https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. - repo: - type: string - description: >- - Maven repo to install the Maven package from. If - omitted, both Maven Central Repository and Spark - Packages are searched. - required: - - coordinates - description: >- - Specification of a maven library to be installed. For - example: ``{ "coordinates": "org.jsoup:jsoup:1.7.2" - }`` - pypi: - type: object - properties: - package: - type: string - repo: - type: string - description: >- - The repository where the package can be found. If - not specified, the default pip index is used. - required: - - package - description: >- - Specification of a PyPi library to be installed. For - example: ``{ "package": "simplejson" }`` - requirements: - type: string - description: >- - 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" - }`` - whl: - type: string - description: >- - URI of the wheel library to install. Supported URIs - include Workspace paths, Unity Catalog Volumes paths, - and S3 URIs. For example: ``{ "whl": - "/Workspace/path/to/library.whl" }``, ``{ "whl" : - "/Volumes/path/to/library.whl" }`` or ``{ "whl": - "s3://my-bucket/library.whl" }``. If S3 is used, - please make sure the cluster has read access on the - library. You may need to launch the cluster with an - IAM role to access the S3 URI. - description: The libraries to install. - required: - - cluster_id - - libraries - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/default-base-environments/refresh: - post: - operationId: libraries_refresh_default_base_environments - summary: >- - Refresh the cached default base environments for the given IDs. This - process will asynchronously - tags: - - compute - - libraries - description: >- - Refresh the cached default base environments for the given IDs. This - process will asynchronously - - regenerate the caches. The existing caches remains available until it - expires. - - - :param ids: List[str] - requestBody: - content: - application/json: - schema: - type: object - properties: - ids: - type: array - items: - type: string - required: - - ids - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/libraries/uninstall: - post: - operationId: libraries_uninstall - summary: >- - Set libraries to uninstall from a cluster. The libraries won't be - uninstalled until the cluster is - tags: - - compute - - libraries - description: >- - Set libraries to uninstall from a cluster. The libraries won't be - uninstalled until the cluster is - - restarted. A request to uninstall a library that is not currently - installed is ignored. + restarted. A request to uninstall a library that is not currently + installed is ignored. :param cluster_id: str @@ -8401,86 +7453,29 @@ paths: description: >- 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" - }`` - whl: - type: string - description: >- - URI of the wheel library to install. Supported URIs - include Workspace paths, Unity Catalog Volumes paths, - and S3 URIs. For example: ``{ "whl": - "/Workspace/path/to/library.whl" }``, ``{ "whl" : - "/Volumes/path/to/library.whl" }`` or ``{ "whl": - "s3://my-bucket/library.whl" }``. If S3 is used, - please make sure the cluster has read access on the - library. You may need to launch the cluster with an - IAM role to access the S3 URI. - description: The libraries to uninstall. - required: - - cluster_id - - libraries - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LibrariesAPI - /api/2.0/default-base-environments:setDefault: - post: - operationId: libraries_update_default_default_base_environment - summary: >- - Set the default base environment for the workspace. This marks the - specified DBE as the workspace - tags: - - compute - - libraries - description: >- - Set the default base environment for the workspace. This marks the - specified DBE as the workspace - - default. - - - :param base_environment_type: :class:`BaseEnvironmentType` (optional) - - :param id: str (optional) - - - :returns: :class:`DefaultBaseEnvironment` - requestBody: - content: - application/json: - schema: - type: object - properties: - base_environment_type: - type: string - x-enum: - - CPU - - GPU - description: >- - If changed, also update - estore/namespaces/defaultbaseenvironments/latest.proto - id: - type: string + supported. For example: ``{ "requirements": + "/Workspace/path/to/requirements.txt" }`` or ``{ + "requirements" : "/Volumes/path/to/requirements.txt" + }`` + whl: + type: string + description: >- + URI of the wheel library to install. Supported URIs + include Workspace paths, Unity Catalog Volumes paths, + and S3 URIs. For example: ``{ "whl": + "/Workspace/path/to/library.whl" }``, ``{ "whl" : + "/Volumes/path/to/library.whl" }`` or ``{ "whl": + "s3://my-bucket/library.whl" }``. If S3 is used, + please make sure the cluster has read access on the + library. You may need to launch the cluster with an + IAM role to access the S3 URI. + description: The libraries to uninstall. + required: + - cluster_id + - libraries responses: '200': description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DefaultBaseEnvironment' default: description: Error response content: @@ -9206,10 +8201,7 @@ components: description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as - ``node_type_id`` defined above. This field, along with node_type_id, - should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are - specified, driver_node_type_id and node_type_id take precedence. + ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -9312,8 +8304,7 @@ components: type: integer description: >- If set, what the total initial volume size (in GB) of the remote - disks should be. Currently only supported for GCP HYPERDISK_BALANCED - disks. + disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -9472,10 +8463,7 @@ components: description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as - ``node_type_id`` defined above. This field, along with node_type_id, - should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are - specified, driver_node_type_id and node_type_id take precedence. + ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -9653,8 +8641,7 @@ components: type: integer description: >- If set, what the total initial volume size (in GB) of the remote - disks should be. Currently only supported for GCP HYPERDISK_BALANCED - disks. + disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -9934,10 +8921,7 @@ components: description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as - ``node_type_id`` defined above. This field, along with node_type_id, - should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are - specified, driver_node_type_id and node_type_id take precedence. + ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -10060,8 +9044,7 @@ components: type: integer description: >- If set, what the total initial volume size (in GB) of the remote - disks should be. Currently only supported for GCP HYPERDISK_BALANCED - disks. + disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -10149,56 +9132,6 @@ components: required: - destination description: A storage location in DBFS - DefaultBaseEnvironment: - type: object - properties: - base_environment_cache: - type: array - items: - $ref: '#/components/schemas/DefaultBaseEnvironmentCache' - base_environment_type: - $ref: '#/components/schemas/BaseEnvironmentType' - created_timestamp: - type: integer - creator_user_id: - type: integer - environment: - $ref: '#/components/schemas/Environment' - description: >- - Note: we made ``environment`` non-internal because we need to expose - its ``client`` field. All other fields should be treated as - internal. - filepath: - type: string - id: - type: string - is_default: - type: boolean - last_updated_timestamp: - type: integer - last_updated_user_id: - type: integer - message: - type: string - name: - type: string - principal_ids: - type: array - items: - type: integer - status: - $ref: '#/components/schemas/DefaultBaseEnvironmentCacheStatus' - DefaultBaseEnvironmentCache: - type: object - properties: - indefinite_materialized_environment: - $ref: '#/components/schemas/MaterializedEnvironment' - materialized_environment: - $ref: '#/components/schemas/MaterializedEnvironment' - message: - type: string - status: - $ref: '#/components/schemas/DefaultBaseEnvironmentCacheStatus' DeleteClusterResponse: type: object properties: {} @@ -10214,48 +9147,6 @@ components: DestroyResponse: type: object properties: {} - Diagnostic: - type: object - properties: - checks: - type: array - items: - $ref: '#/components/schemas/DiagnosticCheck' - description: List of individual checks (maps to UI rows). - diagnostics_status: - $ref: '#/components/schemas/DiagnosticsStatus' - description: >- - Overall run status (PASSED / FAILED / NOT_RUN). FAILED if any - individual check fails. - description: >- - The cluster diagnostics singleton resource: the latest diagnostics run - for a cluster. - DiagnosticCheck: - type: object - properties: - check_id: - $ref: '#/components/schemas/CheckId' - description: Identifies the probed target (from the CheckId enum). - check_status: - $ref: '#/components/schemas/DiagnosticsStatus' - description: Outcome of this specific check (PASSED / FAILED / NOT_RUN). - description: - type: string - description: >- - Static summary of what this check tests (e.g., "Control-plane REST - reachability"). - reason: - $ref: '#/components/schemas/DiagnosticsErrorReason' - description: >- - The error reason that caused the check failure, mapping to the first - failing layer (DNS -> TCP -> TLS -> HTTP). Set ONLY when - check_status = FAILED. - remediation: - type: string - description: >- - Static, human-readable instructions to resolve the failure. Set ONLY - when check_status = FAILED. - description: A single check (one row of the cluster's Diagnostics tab). DiskSpec: type: object properties: @@ -10417,10 +9308,7 @@ components: description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as - ``node_type_id`` defined above. This field, along with node_type_id, - should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are - specified, driver_node_type_id and node_type_id take precedence. + ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -10543,8 +9431,7 @@ components: type: integer description: >- If set, what the total initial volume size (in GB) of the remote - disks should be. Currently only supported for GCP HYPERDISK_BALANCED - disks. + disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -10605,6 +9492,15 @@ components: description: >- List of java dependencies. Each dependency is a string representing a java library path. For example: ``/Volumes/path/to/test.jar``. + project_environment: + type: string + description: >- + Path to the ``pyproject.toml`` file that defines the project + environment. This field cannot be combined with + ``environment_version``, ``base_environment``, dependency fields, or + any other environment-source fields. Set the environment version and + dependencies in ``pyproject.toml`` instead. For more information, + see the serverless dependencies documentation. description: >- The environment entity used to preserve serverless environment side panel, jobs' environment for @@ -10911,15 +9807,6 @@ components: description: >- Defines the specification of the disks that will be attached to all spark containers. - enable_auto_alternate_node_types: - type: boolean - description: >- - For pools with node type flexibility (Fleet-V2), whether auto - generated alternate node type ids are enabled. This field should not - be true if node_type_flexibility is set. DEPRECATED: This field was - deprecated before entering PuPr and should no longer be used. - TODO(CJ-71514): Remove this field after sufficient time has passed - for all clients to migrate. enable_elastic_disk: type: boolean description: >- @@ -11276,15 +10163,6 @@ components: description: >- Defines the specification of the disks that will be attached to all spark containers. - enable_auto_alternate_node_types: - type: boolean - description: >- - For pools with node type flexibility (Fleet-V2), whether auto - generated alternate node type ids are enabled. This field should not - be true if node_type_flexibility is set. DEPRECATED: This field was - deprecated before entering PuPr and should no longer be used. - TODO(CJ-71514): Remove this field after sufficient time has passed - for all clients to migrate. enable_elastic_disk: type: boolean description: >- @@ -11381,7 +10259,13 @@ components: properties: availability: $ref: '#/components/schemas/InstancePoolAwsAttributesAvailability' - description: Availability type used for the spot nodes. + description: >- + Availability type used for the instances in the pool. Supports + on-demand, spot, and spot-with-fallback (the pool acquires spot + instances first, and falls back to on-demand instances when spot + capacity is unavailable). You can change this value on an existing + pool. New clusters use the updated availability, and existing + clusters keep the availability they launched with. instance_profile_arn: type: string description: >- @@ -11407,7 +10291,10 @@ components: If not specified, the default value is 100. When spot instances are requested for this cluster, only spot instances whose bid price percentage matches this field will be considered. Note that, for - safety, we enforce this field to be no more than 10000. + safety, we enforce this field to be no more than 10000. You can + change this value on an existing pool. New clusters use the updated + bid price, and existing clusters keep the bid price they launched + with. zone_id: type: string description: >- @@ -11419,6 +10306,14 @@ components: This is an optional field at cluster creation, and if not specified, a default zone will be used. The list of available zones as well as the default value can be found by using the ``List Zones`` method. + Set this field to "auto" to enable Auto-AZ, in which case Databricks + selects the availability zone for each cluster independently when + the cluster launches, and retries another zone if the cluster can't + be fulfilled because of insufficient capacity or quota. All nodes in + a cluster land in the same zone, and different clusters backed by + the pool can run in different zones. You can change the zone on an + existing pool. New clusters use the updated zone, and existing + clusters keep the zone they launched with. description: >- Attributes set during instance pool creation which are related to Amazon Web Services. @@ -11427,7 +10322,13 @@ components: properties: availability: $ref: '#/components/schemas/InstancePoolAzureAttributesAvailability' - description: Availability type used for the spot nodes. + description: >- + Availability type used for the instances in the pool. Supports + on-demand, spot, and spot-with-fallback (the pool acquires spot + instances first, and falls back to on-demand instances when spot + capacity is unavailable). You can change this value on an existing + pool. New clusters use the updated availability, and existing + clusters keep the availability they launched with. capacity_reservation_group: type: string description: >- @@ -11454,13 +10355,22 @@ components: USD per hour. If you set the max price to be -1, the VM won't be evicted based on price. The price for the VM will be the current price for spot or the price for a standard VM, which ever is less, - as long as there is capacity and quota available. + as long as there is capacity and quota available. You can change + this value on an existing pool. New clusters use the updated max + price, and existing clusters keep the max price they launched with. description: Attributes set during instance pool creation which are related to Azure. InstancePoolGcpAttributes: type: object properties: gcp_availability: $ref: '#/components/schemas/GcpAvailability' + description: >- + Availability type for the instances in the pool. One of: - + ``ON_DEMAND_GCP``: the pool uses on-demand instances only. - + ``PREEMPTIBLE_GCP``: the pool uses preemptible instances only. - + ``PREEMPTIBLE_WITH_FALLBACK_GCP``: the pool acquires preemptible + instances first, and falls back to on-demand instances when + preemptible capacity is unavailable. local_ssd_count: type: integer description: >- @@ -11480,12 +10390,19 @@ components: This is an optional field at instance pool creation, and if not specified, a default zone will be used. This field can be one of the following: - "HA" => High availability, spread nodes across - availability zones for a Databricks deployment region - A GCP + availability zones for a Databricks deployment region - "auto" => + Auto-AZ. Databricks selects the availability zone for each cluster + independently when the cluster launches, and retries another zone if + the cluster can't be fulfilled because of insufficient capacity or + quota. All nodes in a cluster land in the same zone, and different + clusters backed by the pool can run in different zones. - A GCP availability zone => Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. "us-west1-a"). If empty, Databricks picks an availability zone to - schedule the cluster on. + schedule the cluster on. You can change the zone on an existing + pool. New clusters use the updated zone, and existing clusters keep + the zone they launched with. description: Attributes set during instance pool creation which are related to GCP. InstancePoolPermission: type: object @@ -11720,15 +10637,6 @@ components: The sorting criteria. By default, clusters are sorted by 3 columns from highest to lowest precedence: cluster state, pinned or unpinned, then cluster name. - ListDefaultBaseEnvironmentsResponse: - type: object - properties: - default_base_environments: - type: array - items: - $ref: '#/components/schemas/DefaultBaseEnvironment' - next_page_token: - type: string ListGlobalInitScriptsResponse: type: object properties: @@ -11802,30 +10710,6 @@ components: The exception thrown in the last attempt, it would be null (omitted in the response) if there is no exception in last attempted. description: The log delivery status - MaterializedEnvironment: - type: object - properties: - last_updated_timestamp: - type: integer - description: >- - The timestamp (in epoch milliseconds) when the materialized env is - updated. - description: >- - Materialized Environment information enables environment sharing and - reuse via Environment - Caching during library installations. Currently this feature is only supported for Python - libraries. - - - If the env cache entry in LMv2 DB doesn't exist or invalid, library installations and - environment materialization will occur. A new Materialized Environment metadata will be sent - from DP upon successful library installations and env materialization, and is persisted into - database by LMv2. - - If the env cache entry in LMv2 DB is valid, the Materialized Environment will be sent to DP by - LMv2, and DP will restore the cached environment from a store instead of reinstalling - libraries from scratch. - - If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto with new version - If changed, also update estore/namespaces/envspecenvironments/latest.proto with new version MavenLibrary: type: object properties: @@ -11976,6 +10860,11 @@ components: description: >- A list of node type IDs to use as fallbacks when the primary node type is unavailable. + aws_context_id: + type: string + description: >- + The AWS Context ID for EC2 Fleet. When set (non-empty), the value is + passed to AWS CreateFleet API to create the EC2 Fleet. description: >- Configuration for flexible node types, allowing fallback to alternate node types during cluster @@ -12030,28 +10919,6 @@ components: Policy: type: object properties: - auto_enforcement_config: - $ref: '#/components/schemas/PolicyAutoEnforcementConfig' - description: >- - If present, auto enforcement is enabled for the policy. After the - policy is edited, a background operation may be scheduled to scan - and edit all clusters and jobs using this policy to be in compliance - with the policy. The background operation is created when a policy - edit does one of the following: - Changes the policy definition, or - - Changes auto enforcement from disabled to enabled Additionally, - changes to the policy definition or auto enforcement configuration - may cause an in-progress operation to be restarted. To cancel an - in-progress operation, edit the policy to delete this auto - enforcement configuration. The background operation status is - reported via the ``background_enforcement`` field when reading the - policy. - background_enforcement: - $ref: '#/components/schemas/PolicyBackgroundEnforcement' - description: >- - Status and results of the background auto-enforcement operation for - this policy. Only returned if calling "Get a cluster policy" with - ``POLICY_VIEW_FULL``. Must be a workspace admin for this field to be - populated. created_at_timestamp: type: integer description: >- @@ -12115,56 +10982,6 @@ components: type: string description: Canonical unique identifier for the Cluster Policy. description: Describes a Cluster Policy entity. - PolicyAutoEnforcementConfig: - type: object - properties: - enforce_mode: - $ref: >- - #/components/schemas/PolicyAutoEnforcementConfigPolicyAutoEnforcementEnforceMode - description: >- - For running clusters, whether to defer enforcement until the cluster - terminates or to restart it immediately. - description: Configures how auto enforcement should be executed for a cluster policy. - PolicyBackgroundEnforcement: - type: object - properties: - deferred_cluster_enforce_count: - type: integer - description: >- - Number of clusters that are scheduled to enforce on next termination - or restart. - end_time: - type: string - format: date-time - description: >- - The time the enforcement operation finished. Only set once the - operation reaches a COMPLETED or ABORTED state. - failed_cluster_enforce_count: - type: integer - description: Number of clusters that could not be enforced due to an error. - failed_job_enforce_count: - type: integer - description: Number of jobs that could not be enforced due to an error. - initiate_time: - type: string - format: date-time - description: The time the enforcement operation was initiated. - initiator_user: - type: string - description: >- - The user who edited the policy to initiate the enforcement - operation. - status: - $ref: >- - #/components/schemas/PolicyBackgroundEnforcementPolicyBackgroundEnforcementStatus - description: Whether the enforcement operation is still in-progress or completed. - success_cluster_enforce_count: - type: integer - description: Number of clusters that were successfully enforced. - success_job_enforce_count: - type: integer - description: Number of jobs that were successfully enforced. - description: Status and results of the background enforcement operation for a policy. PolicyFamily: type: object properties: @@ -12203,9 +11020,6 @@ components: default CRAN repo is used. required: - package - RefreshDefaultBaseEnvironmentsResponse: - type: object - properties: {} RemoveResponse: type: object properties: {} @@ -12455,10 +11269,7 @@ components: description: >- The node type of the Spark driver. Note that this field is optional; if unset, the driver node type will be set as the same value as - ``node_type_id`` defined above. This field, along with node_type_id, - should not be set if virtual_cluster_size is set. If both - driver_node_type_id, node_type_id, and virtual_cluster_size are - specified, driver_node_type_id and node_type_id take precedence. + ``node_type_id`` defined above. enable_elastic_disk: type: boolean description: >- @@ -12581,8 +11392,7 @@ components: type: integer description: >- If set, what the total initial volume size (in GB) of the remote - disks should be. Currently only supported for GCP HYPERDISK_BALANCED - disks. + disks should be. Supported for GCP. use_ml_runtime: type: boolean description: >- @@ -12662,32 +11472,6 @@ components: ``first_on_demand`` is zero, this availability type will be used for the entire cluster. - BaseEnvironmentType: - type: string - x-enum: - - CPU - - GPU - description: >- - If changed, also update - estore/namespaces/defaultbaseenvironments/latest.proto - CheckId: - type: string - x-enum: - - CHECK_ID_NETWORK_BIFROST - - CHECK_ID_NETWORK_CONTROL_PLANE - - CHECK_ID_NETWORK_CP_MTLS - - CHECK_ID_NETWORK_DNS_SERVER - - CHECK_ID_NETWORK_INTERNET - - CHECK_ID_NETWORK_LOG_ARTIFACT_BUCKET - - CHECK_ID_NETWORK_METADATA_ENDPOINT - - CHECK_ID_NETWORK_NIC - - CHECK_ID_NETWORK_SCC_TUNNEL - - CHECK_ID_NETWORK_STORAGE_BUCKET - description: >- - Identifies the specific diagnostic check the user will see. Each value - maps to one row in the - - cluster's Diagnostics tab. CloudProviderNodeStatus: type: string x-enum: @@ -12960,52 +11744,6 @@ components: - ``LEGACY_SINGLE_USER_STANDARD``: This mode provides a way that doesn’t have UC nor passthrough enabled. - DefaultBaseEnvironmentCacheStatus: - type: string - x-enum: - - CREATED - - EXPIRED - - FAILED - - INVALID - - PENDING - - REFRESHING - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. DependencyMode: type: string x-enum: @@ -13026,34 +11764,6 @@ components: - ``DEPENDENCY_MODE_CLUSTER_LIBRARIES``: Legacy mode: dependencies come from cluster libraries and init scripts. - DiagnosticsErrorReason: - type: string - x-enum: - - ERROR_REASON_CERT_SAN_MISMATCH - - ERROR_REASON_DNS_RESOLVE_FAIL - - ERROR_REASON_HTTP_3XX - - ERROR_REASON_HTTP_4XX - - ERROR_REASON_HTTP_5XX - - ERROR_REASON_HTTP_TIMEOUT - - ERROR_REASON_NOT_RUN - - ERROR_REASON_TCP_REFUSED - - ERROR_REASON_TCP_TIMEOUT - - ERROR_REASON_TLS_HANDSHAKE_FAIL - description: >- - Diagnostic error reason for a failed check, identifying the first - failing network layer (DNS -> - - TCP -> TLS -> HTTP). Set on Check.reason only when check_status = - FAILED. - DiagnosticsStatus: - type: string - x-enum: - - DIAGNOSTICS_STATUS_FAILED - - DIAGNOSTICS_STATUS_NOT_RUN - - DIAGNOSTICS_STATUS_PASSED - description: >- - Overall status of a cluster diagnostics run, and of each individual - check within it. DiskTypeAzureDiskVolumeType: type: string x-enum: @@ -13666,29 +12376,6 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - PolicyAutoEnforcementConfigPolicyAutoEnforcementEnforceMode: - type: string - x-enum: - - ENFORCE_IMMEDIATELY - - WAIT_FOR_TERMINATION - description: >- - Behavior for running clusters when auto-enforcement is applied. Mirrors - ``enforce_mode`` on the - - enforce compliance API. - PolicyBackgroundEnforcementPolicyBackgroundEnforcementStatus: - type: string - x-enum: - - ABORTED - - COMPLETED - - IN_PROGRESS - description: The status of a background policy enforcement operation. - PolicyView: - type: string - x-enum: - - POLICY_VIEW_BASIC - - POLICY_VIEW_FULL - description: Controls which fields are returned when reading a policy. ResultType: type: string x-enum: @@ -13853,7 +12540,6 @@ components: - BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG - BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED - BUDGET_POLICY_RESOLUTION_FAILURE - - CERT_ROTATION - CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED - CLOUD_ACCOUNT_SETUP_FAILURE - CLOUD_OPERATION_CANCELLED @@ -13872,7 +12558,6 @@ components: - CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG - CONTROL_PLANE_REQUEST_FAILURE - CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG - - COST_CONTROL_ENTITLEMENT_DENIED - DATABASE_CONNECTION_FAILURE - DATA_ACCESS_CONFIG_CHANGED - DBFS_COMPONENT_UNHEALTHY @@ -13883,7 +12568,6 @@ components: - DOCKER_IMAGE_PULL_FAILURE - DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION - DOCKER_INVALID_OS_EXCEPTION - - DRIVER_DNS_RESOLUTION_FAILURE - DRIVER_EVICTION - DRIVER_LAUNCH_TIMEOUT - DRIVER_NODE_UNREACHABLE @@ -13960,8 +12644,6 @@ components: - NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG - NETWORK_CONFIGURATION_FAILURE - NFS_MOUNT_FAILURE - - NO_ACTIVATED_K8S - - NO_ACTIVATED_K8S_TESTING_TAG - NO_MATCHED_K8S - NO_MATCHED_K8S_TESTING_TAG - NPIP_TUNNEL_SETUP_FAILURE @@ -13972,11 +12654,9 @@ components: - REQUEST_REJECTED - REQUEST_THROTTLED - RESOURCE_USAGE_BLOCKED - - SECRET_CREATION_ACCESS_DENIED - SECRET_CREATION_FAILURE - SECRET_PERMISSION_DENIED - SECRET_RESOLUTION_ERROR - - SECURITY_AGENTS_FAILED_INITIAL_VERIFICATION - SECURITY_DAEMON_REGISTRATION_EXCEPTION - SELF_BOOTSTRAP_FAILURE - SERVERLESS_LONG_RUNNING_TERMINATED @@ -14008,9 +12688,8 @@ components: - WORKER_SETUP_FAILURE - WORKSPACE_CANCELLED_ERROR - WORKSPACE_CONFIGURATION_ERROR - - WORKSPACE_DELEGATION_KEY_MISCONFIGURED - WORKSPACE_UPDATE - description: The status code indicating why the cluster was terminated + description: The status code indicating why the cluster was terminated. TerminationReasonType: type: string x-enum: @@ -14196,12 +12875,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - clusters_get_diagnostic: - operation: - $ref: '#/paths/~1api~12.1~1{name}~1diagnostics/get' - response: - mediaType: application/json - openAPIDocKey: '200' list: operation: $ref: '#/paths/~1api~12.1~1clusters~1list/get' @@ -14274,8 +12947,6 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/clusters/methods/clusters_get_diagnostic - $ref: '#/components/x-stackQL-resources/clusters/methods/get' - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: @@ -14753,94 +13424,6 @@ components: update: [] delete: [] replace: [] - default_base_environments: - id: databricks_workspace.compute.default_base_environments - name: default_base_environments - title: Default Base Environments - methods: - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.default_base_environments - delete: - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments~1{id}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments~1{id}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - refresh: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments~1refresh/post' - response: - mediaType: application/json - openAPIDocKey: '200' - set_default: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1default-base-environments:setDefault/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/default_base_environments/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/default_base_environments/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/default_base_environments/methods/update - delete: - - $ref: >- - #/components/x-stackQL-resources/default_base_environments/methods/delete - replace: [] - default_base_environment: - id: databricks_workspace.compute.default_base_environment - name: default_base_environment - title: Default Base Environment - methods: - get: - operation: - $ref: >- - #/paths/~1api~12.0~1default-base-environments:getDefaultBaseEnvironment/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/default_base_environment/methods/get - insert: [] - update: [] - delete: [] - replace: [] policy_compliance_for_clusters: id: databricks_workspace.compute.policy_compliance_for_clusters name: policy_compliance_for_clusters diff --git a/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml b/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml index 7593e887..9e14624d 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml @@ -6,29 +6,46 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.dashboards servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages: post: operationId: genie_create_message summary: >- - Create new message in a [conversation](:method:genie/startconversation). - The AI response uses all + Sends a new message in a chat-mode + [conversation](:method:genie/startconversation). The AI response tags: - dashboards - genie description: >- - Create new message in a [conversation](:method:genie/startconversation). - The AI response uses all + Sends a new message in a chat-mode + [conversation](:method:genie/startconversation). The AI response - previously created messages in the conversation to respond. + uses all previously created messages in the conversation to respond. :param space_id: str @@ -93,12 +110,21 @@ paths: x-stackql-sdk-source: GenieAPI get: operationId: genie_list_conversation_messages - summary: List messages in a conversation + summary: >- + Lists messages in a chat-mode or agent-mode conversation. Agent-mode + messages are returned as tags: - dashboards - genie - description: |- - List messages in a conversation + description: >- + Lists messages in a chat-mode or agent-mode conversation. Agent-mode + messages are returned as + + GenieMessage projections. Use the List conversation items endpoint for + the complete reasoning and + + tool-call history. + :param space_id: str The ID associated with the Genie space where the conversation is located @@ -513,12 +539,18 @@ paths: x-stackql-sdk-source: GenieAPI get: operationId: genie_get_message - summary: Get message from conversation. + summary: >- + Gets a message from a chat-mode or agent-mode conversation. For a + complete agent-mode transcript, use tags: - dashboards - genie - description: |- - Get message from conversation. + description: >- + Gets a message from a chat-mode or agent-mode conversation. For a + complete agent-mode transcript, use + + the List conversation items endpoint. + :param space_id: str The ID associated with the Genie space where the target conversation is located. @@ -570,7 +602,7 @@ paths: message: type: string x-stackql-sdk-source: GenieAPI - /api/2.0/genie/{name}/download-visualization: + /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/download-visualization: get: operationId: genie_download_message_attachment_visualization summary: >- @@ -586,8 +618,7 @@ paths: image, not a JSON payload. This is only available if the attachment is a visualization and the message - status is ``COMPLETED``. This endpoint is not supported for Private Link - workspaces. + status is ``COMPLETED``. :param name: str @@ -596,12 +627,44 @@ paths: :returns: :class:`DownloadMessageAttachmentVisualizationResponse` parameters: - - name: name + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The `space_id` segment of the `name` resource name + (`spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`). + The resource name of the attachment to render, in the format + ``spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}``. + - name: conversation_id + in: path + required: true + schema: + type: string + description: >- + The `conversation_id` segment of the `name` resource name + (`spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`). + The resource name of the attachment to render, in the format + ``spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}``. + - name: message_id + in: path + required: true + schema: + type: string + description: >- + The `message_id` segment of the `name` resource name + (`spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`). + The resource name of the attachment to render, in the format + ``spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}``. + - name: attachment_id in: path required: true schema: type: string description: >- + The `attachment_id` segment of the `name` resource name + (`spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`). The resource name of the attachment to render, in the format ``spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}``. responses: @@ -785,19 +848,13 @@ paths: ``EXTERNAL_LINKS`` disposition.** - When you use the ``EXTERNAL_LINKS`` disposition, a short-lived, URL is - generated, which can be used to - - download the results directly from . As a short-lived is embedded in - this URL, you should protect the - - URL. + When you use the ``EXTERNAL_LINKS`` disposition, a short-lived + cloud-storage URL is generated to + download the results. The URL contains temporary access credentials, so + protect it and do not set an - Because URLs are already generated with embedded temporary s, you must - not set an ``Authorization`` - - header in the download requests. + ``Authorization`` header in the download request. See [Execute Statement](:method:statementexecution/executestatement) for @@ -859,18 +916,85 @@ paths: message: type: string x-stackql-sdk-source: GenieAPI + /api/2.0/genie/agents/{agent_id}/conversations/{conversation_id}/responses/{response_id}/cancel: + post: + operationId: genie_genie_cancel_response + summary: >- + Cancels an in-flight agent-mode response. ``response_id`` is the id + returned in the + tags: + - dashboards + - genie + description: >- + Cancels an in-flight agent-mode response. ``response_id`` is the id + returned in the + + ``response.created`` event from the agent-mode responses endpoint. The + response stops at the next + + agent boundary and its terminal state is returned. + + + :param agent_id: str + The ID of the Genie agent (synonymous with the Genie space ID). + :param conversation_id: str + The ID of the conversation containing the response. + :param response_id: str + The ID of the response to cancel (the id from the ``response.created`` event). + + :returns: :class:`GenieMessage` + parameters: + - name: agent_id + in: path + required: true + schema: + type: string + description: The ID of the Genie agent (synonymous with the Genie space ID). + - name: conversation_id + in: path + required: true + schema: + type: string + description: The ID of the conversation containing the response. + - name: response_id + in: path + required: true + schema: + type: string + description: >- + The ID of the response to cancel (the id from the + ``response.created`` event). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieMessage' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: GenieAPI /api/2.0/genie/spaces/{space_id}/eval-runs: post: operationId: genie_genie_create_eval_run summary: >- - Create and run evaluations for multiple benchmark questions in a Genie - space. + Creates and runs chat-mode evaluations for multiple benchmark questions + in a Genie space. tags: - dashboards - genie description: >- - Create and run evaluations for multiple benchmark questions in a Genie - space. + Creates and runs chat-mode evaluations for multiple benchmark questions + in a Genie space. :param space_id: str @@ -1183,19 +1307,13 @@ paths: ``EXTERNAL_LINKS`` disposition.** - When you use the ``EXTERNAL_LINKS`` disposition, a short-lived, URL is - generated, which can be used to - - download the results directly from . As a short-lived is embedded in - this URL, you should protect the - - URL. + When you use the ``EXTERNAL_LINKS`` disposition, a short-lived + cloud-storage URL is generated to + download the results. The URL contains temporary access credentials, so + protect it and do not set an - Because URLs are already generated with embedded temporary s, you must - not set an ``Authorization`` - - header in the download requests. + ``Authorization`` header in the download request. See [Execute Statement](:method:statementexecution/executestatement) for @@ -1786,12 +1904,12 @@ paths: /api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/feedback: post: operationId: genie_send_message_feedback - summary: Send feedback for a message. + summary: Sends feedback for a message in a chat-mode or agent-mode conversation. tags: - dashboards - genie description: |- - Send feedback for a message. + Sends feedback for a message in a chat-mode or agent-mode conversation. :param space_id: str The ID associated with the Genie space where the message is located. @@ -1858,12 +1976,12 @@ paths: /api/2.0/genie/spaces/{space_id}/start-conversation: post: operationId: genie_start_conversation - summary: Start a new conversation. + summary: Starts a new chat-mode conversation and sends its first message. tags: - dashboards - genie description: |- - Start a new conversation. + Starts a new chat-mode conversation and sends its first message. :param space_id: str The ID associated with the Genie space where you want to start a conversation. @@ -1924,10 +2042,19 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Create a draft dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard: :class:`Dashboard` + :param dataset_catalog: str (optional) Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips). Leave blank to keep each dataset’s @@ -1965,67 +2092,61 @@ paths: schema: type: object properties: - dashboard: - type: object - properties: - create_time: - type: string - dashboard_id: - type: string - description: UUID identifying the dashboard. - display_name: - type: string - description: The display name of the dashboard. - etag: - type: string - description: >- - The etag for the dashboard. Can be optionally provided - on updates to ensure that the dashboard has not been - modified since the last read. This field is excluded in - List Dashboards responses. - lifecycle_state: - type: string - x-enum: - - ACTIVE - - TRASHED - description: >- - The state of the dashboard resource. Used for tracking - trashed status. - parent_path: - type: string - description: >- - The workspace path of the folder containing the - dashboard. Includes leading slash and no trailing slash. - This field is excluded in List Dashboards responses. - path: - type: string - description: >- - The workspace path of the dashboard asset, including the - file name. Exported dashboards always have the file - extension ``.lvdash.json``. This field is excluded in - List Dashboards responses. - serialized_dashboard: - type: string - description: >- - The contents of the dashboard in serialized string form. - This field is excluded in List Dashboards responses. Use - the `get dashboard API - `__ - to retrieve an example response, which includes the - ``serialized_dashboard`` field. This field provides the - structure of the JSON string that represents the - dashboard's layout and components. - update_time: - type: string - description: >- - The timestamp of when the dashboard was last updated by - the user. This field is excluded in List Dashboards - responses. - warehouse_id: - type: string - description: The warehouse ID used to run the dashboard. - required: - - dashboard + create_time: + type: string + dashboard_id: + type: string + description: UUID identifying the dashboard. + display_name: + type: string + description: The display name of the dashboard. + etag: + type: string + description: >- + The etag for the dashboard. Can be optionally provided on + updates to ensure that the dashboard has not been modified + since the last read. This field is excluded in List + Dashboards responses. + lifecycle_state: + type: string + x-enum: + - ACTIVE + - TRASHED + description: >- + The state of the dashboard resource. Used for tracking + trashed status. + parent_path: + type: string + description: >- + The workspace path of the folder containing the dashboard. + Includes leading slash and no trailing slash. This field is + excluded in List Dashboards responses. + path: + type: string + description: >- + The workspace path of the dashboard asset, including the + file name. Exported dashboards always have the file + extension ``.lvdash.json``. This field is excluded in List + Dashboards responses. + serialized_dashboard: + type: string + description: >- + The contents of the dashboard in serialized string form. + This field is excluded in List Dashboards responses. Use the + `get dashboard API + `__ + to retrieve an example response, which includes the + ``serialized_dashboard`` field. This field provides the + structure of the JSON string that represents the dashboard's + layout and components. + update_time: + type: string + description: >- + The timestamp of when the dashboard was last updated by the + user. This field is excluded in List Dashboards responses. + warehouse_id: + type: string + description: The warehouse ID used to run the dashboard. responses: '200': description: Success @@ -2051,9 +2172,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- List dashboards. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param page_size: int (optional) The number of dashboards to return per page. :param page_token: str (optional) @@ -2123,9 +2252,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Create dashboard schedule. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard to which the schedule belongs. :param schedule: :class:`Schedule` @@ -2145,70 +2282,56 @@ paths: schema: type: object properties: - schedule: + cron_schedule: type: object properties: - cron_schedule: - type: object - properties: - quartz_cron_expression: - type: string - timezone_id: - type: string - description: >- - A Java timezone id. The schedule will be resolved - with respect to this timezone. See `Java TimeZone - `__ - for details. - required: - - quartz_cron_expression - - timezone_id - create_time: - type: string - description: A timestamp indicating when the schedule was created. - dashboard_id: - type: string - description: >- - UUID identifying the dashboard to which the schedule - belongs. - display_name: + quartz_cron_expression: type: string - description: The display name for schedule. - etag: + timezone_id: type: string description: >- - The etag for the schedule. Must be left empty on create, - must be provided on updates to ensure that the schedule - has not been modified since the last read, and can be - optionally provided on delete. - pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: >- - The status indicates whether this schedule is paused or - not. - schedule_id: - type: string - description: UUID identifying the schedule. - update_time: - type: string - description: >- - A timestamp indicating when the schedule was last - updated. - warehouse_id: - type: string - description: >- - The warehouse id to run the dashboard with for the - schedule. + A Java timezone id. The schedule will be resolved with + respect to this timezone. See `Java TimeZone + `__ + for details. required: - - cron_schedule + - quartz_cron_expression + - timezone_id + create_time: + type: string + description: A timestamp indicating when the schedule was created. + dashboard_id: + type: string description: >- - The schedule to create. A dashboard is limited to 10 - schedules. + UUID identifying the dashboard to which the schedule + belongs. + display_name: + type: string + description: The display name for schedule. + etag: + type: string + description: >- + The etag for the schedule. Must be left empty on create, + must be provided on updates to ensure that the schedule has + not been modified since the last read, and can be optionally + provided on delete. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: The status indicates whether this schedule is paused or not. + schedule_id: + type: string + description: UUID identifying the schedule. + update_time: + type: string + description: A timestamp indicating when the schedule was last updated. + warehouse_id: + type: string + description: The warehouse id to run the dashboard with for the schedule. required: - - schedule + - cron_schedule responses: '200': description: Success @@ -2234,9 +2357,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- List dashboard schedules. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard to which the schedules belongs. :param page_size: int (optional) @@ -2293,9 +2432,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Create schedule subscription. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard to which the subscription belongs. :param schedule_id: str @@ -2323,79 +2478,68 @@ paths: schema: type: object properties: - subscription: + subscriber: type: object properties: - subscriber: + destination_subscriber: type: object properties: - destination_subscriber: - type: object - properties: - destination_id: - type: string - required: - - destination_id - user_subscriber: - type: object - properties: - user_id: - type: integer - required: - - user_id - description: >- - The user to receive the subscription email. This - parameter is mutually exclusive with - ``destination_subscriber``. - create_time: - type: string - description: >- - A timestamp indicating when the subscription was - created. - created_by_user_id: - type: integer - description: >- - UserId of the user who adds subscribers (users or - notification destinations) to the dashboard's schedule. - dashboard_id: - type: string - description: >- - UUID identifying the dashboard to which the subscription - belongs. - etag: - type: string - description: >- - The etag for the subscription. Must be left empty on - create, can be optionally provided on delete to ensure - that the subscription has not been deleted since the - last read. - schedule_id: - type: string - description: >- - UUID identifying the schedule to which the subscription - belongs. - skip_notify: - type: boolean - description: >- - Controls whether notifications are sent to the - subscriber for scheduled dashboard refreshes. If not - defined, defaults to false in the backend to match the - current behavior (refresh and notify) - subscription_id: - type: string - description: UUID identifying the subscription. - update_time: - type: string + destination_id: + type: string + required: + - destination_id + user_subscriber: + type: object + properties: + user_id: + type: integer + required: + - user_id description: >- - A timestamp indicating when the subscription was last - updated. - required: - - subscriber + The user to receive the subscription email. This + parameter is mutually exclusive with + ``destination_subscriber``. + create_time: + type: string + description: A timestamp indicating when the subscription was created. + created_by_user_id: + type: integer + description: >- + UserId of the user who adds subscribers (users or + notification destinations) to the dashboard's schedule. + dashboard_id: + type: string description: >- - The subscription to create. A schedule is limited to 100 - subscriptions. + UUID identifying the dashboard to which the subscription + belongs. + etag: + type: string + description: >- + The etag for the subscription. Must be left empty on create, + can be optionally provided on delete to ensure that the + subscription has not been deleted since the last read. + schedule_id: + type: string + description: >- + UUID identifying the schedule to which the subscription + belongs. + skip_notify: + type: boolean + description: >- + Controls whether notifications are sent to the subscriber + for scheduled dashboard refreshes. If not defined, defaults + to false in the backend to match the current behavior + (refresh and notify) + subscription_id: + type: string + description: UUID identifying the subscription. + update_time: + type: string + description: >- + A timestamp indicating when the subscription was last + updated. required: - - subscription + - subscriber responses: '200': description: Success @@ -2421,9 +2565,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- List schedule subscriptions. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard which the subscriptions belongs. :param schedule_id: str @@ -2488,9 +2648,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Delete dashboard schedule. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard to which the schedule belongs. :param schedule_id: str @@ -2540,9 +2708,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Get dashboard schedule. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard to which the schedule belongs. :param schedule_id: str @@ -2587,9 +2771,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Update dashboard schedule. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard to which the schedule belongs. :param schedule_id: str @@ -2617,68 +2809,56 @@ paths: schema: type: object properties: - schedule: + cron_schedule: type: object properties: - cron_schedule: - type: object - properties: - quartz_cron_expression: - type: string - timezone_id: - type: string - description: >- - A Java timezone id. The schedule will be resolved - with respect to this timezone. See `Java TimeZone - `__ - for details. - required: - - quartz_cron_expression - - timezone_id - create_time: + quartz_cron_expression: type: string - description: A timestamp indicating when the schedule was created. - dashboard_id: + timezone_id: type: string description: >- - UUID identifying the dashboard to which the schedule - belongs. - display_name: - type: string - description: The display name for schedule. - etag: - type: string - description: >- - The etag for the schedule. Must be left empty on create, - must be provided on updates to ensure that the schedule - has not been modified since the last read, and can be - optionally provided on delete. - pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: >- - The status indicates whether this schedule is paused or - not. - schedule_id: - type: string - description: UUID identifying the schedule. - update_time: - type: string - description: >- - A timestamp indicating when the schedule was last - updated. - warehouse_id: - type: string - description: >- - The warehouse id to run the dashboard with for the - schedule. + A Java timezone id. The schedule will be resolved with + respect to this timezone. See `Java TimeZone + `__ + for details. required: - - cron_schedule - description: The schedule to update. + - quartz_cron_expression + - timezone_id + create_time: + type: string + description: A timestamp indicating when the schedule was created. + dashboard_id: + type: string + description: >- + UUID identifying the dashboard to which the schedule + belongs. + display_name: + type: string + description: The display name for schedule. + etag: + type: string + description: >- + The etag for the schedule. Must be left empty on create, + must be provided on updates to ensure that the schedule has + not been modified since the last read, and can be optionally + provided on delete. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: The status indicates whether this schedule is paused or not. + schedule_id: + type: string + description: UUID identifying the schedule. + update_time: + type: string + description: A timestamp indicating when the schedule was last updated. + warehouse_id: + type: string + description: The warehouse id to run the dashboard with for the schedule. required: - - schedule + - cron_schedule responses: '200': description: Success @@ -2705,9 +2885,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Delete schedule subscription. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard which the subscription belongs. :param schedule_id: str @@ -2765,9 +2961,25 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Get schedule subscription. + + The caller must be a workspace user with one of the following + `entitlements + + `__: Workspace + access, Databricks SQL access, + + or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the dashboard which the subscription belongs. :param schedule_id: str @@ -2821,9 +3033,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Get a draft dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard. @@ -2860,9 +3080,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Trash a dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard. parameters: @@ -2893,12 +3121,21 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Update a draft dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard. :param dashboard: :class:`Dashboard` + :param dataset_catalog: str (optional) Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips). Leave blank to keep each dataset’s @@ -2942,67 +3179,61 @@ paths: schema: type: object properties: - dashboard: - type: object - properties: - create_time: - type: string - dashboard_id: - type: string - description: UUID identifying the dashboard. - display_name: - type: string - description: The display name of the dashboard. - etag: - type: string - description: >- - The etag for the dashboard. Can be optionally provided - on updates to ensure that the dashboard has not been - modified since the last read. This field is excluded in - List Dashboards responses. - lifecycle_state: - type: string - x-enum: - - ACTIVE - - TRASHED - description: >- - The state of the dashboard resource. Used for tracking - trashed status. - parent_path: - type: string - description: >- - The workspace path of the folder containing the - dashboard. Includes leading slash and no trailing slash. - This field is excluded in List Dashboards responses. - path: - type: string - description: >- - The workspace path of the dashboard asset, including the - file name. Exported dashboards always have the file - extension ``.lvdash.json``. This field is excluded in - List Dashboards responses. - serialized_dashboard: - type: string - description: >- - The contents of the dashboard in serialized string form. - This field is excluded in List Dashboards responses. Use - the `get dashboard API - `__ - to retrieve an example response, which includes the - ``serialized_dashboard`` field. This field provides the - structure of the JSON string that represents the - dashboard's layout and components. - update_time: - type: string - description: >- - The timestamp of when the dashboard was last updated by - the user. This field is excluded in List Dashboards - responses. - warehouse_id: - type: string - description: The warehouse ID used to run the dashboard. - required: - - dashboard + create_time: + type: string + dashboard_id: + type: string + description: UUID identifying the dashboard. + display_name: + type: string + description: The display name of the dashboard. + etag: + type: string + description: >- + The etag for the dashboard. Can be optionally provided on + updates to ensure that the dashboard has not been modified + since the last read. This field is excluded in List + Dashboards responses. + lifecycle_state: + type: string + x-enum: + - ACTIVE + - TRASHED + description: >- + The state of the dashboard resource. Used for tracking + trashed status. + parent_path: + type: string + description: >- + The workspace path of the folder containing the dashboard. + Includes leading slash and no trailing slash. This field is + excluded in List Dashboards responses. + path: + type: string + description: >- + The workspace path of the dashboard asset, including the + file name. Exported dashboards always have the file + extension ``.lvdash.json``. This field is excluded in List + Dashboards responses. + serialized_dashboard: + type: string + description: >- + The contents of the dashboard in serialized string form. + This field is excluded in List Dashboards responses. Use the + `get dashboard API + `__ + to retrieve an example response, which includes the + ``serialized_dashboard`` field. This field provides the + structure of the JSON string that represents the dashboard's + layout and components. + update_time: + type: string + description: >- + The timestamp of when the dashboard was last updated by the + user. This field is excluded in List Dashboards responses. + warehouse_id: + type: string + description: The warehouse ID used to run the dashboard. responses: '200': description: Success @@ -3029,9 +3260,22 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Get the current published dashboard. + + The caller must be a workspace user with one of the following + entitlements: Workspace access, + + Databricks SQL access, or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the published dashboard. @@ -3068,9 +3312,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Publish the current draft dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard to be published. :param embed_credentials: bool (optional) @@ -3130,9 +3382,17 @@ paths: tags: - dashboards - lakeview - description: |- + description: >- Unpublish the dashboard. + + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the published dashboard. parameters: @@ -3160,12 +3420,18 @@ paths: /api/2.0/lakeview/dashboards/migrate: post: operationId: lakeview_migrate - summary: Migrates a classic SQL dashboard to Lakeview. + summary: >- + Deprecated: Legacy dashboard migration is no longer supported. Use + Lakeview (AI/BI) dashboards tags: - dashboards - lakeview - description: |- - Migrates a classic SQL dashboard to Lakeview. + description: >- + Deprecated: Legacy dashboard migration is no longer supported. Use + Lakeview (AI/BI) dashboards + + instead. + :param source_dashboard_id: str UUID of the dashboard to be migrated. @@ -3236,6 +3502,13 @@ paths: version. + Requires the `Databricks SQL access + `__ + + entitlement. Grant Databricks SQL access in addition to Workspace + access. + + :param dashboard_id: str UUID identifying the dashboard. :param etag: str (optional) @@ -3281,40 +3554,6 @@ paths: message: type: string x-stackql-sdk-source: LakeviewAPI - /api/2.0/lakeview/dashboards/{dashboard_id}/published/embedded: - get: - operationId: lakeview_embedded_get_published_dashboard_embedded - summary: Get the current published dashboard within an embedded context. - tags: - - dashboards - - lakeview_embedded - description: |- - Get the current published dashboard within an embedded context. - - :param dashboard_id: str - UUID identifying the published dashboard. - parameters: - - name: dashboard_id - in: path - required: true - schema: - type: string - description: UUID identifying the published dashboard. - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: LakeviewEmbeddedAPI /api/2.0/lakeview/dashboards/{dashboard_id}/published/tokeninfo: get: operationId: lakeview_embedded_get_published_dashboard_token_info @@ -3329,6 +3568,18 @@ paths: to mint an OAuth token. + The caller must be a workspace user with one of the following + entitlements: Workspace access, + + Databricks SQL access, or Consumer access. + + + Account-level users who are not members of the workspace cannot call + this endpoint, even if the + + dashboard has been shared with them. + + :param dashboard_id: str UUID identifying the published dashboard. :param external_value: str (optional) @@ -3505,6 +3756,7 @@ components: properties: space_id: type: string + description: Genie space ID title: type: string description: Conversation title @@ -3527,11 +3779,22 @@ components: - space_id - title - conversation_id + description: >- + A Genie conversation. Use chat-mode message endpoints for classic chats + and agent-mode response + and item endpoints for agent conversations. Conversation management, feedback, comments, and + attachment operations support both modes. GenieConversationSummary: type: object properties: conversation_id: type: string + agent_type: + $ref: '#/components/schemas/GenieConversationType' + description: >- + Whether this is a classic chat or an agent-mode conversation. Allows + callers to route message retrieval (chat vs. agent endpoint) without + an extra lookup. created_timestamp: type: integer title: @@ -3678,6 +3941,7 @@ components: properties: eval_run_id: type: string + description: The unique identifier for the evaluation run. created_timestamp: type: integer description: >- @@ -3708,6 +3972,9 @@ components: description: User ID who initiated the evaluation run. required: - eval_run_id + description: >- + A benchmark evaluation run. The public benchmark API currently evaluates + chat-mode responses. GenieFeedback: type: object properties: @@ -3939,6 +4206,10 @@ components: title: type: string description: Title of the Genie Space + create_time: + type: string + format: date-time + description: Time when the Genie space was created. description: type: string description: Description of the Genie Space @@ -3959,6 +4230,12 @@ components: which includes the ``serialized_space`` field. This field provides the structure of the JSON string that represents the space's layout and components. + update_time: + type: string + format: date-time + description: >- + Time when the Genie space was last modified, matching the value + shown in the Genie Agent UI. warehouse_id: type: string description: Warehouse associated with the Genie Space @@ -4002,9 +4279,6 @@ components: Visualization generated by Genie for a query result. Use the attachment ID with the download visualization API to retrieve the rendered image. - GetPublishedDashboardEmbeddedResponse: - type: object - properties: {} GetPublishedDashboardTokenInfoResponse: type: object properties: @@ -4210,18 +4484,22 @@ components: properties: content: type: string + description: AI generated message id: type: string - phase: - $ref: '#/components/schemas/ResponsePhase' purpose: $ref: '#/components/schemas/TextAttachmentPurpose' - description: Purpose/intent of this text attachment - verification_metadata: - $ref: '#/components/schemas/VerificationMetadata' description: >- - Metadata for verification phase attachments. Only set when phase = - RESPONSE_PHASE_VERIFYING. + Purpose of this text attachment. A completed message may contain + more than one text attachment (for example a clarifying follow-up + question alongside the final answer); use this field to tell them + apart. ``TEXT_ATTACHMENT_PURPOSE_ANSWER`` marks the final + answer/summary and ``FOLLOW_UP_QUESTION`` marks a clarifying + question. + description: >- + A text response on a conversation message: the answer, the final + summary, or a clarifying + follow-up question, along with optional phase and verification metadata. Thought: type: object properties: @@ -4247,15 +4525,6 @@ components: UnpublishDashboardResponse: type: object properties: {} - VerificationMetadata: - type: object - properties: - index: - type: integer - description: Optional index to help order attachments within the same section - section: - $ref: '#/components/schemas/VerificationSection' - description: Metadata for verification phase attachments DashboardView: type: string x-enum: @@ -4343,6 +4612,19 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + GenieConversationType: + type: string + x-enum: + - GENIE_CONVERSATION_TYPE_AGENT + - GENIE_CONVERSATION_TYPE_CHAT + description: >- + The type of a Genie conversation. Distinguishes an agent-mode + conversation from a classic chat + + conversation so callers can route message retrieval accordingly without + a per-conversation + + lookup. GenieEvalAssessment: type: string x-enum: @@ -4481,8 +4763,6 @@ components: type: string x-enum: - BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION - - BUDGET_EXCEEDED_EXCEPTION - - CERTIFIED_ANSWERS_MISSING_EXCEPTION - CHAT_COMPLETION_CLIENT_EXCEPTION - CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION - CHAT_COMPLETION_NETWORK_EXCEPTION @@ -4491,8 +4771,6 @@ components: - COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION - COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION - COULD_NOT_GET_UC_SCHEMA_EXCEPTION - - DASHBOARD_PERMISSION_DENIED_EXCEPTION - - DELEGATION_NOT_FOUND_EXCEPTION - DEPLOYMENT_NOT_FOUND_EXCEPTION - DESCRIBE_QUERY_INVALID_SQL_ERROR - DESCRIBE_QUERY_TIMEOUT @@ -4515,7 +4793,6 @@ components: - INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION - INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION - INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION - - INVALID_CHAT_COMPLETION_ARGUMENTS_JSON_EXCEPTION - INVALID_CHAT_COMPLETION_JSON_EXCEPTION - INVALID_COMPLETION_REQUEST_EXCEPTION - INVALID_FUNCTION_CALL_EXCEPTION @@ -4532,7 +4809,6 @@ components: - NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE - NO_QUERY_TO_VISUALIZE_EXCEPTION - NO_TABLES_TO_QUERY_EXCEPTION - - PAY_PER_TOKEN_DISABLED_EXCEPTION - RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION - RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION - REPLY_PROCESS_TIMEOUT_EXCEPTION @@ -4628,48 +4904,6 @@ components: query. Rerun the SQL query result by calling [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API. - ``CANCELLED``: Message has been cancelled. - ResponsePhase: - type: string - x-enum: - - RESPONSE_PHASE_THINKING - - RESPONSE_PHASE_VERIFYING - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. SchedulePauseStatus: type: string x-enum: @@ -4740,7 +4974,6 @@ components: - RESULT_MISSING_COLUMNS - RESULT_MISSING_ROWS - SINGLE_CELL_DIFFERENCE - - TRANSIENT_ERROR description: |- Create a collection of name/value pairs. @@ -4782,6 +5015,7 @@ components: type: string x-enum: - FOLLOW_UP_QUESTION + - TEXT_ATTACHMENT_PURPOSE_ANSWER description: Purpose/intent of a text attachment ThoughtType: type: string @@ -4812,19 +5046,6 @@ components: - ``THOUGHT_TYPE_STEPS``: The logical steps taken to compute the answer. The category of a Thought. Additional values may be added in the future. - VerificationSection: - type: string - x-enum: - - VERIFICATION_SECTION_FINAL_DECISION - - VERIFICATION_SECTION_PROPOSED_IMPROVEMENT - - VERIFICATION_SECTION_SQL_EXAMPLES_VALIDATION - - VERIFICATION_SECTION_VERIFICATION_QUERIES - description: >- - Verification workflow section - indicates which stage of verification - this attachment belongs to - - These sections are used for grouping and ordering attachments in the - frontend UI x-stackQL-resources: genie_messages: id: databricks_workspace.dashboards.genie_messages @@ -4869,6 +5090,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + cancel_response: + operation: + $ref: >- + #/paths/~1api~12.0~1genie~1agents~1{agent_id}~1conversations~1{conversation_id}~1responses~1{response_id}~1cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' get_query_result_deprecated: operation: $ref: >- @@ -4942,12 +5170,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - genie_download_message_attachment_visualization: - operation: - $ref: '#/paths/~1api~12.0~1genie~1{name}~1download-visualization/get' - response: - mediaType: application/octet-stream - openAPIDocKey: '200' get: operation: $ref: '#/paths/~1api~12.0~1genie~1spaces~1{space_id}/get' @@ -4982,8 +5204,6 @@ components: #/components/x-stackQL-resources/genie/methods/genie_list_message_comments - $ref: >- #/components/x-stackQL-resources/genie/methods/genie_list_conversation_comments - - $ref: >- - #/components/x-stackQL-resources/genie/methods/genie_download_message_attachment_visualization - $ref: '#/components/x-stackQL-resources/genie/methods/get' - $ref: '#/components/x-stackQL-resources/genie/methods/list' insert: @@ -5032,6 +5252,24 @@ components: - $ref: >- #/components/x-stackQL-resources/genie_conversations/methods/delete replace: [] + genie_message_attachment_visualizations: + id: databricks_workspace.dashboards.genie_message_attachment_visualizations + name: genie_message_attachment_visualizations + title: Genie Message Attachment Visualizations + methods: + download: + operation: + $ref: >- + #/paths/~1api~12.0~1genie~1spaces~1{space_id}~1conversations~1{conversation_id}~1messages~1{message_id}~1attachments~1{attachment_id}~1download-visualization/get + response: + mediaType: application/octet-stream + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] genie_message_attachments: id: databricks_workspace.dashboards.genie_message_attachments name: genie_message_attachments @@ -5360,24 +5598,6 @@ components: update: [] delete: [] replace: [] - published_dashboard_embedded: - id: databricks_workspace.dashboards.published_dashboard_embedded - name: published_dashboard_embedded - title: Published Dashboard Embedded - methods: - embed: - operation: - $ref: >- - #/paths/~1api~12.0~1lakeview~1dashboards~1{dashboard_id}~1published~1embedded/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - replace: [] lakeview_embedded: id: databricks_workspace.dashboards.lakeview_embedded name: lakeview_embedded diff --git a/providers/src/databricks_workspace/v00.00.00000/services/database.yaml b/providers/src/databricks_workspace/v00.00.00000/services/database.yaml index 00f0f7f9..fe321917 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/database.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/database.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.database servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/database/catalogs: post: @@ -21,11 +38,19 @@ paths: summary: Create a Database Catalog. tags: - database - description: |- + description: >- Create a Database Catalog. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Create a catalog + + `__. + + :param catalog: :class:`DatabaseCatalog` + :returns: :class:`DatabaseCatalog` requestBody: content: @@ -33,39 +58,24 @@ paths: schema: type: object properties: - catalog: - type: object - properties: - name: - type: string - database_instance_name: - type: string - description: The name of the DatabaseInstance housing the database. - database_name: - type: string - description: >- - The name of the database (in an instance) associated - with the catalog. - create_database_if_not_exists: - type: boolean - database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - catalog. - database_project_id: - type: string - description: >- - The project_id of the database project associated with - the catalog. - uid: - type: string - required: - - name - - database_instance_name - - database_name + name: + type: string + database_instance_name: + type: string + description: The name of the DatabaseInstance housing the database. + database_name: + type: string + description: >- + The name of the database (in an instance) associated with + the catalog. + create_database_if_not_exists: + type: boolean + uid: + type: string required: - - catalog + - name + - database_instance_name + - database_name responses: '200': description: Success @@ -91,9 +101,16 @@ paths: summary: Create a Database Instance. tags: - database - description: |- + description: >- Create a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Create a project + + `__. + + :param database_instance: :class:`DatabaseInstance` Instance to create. @@ -106,274 +123,260 @@ paths: schema: type: object properties: - database_instance: + name: + type: string + description: >- + The name of the instance. This is the unique identifier for + the instance. + capacity: + type: string + description: >- + The sku of the instance. Valid values are "CU_1", "CU_2", + "CU_4", "CU_8". + child_instance_refs: + type: array + items: + type: object + properties: + branch_time: + type: string + description: >- + Branch time of the ref database instance. For a parent + ref instance, this is the point in time on the parent + instance from which the instance was created. For a + child ref instance, this is the point in time on the + instance from which the child instance was created. + Input: For specifying the point in time to create a + child instance. Optional. Output: Only populated if + provided as input to create a child instance. + effective_lsn: + type: string + description: >- + For a parent ref instance, this is the LSN on the + parent instance from which the instance was created. + For a child ref instance, this is the LSN on the + instance from which the child instance was created. + This is an output only field that contains the value + computed from the input field combined with server + side defaults. Use the field without the effective_ + prefix to set the value. + lsn: + type: string + description: >- + User-specified WAL LSN of the ref database instance. + Input: For specifying the WAL LSN to create a child + instance. Optional. Output: Only populated if provided + as input to create a child instance. + name: + type: string + description: Name of the ref database instance. + uid: + type: string + description: Id of the ref database instance. + description: >- + DatabaseInstanceRef is a reference to a database instance. + It is used in the DatabaseInstance + object to refer to the parent instance of an instance and to refer the child instances of an + instance. To specify as a parent instance during creation of an instance, the lsn and + branch_time fields are optional. If not specified, the child instance will be created from the + latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to + create the child instance. + description: >- + The refs of the child instances. This is only available if + the instance is parent instance. + creation_time: + type: string + description: The timestamp when the instance was created. + creator: + type: string + description: The email of the creator of the instance. + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: >- + Custom tags associated with the instance. This field is only + included on create and update responses. + effective_capacity: + type: string + description: >- + Deprecated. The sku of the instance; this field will always + match the value of capacity. This is an output only field + that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: >- + The recorded custom tags associated with the instance. This + is an output only field that contains the value computed + from the input field combined with server side defaults. Use + the field without the effective_ prefix to set the value. + effective_enable_pg_native_login: + type: boolean + description: >- + Whether the instance has PG native password login enabled. + This is an output only field that contains the value + computed from the input field combined with server side + defaults. Use the field without the effective_ prefix to set + the value. + effective_enable_readable_secondaries: + type: boolean + description: >- + Whether secondaries serving read-only traffic are enabled. + Defaults to false. This is an output only field that + contains the value computed from the input field combined + with server side defaults. Use the field without the + effective_ prefix to set the value. + effective_node_count: + type: integer + description: >- + The number of nodes in the instance, composed of 1 primary + and 0 or more secondaries. Defaults to 1 primary and 0 + secondaries. This is an output only field that contains the + value computed from the input field combined with server + side defaults. Use the field without the effective_ prefix + to set the value. + effective_retention_window_in_days: + type: integer + description: >- + The retention window for the instance. This is the time + window in days for which the historical data is retained. + This is an output only field that contains the value + computed from the input field combined with server side + defaults. Use the field without the effective_ prefix to set + the value. + effective_stopped: + type: boolean + description: >- + Whether the instance is stopped. This is an output only + field that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_usage_policy_id: + type: string + description: >- + The policy that is applied to the instance. This is an + output only field that contains the value computed from the + input field combined with server side defaults. Use the + field without the effective_ prefix to set the value. + enable_pg_native_login: + type: boolean + description: >- + Whether to enable PG native password login on the instance. + Defaults to false. + enable_readable_secondaries: + type: boolean + description: >- + Whether to enable secondaries to serve read-only traffic. + Defaults to false. + node_count: + type: integer + description: >- + The number of nodes in the instance, composed of 1 primary + and 0 or more secondaries. Defaults to 1 primary and 0 + secondaries. This field is input only, see + effective_node_count for the output. + parent_instance_ref: type: object properties: - name: - type: string - description: >- - The name of the instance. This is the unique identifier - for the instance. - capacity: - type: string - description: >- - The sku of the instance. Valid values are "CU_1", - "CU_2", "CU_4", "CU_8". - child_instance_refs: - type: array - items: - type: object - properties: - branch_time: - type: string - description: >- - Branch time of the ref database instance. For a - parent ref instance, this is the point in time on - the parent instance from which the instance was - created. For a child ref instance, this is the - point in time on the instance from which the child - instance was created. Input: For specifying the - point in time to create a child instance. - Optional. Output: Only populated if provided as - input to create a child instance. - effective_lsn: - type: string - description: >- - For a parent ref instance, this is the LSN on the - parent instance from which the instance was - created. For a child ref instance, this is the LSN - on the instance from which the child instance was - created. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - lsn: - type: string - description: >- - User-specified WAL LSN of the ref database - instance. Input: For specifying the WAL LSN to - create a child instance. Optional. Output: Only - populated if provided as input to create a child - instance. - name: - type: string - description: Name of the ref database instance. - uid: - type: string - description: Id of the ref database instance. - description: >- - DatabaseInstanceRef is a reference to a database - instance. It is used in the DatabaseInstance - object to refer to the parent instance of an instance and to refer the child instances of an - instance. To specify as a parent instance during creation of an instance, the lsn and - branch_time fields are optional. If not specified, the child instance will be created from the - latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to - create the child instance. - description: >- - The refs of the child instances. This is only available - if the instance is parent instance. - creation_time: - type: string - description: The timestamp when the instance was created. - creator: + branch_time: type: string - description: The email of the creator of the instance. - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. description: >- - Custom tags associated with the instance. This field is - only included on create and update responses. - effective_capacity: + Branch time of the ref database instance. For a parent + ref instance, this is the point in time on the parent + instance from which the instance was created. For a + child ref instance, this is the point in time on the + instance from which the child instance was created. + Input: For specifying the point in time to create a + child instance. Optional. Output: Only populated if + provided as input to create a child instance. + effective_lsn: type: string description: >- - Deprecated. The sku of the instance; this field will - always match the value of capacity. This is an output + For a parent ref instance, this is the LSN on the parent + instance from which the instance was created. For a + child ref instance, this is the LSN on the instance from + which the child instance was created. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value. - effective_custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. - description: >- - The recorded custom tags associated with the instance. - This is an output only field that contains the value - computed from the input field combined with server side - defaults. Use the field without the effective_ prefix to - set the value. - effective_enable_pg_native_login: - type: boolean - description: >- - Whether the instance has PG native password login - enabled. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_enable_readable_secondaries: - type: boolean - description: >- - Whether secondaries serving read-only traffic are - enabled. Defaults to false. This is an output only field - that contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_node_count: - type: integer - description: >- - The number of nodes in the instance, composed of 1 - primary and 0 or more secondaries. Defaults to 1 primary - and 0 secondaries. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_retention_window_in_days: - type: integer - description: >- - The retention window for the instance. This is the time - window in days for which the historical data is - retained. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_stopped: - type: boolean - description: >- - Whether the instance is stopped. This is an output only - field that contains the value computed from the input - field combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_usage_policy_id: - type: string - description: >- - The policy that is applied to the instance. This is an - output only field that contains the value computed from - the input field combined with server side defaults. Use - the field without the effective_ prefix to set the - value. - enable_pg_native_login: - type: boolean - description: >- - Whether to enable PG native password login on the - instance. Defaults to false. - enable_readable_secondaries: - type: boolean - description: >- - Whether to enable secondaries to serve read-only - traffic. Defaults to false. - node_count: - type: integer - description: >- - The number of nodes in the instance, composed of 1 - primary and 0 or more secondaries. Defaults to 1 primary - and 0 secondaries. This field is input only, see - effective_node_count for the output. - parent_instance_ref: - type: object - properties: - branch_time: - type: string - description: >- - Branch time of the ref database instance. For a - parent ref instance, this is the point in time on - the parent instance from which the instance was - created. For a child ref instance, this is the point - in time on the instance from which the child - instance was created. Input: For specifying the - point in time to create a child instance. Optional. - Output: Only populated if provided as input to - create a child instance. - effective_lsn: - type: string - description: >- - For a parent ref instance, this is the LSN on the - parent instance from which the instance was created. - For a child ref instance, this is the LSN on the - instance from which the child instance was created. - This is an output only field that contains the value - computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - lsn: - type: string - description: >- - User-specified WAL LSN of the ref database instance. - Input: For specifying the WAL LSN to create a child - instance. Optional. Output: Only populated if - provided as input to create a child instance. - name: - type: string - description: Name of the ref database instance. - uid: - type: string - description: Id of the ref database instance. - description: >- - The ref of the parent instance. This is only available - if the instance is child instance. Input: For specifying - the parent instance to create a child instance. - Optional. Output: Only populated if provided as input to - create a child instance. - pg_version: - type: string - description: The version of Postgres running on the instance. - read_only_dns: + lsn: type: string description: >- - The DNS endpoint to connect to the instance for read - only access. This is only available if - enable_readable_secondaries is true. - read_write_dns: - type: string - description: >- - The DNS endpoint to connect to the instance for - read+write access. - retention_window_in_days: - type: integer - description: >- - The retention window for the instance. This is the time - window in days for which the historical data is - retained. The default value is 7 days. Valid values are - 2 to 35 days. - state: + User-specified WAL LSN of the ref database instance. + Input: For specifying the WAL LSN to create a child + instance. Optional. Output: Only populated if provided + as input to create a child instance. + name: type: string - x-enum: - - AVAILABLE - - DELETING - - FAILING_OVER - - STARTING - - STOPPED - - UPDATING - - UPGRADING - description: The current state of the instance. - stopped: - type: boolean - description: >- - Whether to stop the instance. An input only param, see - effective_stopped for the output. + description: Name of the ref database instance. uid: type: string - description: An immutable UUID identifier for the instance. - usage_policy_id: - type: string - description: The desired usage policy to associate with the instance. - required: - - name - description: Instance to create. + description: Id of the ref database instance. + description: >- + The ref of the parent instance. This is only available if + the instance is child instance. Input: For specifying the + parent instance to create a child instance. Optional. + Output: Only populated if provided as input to create a + child instance. + pg_version: + type: string + description: The version of Postgres running on the instance. + read_only_dns: + type: string + description: >- + The DNS endpoint to connect to the instance for read only + access. This is only available if + enable_readable_secondaries is true. + read_write_dns: + type: string + description: >- + The DNS endpoint to connect to the instance for read+write + access. + retention_window_in_days: + type: integer + description: >- + The retention window for the instance. This is the time + window in days for which the historical data is retained. + The default value is 7 days. Valid values are 2 to 35 days. + state: + type: string + x-enum: + - AVAILABLE + - DELETING + - FAILING_OVER + - STARTING + - STOPPED + - UPDATING + description: The current state of the instance. + stopped: + type: boolean + description: >- + Whether to stop the instance. An input only param, see + effective_stopped for the output. + uid: + type: string + description: An immutable UUID identifier for the instance. + usage_policy_id: + type: string + description: The desired usage policy to associate with the instance. required: - - database_instance + - name responses: '200': description: Success @@ -398,9 +401,16 @@ paths: summary: List Database Instances. tags: - database - description: |- + description: >- List Database Instances. + + For new workloads, Databricks recommends the Postgres API equivalent: + `List projects + + `__. + + :param page_size: int (optional) Upper bound for items returned. The maximum value is 100. :param page_token: str (optional) @@ -447,13 +457,23 @@ paths: summary: Create a role for a Database Instance. tags: - database - description: |- + description: >- Create a role for a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Create a role + + `__. + + :param instance_name: str + :param database_instance_role: :class:`DatabaseInstanceRole` + :param database_instance_name: str (optional) + :returns: :class:`DatabaseInstanceRole` parameters: - name: instance_name @@ -472,65 +492,56 @@ paths: schema: type: object properties: - database_instance_role: + name: + type: string + description: >- + The name of the role. This is the unique identifier for the + role in an instance. + attributes: type: object properties: - name: - type: string - description: >- - The name of the role. This is the unique identifier for - the role in an instance. - attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: >- - The desired API-exposed Postgres role attribute to - associate with the role. Optional. - effective_attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: >- - The attributes that are applied to the role. This is an - output only field that contains the value computed from - the input field combined with server side defaults. Use - the field without the effective_ prefix to set the - value. - identity_type: - type: string - x-enum: - - GROUP - - PG_ONLY - - SERVICE_PRINCIPAL - - USER - description: The type of the role. - instance_name: - type: string - membership_role: - type: string - x-enum: - - DATABRICKS_SUPERUSER - description: >- - An enum value for a standard role that this role is a - member of. - required: - - name + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: >- + The desired API-exposed Postgres role attribute to associate + with the role. Optional. + effective_attributes: + type: object + properties: + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: >- + The attributes that are applied to the role. This is an + output only field that contains the value computed from the + input field combined with server side defaults. Use the + field without the effective_ prefix to set the value. + identity_type: + type: string + x-enum: + - GROUP + - PG_ONLY + - SERVICE_PRINCIPAL + - USER + description: The type of the role. + instance_name: + type: string + membership_role: + type: string + x-enum: + - DATABRICKS_SUPERUSER description: >- - A DatabaseInstanceRole represents a Postgres role in a - database instance. + An enum value for a standard role that this role is a member + of. required: - - database_instance_role + - name responses: '200': description: Success @@ -552,20 +563,17 @@ paths: x-stackql-sdk-source: DatabaseAPI get: operationId: database_list_database_instance_roles - summary: >- - START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage - < PUBLIC_PREVIEW. With more + summary: List roles for a Database Instance. tags: - database description: >- - START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage - < PUBLIC_PREVIEW. With more + List roles for a Database Instance. - recent Lakebase V2 plans, we don't plan to ever advance these to - PUBLIC_PREVIEW. These APIs will - remain effectively undocumented/UI-only and we'll aim for a new public - roles API as part of V2 PuPr. + For new workloads, Databricks recommends the Postgres API equivalent: + `List roles + + `__. :param instance_name: str @@ -641,38 +649,29 @@ paths: schema: type: object properties: - table: - type: object - properties: - name: - type: string - database_instance_name: - type: string - description: >- - Name of the target database instance. This is required - when creating database tables in standard catalogs. This - is optional when creating database tables in registered - catalogs. If this field is specified when creating - database tables in registered catalogs, the database - instance name MUST match that of the registered catalog - (or the request will be rejected). - logical_database_name: - type: string - description: >- - Target Postgres database object (logical database) name - for this table. When creating a table in a standard - catalog, this field is required. In this scenario, - specifying this field will allow targeting an arbitrary - postgres database. Registration of database tables via - /database/tables is currently only supported in standard - catalogs. - table_serving_url: - type: string - description: Data serving REST API URL for this table - required: - - name + name: + type: string + database_instance_name: + type: string + description: >- + Name of the target database instance. This is required when + creating database tables in standard catalogs. This is + optional when creating database tables in registered + catalogs. If this field is specified when creating database + tables in registered catalogs, the database instance name + MUST match that of the registered catalog (or the request + will be rejected). + logical_database_name: + type: string + description: >- + Target Postgres database object (logical database) name for + this table. When creating a table in a standard catalog, + this field is required. In this scenario, specifying this + field will allow targeting an arbitrary postgres database. + Registration of database tables via /database/tables is + currently only supported in standard catalogs. required: - - table + - name responses: '200': description: Success @@ -698,11 +697,19 @@ paths: summary: Create a Synced Database Table. tags: - database - description: |- + description: >- Create a Synced Database Table. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Create a synced table + + `__. + + :param synced_table: :class:`SyncedDatabaseTable` + :returns: :class:`SyncedDatabaseTable` requestBody: content: @@ -710,575 +717,448 @@ paths: schema: type: object properties: - synced_table: + name: + type: string + data_synchronization_status: type: object properties: - name: - type: string - data_synchronization_status: + continuous_update_status: type: object properties: - continuous_update_status: + initial_pipeline_sync_progress: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. - description: Progress of the initial data synchronization. - last_processed_commit_version: - type: integer - description: >- - The last source table Delta version that was - successfully synced to the synced table. - timestamp: - type: string + estimated_completion_time_seconds: + type: number description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. This is when the data is available in the - synced table. - description: >- - Detailed status of a synced table. Shown if the - synced table is in the SYNCED_CONTINUOUS_UPDATE - or the SYNCED_UPDATING_PIPELINE_RESOURCES state. - detailed_state: - type: string - x-enum: - - SYNCED_TABLED_OFFLINE - - SYNCED_TABLE_OFFLINE_FAILED - - SYNCED_TABLE_ONLINE - - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE - - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE - - SYNCED_TABLE_ONLINE_PIPELINE_FAILED - - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE - - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES - - SYNCED_TABLE_PROVISIONING - - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT - - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES - description: The state of the synced table. - failed_status: - type: object - properties: - last_processed_commit_version: + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: type: integer description: >- - The last source table Delta version that was - successfully synced to the synced table. The - last source table Delta version that was synced - to the synced table. Only populated if the table - is still synced and available for serving. - timestamp: + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string + x-enum: + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. Only populated if the table is still - synced and available for serving. - description: >- - Detailed status of a synced table. Shown if the - synced table is in the OFFLINE_FAILED or the - SYNCED_PIPELINE_FAILED state. - last_sync: - type: object - properties: - delta_table_sync_info: - type: object - properties: - delta_commit_timestamp: - type: string - delta_commit_version: - type: integer - description: >- - The Delta Lake commit version that was last - successfully synced. - sync_end_timestamp: - type: string + The current phase of the data synchronization + pipeline. + sync_progress_completion: + type: number description: >- - The end timestamp of the most recent successful - synchronization. This is the time when the data - is available in the synced table. - sync_start_timestamp: - type: string + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer description: >- - The starting timestamp of the most recent - successful synchronization from the source table - to the destination (synced) table. Note this is - the starting timestamp of the sync operation, - not the end time. E.g., for a batch, this is the - time when the sync operation started. + The total number of rows that need to be synced + in this update. This number may be an estimate. + description: Progress of the initial data synchronization. + last_processed_commit_version: + type: integer description: >- - Summary of the last successful synchronization from - source to destination. Will always be present if - there has been a successful sync. Even if the most - recent syncs have failed. Limitation: The only - exception is if the synced table is doing a FULL - REFRESH, then the last sync information will not be - available until the full refresh is complete. This - limitation will be addressed in a future version. - This top-level field is a convenience for consumers - who want easy access to last sync information - without having to traverse detailed_status. - message: + The last source table Delta version that was + successfully synced to the synced table. + timestamp: type: string description: >- - A text description of the current state of the + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. This is when the data is available in the synced table. - pipeline_id: + description: >- + Detailed status of a synced table. Shown if the synced + table is in the SYNCED_CONTINUOUS_UPDATE + or the SYNCED_UPDATING_PIPELINE_RESOURCES state. + detailed_state: + type: string + x-enum: + - SYNCED_TABLED_OFFLINE + - SYNCED_TABLE_OFFLINE_FAILED + - SYNCED_TABLE_ONLINE + - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE + - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE + - SYNCED_TABLE_ONLINE_PIPELINE_FAILED + - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE + - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES + - SYNCED_TABLE_PROVISIONING + - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT + - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES + description: The state of the synced table. + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + description: >- + The last source table Delta version that was + successfully synced to the synced table. The last + source table Delta version that was synced to the + synced table. Only populated if the table is still + synced and available for serving. + timestamp: type: string description: >- - ID of the associated pipeline. The pipeline ID may - have been provided by the client (in the case of bin - packing), or generated by the server (when creating - a new pipeline). - provisioning_status: + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. Only populated if the table is still synced + and available for serving. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the OFFLINE_FAILED or the + SYNCED_PIPELINE_FAILED state. + last_sync: + type: object + properties: + delta_table_sync_info: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. + delta_commit_timestamp: + type: string + delta_commit_version: + type: integer description: >- - Details about initial data synchronization. Only - populated when in the - PROVISIONING_INITIAL_SNAPSHOT state. + The Delta Lake commit version that was last + successfully synced. + sync_end_timestamp: + type: string + description: >- + The end timestamp of the most recent successful + synchronization. This is the time when the data is + available in the synced table. + sync_start_timestamp: + type: string description: >- - Detailed status of a synced table. Shown if the - synced table is in the - PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. - triggered_update_status: + The starting timestamp of the most recent successful + synchronization from the source table to the + destination (synced) table. Note this is the + starting timestamp of the sync operation, not the + end time. E.g., for a batch, this is the time when + the sync operation started. + description: >- + Summary of the last successful synchronization from + source to destination. Will always be present if there + has been a successful sync. Even if the most recent + syncs have failed. Limitation: The only exception is if + the synced table is doing a FULL REFRESH, then the last + sync information will not be available until the full + refresh is complete. This limitation will be addressed + in a future version. This top-level field is a + convenience for consumers who want easy access to last + sync information without having to traverse + detailed_status. + message: + type: string + description: >- + A text description of the current state of the synced + table. + pipeline_id: + type: string + description: >- + ID of the associated pipeline. The pipeline ID may have + been provided by the client (in the case of bin + packing), or generated by the server (when creating a + new pipeline). + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: type: object properties: - last_processed_commit_version: + estimated_completion_time_seconds: + type: number + description: >- + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: type: integer description: >- - The last source table Delta version that was - successfully synced to the synced table. - timestamp: + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string + x-enum: + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. This is when the data is available in the - synced table. - triggered_update_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. - description: >- - Progress of the active data synchronization + The current phase of the data synchronization pipeline. + sync_progress_completion: + type: number + description: >- + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer + description: >- + The total number of rows that need to be synced + in this update. This number may be an estimate. description: >- - Detailed status of a synced table. Shown if the - synced table is in the SYNCED_TRIGGERED_UPDATE - or the SYNCED_NO_PENDING_UPDATE state. - description: Synced Table data synchronization status - database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - table. - database_instance_name: - type: string - description: >- - Name of the target database instance. This is required - when creating synced database tables in standard - catalogs. This is optional when creating synced database - tables in registered catalogs. If this field is - specified when creating synced database tables in - registered catalogs, the database instance name MUST - match that of the registered catalog (or the request - will be rejected). - database_project_id: - type: string - description: >- - The project_id of the database project associated with - the table. - effective_database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - table. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_database_instance_name: - type: string - description: >- - The name of the database instance that this table is - registered to. This field is always returned, and for - tables inside database catalogs is inferred database - instance associated with the catalog. This is an output - only field that contains the value computed from the - input field combined with server side defaults. Use the - field without the effective_ prefix to set the value. - effective_database_project_id: - type: string - description: >- - The project_id of the database project associated with - the table. This is an output only field that contains - the value computed from the input field combined with - server side defaults. Use the field without the - effective_ prefix to set the value. - effective_logical_database_name: - type: string - description: >- - The name of the logical database that this table is - registered to. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - logical_database_name: - type: string - description: >- - Target Postgres database object (logical database) name - for this table. When creating a synced table in a - registered Postgres catalog, the target Postgres - database name is inferred to be that of the registered - catalog. If this field is specified in this scenario, - the Postgres database name MUST match that of the - registered catalog (or the request will be rejected). - When creating a synced table in a standard catalog, this - field is required. In this scenario, specifying this - field will allow targeting an arbitrary postgres - database. Note that this has implications for the - ``create_database_objects_is_missing`` field in - ``spec``. - spec: + Details about initial data synchronization. Only + populated when in the PROVISIONING_INITIAL_SNAPSHOT + state. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the + PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. + triggered_update_status: type: object properties: - accelerated_sync: - type: boolean - description: >- - When true, enables accelerated sync mode for the - initial data load. This significantly improves - performance for large tables. Requires - workspace-level enablement. - create_database_objects_if_missing: - type: boolean + last_processed_commit_version: + type: integer description: >- - If true, the synced table's logical database and - schema resources in PG will be created if they do - not already exist. - existing_pipeline_id: + The last source table Delta version that was + successfully synced to the synced table. + timestamp: type: string description: >- - At most one of existing_pipeline_id and - new_pipeline_spec should be defined. If - existing_pipeline_id is defined, the synced table - will be bin packed into the existing pipeline - referenced. This avoids creating a new pipeline and - allows sharing existing compute. In this case, the - scheduling_policy of this synced table must match - the scheduling policy of the existing pipeline. - extra_columns: - type: array - items: - type: object - properties: - column_name: - type: string - description: Name of the column. - column_type: - type: string - description: >- - PostgreSQL type of the column, for example - "tsvector" or "vector(1024)". - compute: - type: string - description: >- - SQL expression used to compute the column's - value, for example "to_tsvector('english', - content)". - maintenance: - type: string - x-enum: - - DEFAULT_VALUE - - STORED_GENERATED - description: >- - How the column's value is populated and kept - up to date. - required: - - column_name - - column_type - description: >- - An extra PostgreSQL column to add to the synced - table. - description: >- - Extra PostgreSQL-only columns to add to the synced - table. - extra_index_definitions: - type: array - items: - type: object - properties: - name: - type: string - description: >- - Name of the index as it will appear in - PostgreSQL. - definition: - type: string - description: >- - The definition portion of a CREATE INDEX - statement, placed after ON table_name. For - example: USING hnsw (embedding - vector_cosine_ops) WITH (m = 16, - ef_construction = 64). - creation_point: - type: string - x-enum: - - CREATION_POINT_AFTER_DATA_LOAD - description: >- - When the index should be created relative to - the initial data load. - required: - - name - - definition - description: >- - Definition of a secondary index to create on the - synced table. - description: Secondary indexes to create on the synced table. - new_pipeline_spec: + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. This is when the data is available in the + synced table. + triggered_update_progress: type: object properties: - budget_policy_id: - type: string + estimated_completion_time_seconds: + type: number description: >- - Budget policy to set on the newly created - pipeline. - pipeline_channel: + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: + type: integer + description: >- + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string x-enum: - - CURRENT - - PREVIEW + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - Release channel of the underlying pipeline's - runtime. Some source table configurations (e.g., - read-time CDF) require PREVIEW. Defaults to - CURRENT if not specified. - storage_catalog: - type: string + The current phase of the data synchronization + pipeline. + sync_progress_completion: + type: number description: >- - This field needs to be specified if the - destination catalog is a managed postgres - catalog. UC catalog for the pipeline to store - intermediate files (checkpoints, event logs - etc). This needs to be a standard catalog where - the user has permissions to create Delta tables. - storage_schema: - type: string + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer description: >- - This field needs to be specified if the - destination catalog is a managed postgres - catalog. UC schema for the pipeline to store - intermediate files (checkpoints, event logs - etc). This needs to be in the standard catalog - where the user has permissions to create Delta - tables. - description: >- - At most one of existing_pipeline_id and - new_pipeline_spec should be defined. If - new_pipeline_spec is defined, a new pipeline is - created for this synced table. The location pointed - to is used to store intermediate files (checkpoints, - event logs etc). The caller must have write - permissions to create Delta tables in the specified - catalog and schema. Again, note this requires write - permissions, whereas the source table only requires - read permissions. - primary_key_columns: - type: array - items: - type: string + The number of rows that have been synced in this + update. + total_row_count: + type: integer + description: >- + The total number of rows that need to be synced + in this update. This number may be an estimate. description: >- - Primary Key columns to be used for data - insert/update in the destination. - scheduling_policy: + Progress of the active data synchronization + pipeline. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the SYNCED_TRIGGERED_UPDATE + or the SYNCED_NO_PENDING_UPDATE state. + description: Synced Table data synchronization status + database_instance_name: + type: string + description: >- + Name of the target database instance. This is required when + creating synced database tables in standard catalogs. This + is optional when creating synced database tables in + registered catalogs. If this field is specified when + creating synced database tables in registered catalogs, the + database instance name MUST match that of the registered + catalog (or the request will be rejected). + effective_database_instance_name: + type: string + description: >- + The name of the database instance that this table is + registered to. This field is always returned, and for tables + inside database catalogs is inferred database instance + associated with the catalog. This is an output only field + that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_logical_database_name: + type: string + description: >- + The name of the logical database that this table is + registered to. This is an output only field that contains + the value computed from the input field combined with server + side defaults. Use the field without the effective_ prefix + to set the value. + logical_database_name: + type: string + description: >- + Target Postgres database object (logical database) name for + this table. When creating a synced table in a registered + Postgres catalog, the target Postgres database name is + inferred to be that of the registered catalog. If this field + is specified in this scenario, the Postgres database name + MUST match that of the registered catalog (or the request + will be rejected). When creating a synced table in a + standard catalog, this field is required. In this scenario, + specifying this field will allow targeting an arbitrary + postgres database. Note that this has implications for the + ``create_database_objects_is_missing`` field in ``spec``. + spec: + type: object + properties: + accelerated_sync: + type: boolean + description: >- + When true, enables accelerated sync mode for the initial + data load. This significantly improves performance for + large tables. Requires workspace-level enablement. + create_database_objects_if_missing: + type: boolean + description: >- + If true, the synced table's logical database and schema + resources in PG will be created if they do not already + exist. + existing_pipeline_id: + type: string + description: >- + At most one of existing_pipeline_id and + new_pipeline_spec should be defined. If + existing_pipeline_id is defined, the synced table will + be bin packed into the existing pipeline referenced. + This avoids creating a new pipeline and allows sharing + existing compute. In this case, the scheduling_policy of + this synced table must match the scheduling policy of + the existing pipeline. + new_pipeline_spec: + type: object + properties: + budget_policy_id: type: string - x-enum: - - CONTINUOUS - - SNAPSHOT - - TRIGGERED - description: Scheduling policy of the underlying pipeline. - source_table_full_name: + description: Budget policy to set on the newly created pipeline. + storage_catalog: type: string description: >- - Three-part (catalog, schema, table) name of the - source Delta table. - timeseries_key: + This field needs to be specified if the destination + catalog is a managed postgres catalog. UC catalog + for the pipeline to store intermediate files + (checkpoints, event logs etc). This needs to be a + standard catalog where the user has permissions to + create Delta tables. + storage_schema: type: string description: >- - Time series key to deduplicate (tie-break) rows with - the same primary key. - type_overrides: - type: array - items: - type: object - properties: - column_name: - type: string - description: >- - Name of the source column whose target - PostgreSQL type should be overridden. - pg_type: - type: string - x-enum: - - PG_SPECIFIC_TYPE_HALFVEC - - PG_SPECIFIC_TYPE_VARCHAR - - PG_SPECIFIC_TYPE_VECTOR - description: >- - PostgreSQL-specific target type to use for the - column. - size: - type: integer - description: >- - Size parameter for the target type, for types - that take one (e.g. vector dimension, varchar - length). Required when the chosen pg_type - needs a size. - required: - - column_name - - pg_type - description: >- - Overrides the default Delta-to-PostgreSQL type - mapping for a single column. - description: >- - Override the default Delta->PG type mapping for - specific columns. A TypeOverride with - PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid - pg_type must be set. - description: Specification of a synced database table. - table_serving_url: - type: string - description: Data serving REST API URL for this table - unity_catalog_provisioning_state: + This field needs to be specified if the destination + catalog is a managed postgres catalog. UC schema for + the pipeline to store intermediate files + (checkpoints, event logs etc). This needs to be in + the standard catalog where the user has permissions + to create Delta tables. + description: >- + At most one of existing_pipeline_id and + new_pipeline_spec should be defined. If + new_pipeline_spec is defined, a new pipeline is created + for this synced table. The location pointed to is used + to store intermediate files (checkpoints, event logs + etc). The caller must have write permissions to create + Delta tables in the specified catalog and schema. Again, + note this requires write permissions, whereas the source + table only requires read permissions. + primary_key_columns: + type: array + items: + type: string + description: >- + Primary Key columns to be used for data insert/update in + the destination. + scheduling_policy: type: string x-enum: - - ACTIVE - - DEGRADED - - DELETING - - FAILED - - PROVISIONING - - UPDATING + - CONTINUOUS + - SNAPSHOT + - TRIGGERED + description: Scheduling policy of the underlying pipeline. + source_table_full_name: + type: string + description: >- + Three-part (catalog, schema, table) name of the source + Delta table. + timeseries_key: + type: string description: >- - The provisioning state of the synced table entity in - Unity Catalog. This is distinct from the state of the - data synchronization pipeline (i.e. the table may be in - "ACTIVE" but the pipeline may be in "PROVISIONING" as it - runs asynchronously). - required: - - name + Time series key to deduplicate (tie-break) rows with the + same primary key. + type_overrides: + type: array + items: + type: object + properties: + column_name: + type: string + description: >- + Name of the source column whose target PostgreSQL + type should be overridden. + pg_type: + type: string + x-enum: + - PG_SPECIFIC_TYPE_HALFVEC + - PG_SPECIFIC_TYPE_VARCHAR + - PG_SPECIFIC_TYPE_VECTOR + description: >- + PostgreSQL-specific target type to use for the + column. + size: + type: integer + description: >- + Size parameter for the target type, for types that + take one (e.g. vector dimension, varchar length). + Required when the chosen pg_type needs a size. + required: + - column_name + - pg_type + description: >- + Overrides the default Delta-to-PostgreSQL type mapping + for a single column. + description: >- + Override the default Delta->PG type mapping for specific + columns. A TypeOverride with + PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid + pg_type must be set. + description: Specification of a synced database table. + unity_catalog_provisioning_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - DELETING + - FAILED + - PROVISIONING + - UPDATING + description: >- + The provisioning state of the synced table entity in Unity + Catalog. This is distinct from the state of the data + synchronization pipeline (i.e. the table may be in "ACTIVE" + but the pipeline may be in "PROVISIONING" as it runs + asynchronously). required: - - synced_table + - name responses: '200': description: Success @@ -1304,9 +1184,16 @@ paths: summary: Delete a Database Catalog. tags: - database - description: |- + description: >- Delete a Database Catalog. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Delete a catalog + + `__. + + :param name: str parameters: - name: name @@ -1334,11 +1221,19 @@ paths: summary: Get a Database Catalog. tags: - database - description: |- + description: >- Get a Database Catalog. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Get a catalog + + `__. + + :param name: str + :returns: :class:`DatabaseCatalog` parameters: - name: name @@ -1402,40 +1297,24 @@ paths: schema: type: object properties: - database_catalog: - type: object - properties: - name: - type: string - database_instance_name: - type: string - description: The name of the DatabaseInstance housing the database. - database_name: - type: string - description: >- - The name of the database (in an instance) associated - with the catalog. - create_database_if_not_exists: - type: boolean - database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - catalog. - database_project_id: - type: string - description: >- - The project_id of the database project associated with - the catalog. - uid: - type: string - required: - - name - - database_instance_name - - database_name - description: Note that updating a database catalog is not yet supported. + name: + type: string + database_instance_name: + type: string + description: The name of the DatabaseInstance housing the database. + database_name: + type: string + description: >- + The name of the database (in an instance) associated with + the catalog. + create_database_if_not_exists: + type: boolean + uid: + type: string required: - - database_catalog + - name + - database_instance_name + - database_name responses: '200': description: Success @@ -1461,9 +1340,16 @@ paths: summary: Delete a Database Instance. tags: - database - description: |- + description: >- Delete a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Delete a project + + `__. + + :param name: str Name of the instance to delete. :param force: bool (optional) @@ -1517,9 +1403,16 @@ paths: summary: Get a Database Instance. tags: - database - description: |- + description: >- Get a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Get a project + + `__. + + :param name: str Name of the cluster to get. @@ -1555,12 +1448,23 @@ paths: summary: Update a Database Instance. tags: - database - description: |- + description: >- Update a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalents: + `Update a project + + `__ and + `Update an endpoint + + `__. + + :param name: str The name of the instance. This is the unique identifier for the instance. :param database_instance: :class:`DatabaseInstance` + :param update_mask: str The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags, specify custom_tags in the update_mask with an empty custom_tags map. @@ -1590,277 +1494,260 @@ paths: schema: type: object properties: - database_instance: + name: + type: string + description: >- + The name of the instance. This is the unique identifier for + the instance. + capacity: + type: string + description: >- + The sku of the instance. Valid values are "CU_1", "CU_2", + "CU_4", "CU_8". + child_instance_refs: + type: array + items: + type: object + properties: + branch_time: + type: string + description: >- + Branch time of the ref database instance. For a parent + ref instance, this is the point in time on the parent + instance from which the instance was created. For a + child ref instance, this is the point in time on the + instance from which the child instance was created. + Input: For specifying the point in time to create a + child instance. Optional. Output: Only populated if + provided as input to create a child instance. + effective_lsn: + type: string + description: >- + For a parent ref instance, this is the LSN on the + parent instance from which the instance was created. + For a child ref instance, this is the LSN on the + instance from which the child instance was created. + This is an output only field that contains the value + computed from the input field combined with server + side defaults. Use the field without the effective_ + prefix to set the value. + lsn: + type: string + description: >- + User-specified WAL LSN of the ref database instance. + Input: For specifying the WAL LSN to create a child + instance. Optional. Output: Only populated if provided + as input to create a child instance. + name: + type: string + description: Name of the ref database instance. + uid: + type: string + description: Id of the ref database instance. + description: >- + DatabaseInstanceRef is a reference to a database instance. + It is used in the DatabaseInstance + object to refer to the parent instance of an instance and to refer the child instances of an + instance. To specify as a parent instance during creation of an instance, the lsn and + branch_time fields are optional. If not specified, the child instance will be created from the + latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to + create the child instance. + description: >- + The refs of the child instances. This is only available if + the instance is parent instance. + creation_time: + type: string + description: The timestamp when the instance was created. + creator: + type: string + description: The email of the creator of the instance. + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: >- + Custom tags associated with the instance. This field is only + included on create and update responses. + effective_capacity: + type: string + description: >- + Deprecated. The sku of the instance; this field will always + match the value of capacity. This is an output only field + that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: >- + The recorded custom tags associated with the instance. This + is an output only field that contains the value computed + from the input field combined with server side defaults. Use + the field without the effective_ prefix to set the value. + effective_enable_pg_native_login: + type: boolean + description: >- + Whether the instance has PG native password login enabled. + This is an output only field that contains the value + computed from the input field combined with server side + defaults. Use the field without the effective_ prefix to set + the value. + effective_enable_readable_secondaries: + type: boolean + description: >- + Whether secondaries serving read-only traffic are enabled. + Defaults to false. This is an output only field that + contains the value computed from the input field combined + with server side defaults. Use the field without the + effective_ prefix to set the value. + effective_node_count: + type: integer + description: >- + The number of nodes in the instance, composed of 1 primary + and 0 or more secondaries. Defaults to 1 primary and 0 + secondaries. This is an output only field that contains the + value computed from the input field combined with server + side defaults. Use the field without the effective_ prefix + to set the value. + effective_retention_window_in_days: + type: integer + description: >- + The retention window for the instance. This is the time + window in days for which the historical data is retained. + This is an output only field that contains the value + computed from the input field combined with server side + defaults. Use the field without the effective_ prefix to set + the value. + effective_stopped: + type: boolean + description: >- + Whether the instance is stopped. This is an output only + field that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_usage_policy_id: + type: string + description: >- + The policy that is applied to the instance. This is an + output only field that contains the value computed from the + input field combined with server side defaults. Use the + field without the effective_ prefix to set the value. + enable_pg_native_login: + type: boolean + description: >- + Whether to enable PG native password login on the instance. + Defaults to false. + enable_readable_secondaries: + type: boolean + description: >- + Whether to enable secondaries to serve read-only traffic. + Defaults to false. + node_count: + type: integer + description: >- + The number of nodes in the instance, composed of 1 primary + and 0 or more secondaries. Defaults to 1 primary and 0 + secondaries. This field is input only, see + effective_node_count for the output. + parent_instance_ref: type: object properties: - name: + branch_time: type: string description: >- - The name of the instance. This is the unique identifier - for the instance. - capacity: + Branch time of the ref database instance. For a parent + ref instance, this is the point in time on the parent + instance from which the instance was created. For a + child ref instance, this is the point in time on the + instance from which the child instance was created. + Input: For specifying the point in time to create a + child instance. Optional. Output: Only populated if + provided as input to create a child instance. + effective_lsn: type: string description: >- - The sku of the instance. Valid values are "CU_1", - "CU_2", "CU_4", "CU_8". - child_instance_refs: - type: array - items: - type: object - properties: - branch_time: - type: string - description: >- - Branch time of the ref database instance. For a - parent ref instance, this is the point in time on - the parent instance from which the instance was - created. For a child ref instance, this is the - point in time on the instance from which the child - instance was created. Input: For specifying the - point in time to create a child instance. - Optional. Output: Only populated if provided as - input to create a child instance. - effective_lsn: - type: string - description: >- - For a parent ref instance, this is the LSN on the - parent instance from which the instance was - created. For a child ref instance, this is the LSN - on the instance from which the child instance was - created. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - lsn: - type: string - description: >- - User-specified WAL LSN of the ref database - instance. Input: For specifying the WAL LSN to - create a child instance. Optional. Output: Only - populated if provided as input to create a child - instance. - name: - type: string - description: Name of the ref database instance. - uid: - type: string - description: Id of the ref database instance. - description: >- - DatabaseInstanceRef is a reference to a database - instance. It is used in the DatabaseInstance - object to refer to the parent instance of an instance and to refer the child instances of an - instance. To specify as a parent instance during creation of an instance, the lsn and - branch_time fields are optional. If not specified, the child instance will be created from the - latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to - create the child instance. - description: >- - The refs of the child instances. This is only available - if the instance is parent instance. - creation_time: - type: string - description: The timestamp when the instance was created. - creator: - type: string - description: The email of the creator of the instance. - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. - description: >- - Custom tags associated with the instance. This field is - only included on create and update responses. - effective_capacity: - type: string - description: >- - Deprecated. The sku of the instance; this field will - always match the value of capacity. This is an output + For a parent ref instance, this is the LSN on the parent + instance from which the instance was created. For a + child ref instance, this is the LSN on the instance from + which the child instance was created. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value. - effective_custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. - description: >- - The recorded custom tags associated with the instance. - This is an output only field that contains the value - computed from the input field combined with server side - defaults. Use the field without the effective_ prefix to - set the value. - effective_enable_pg_native_login: - type: boolean - description: >- - Whether the instance has PG native password login - enabled. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_enable_readable_secondaries: - type: boolean - description: >- - Whether secondaries serving read-only traffic are - enabled. Defaults to false. This is an output only field - that contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_node_count: - type: integer - description: >- - The number of nodes in the instance, composed of 1 - primary and 0 or more secondaries. Defaults to 1 primary - and 0 secondaries. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_retention_window_in_days: - type: integer - description: >- - The retention window for the instance. This is the time - window in days for which the historical data is - retained. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_stopped: - type: boolean - description: >- - Whether the instance is stopped. This is an output only - field that contains the value computed from the input - field combined with server side defaults. Use the field - without the effective_ prefix to set the value. - effective_usage_policy_id: - type: string - description: >- - The policy that is applied to the instance. This is an - output only field that contains the value computed from - the input field combined with server side defaults. Use - the field without the effective_ prefix to set the - value. - enable_pg_native_login: - type: boolean - description: >- - Whether to enable PG native password login on the - instance. Defaults to false. - enable_readable_secondaries: - type: boolean - description: >- - Whether to enable secondaries to serve read-only - traffic. Defaults to false. - node_count: - type: integer - description: >- - The number of nodes in the instance, composed of 1 - primary and 0 or more secondaries. Defaults to 1 primary - and 0 secondaries. This field is input only, see - effective_node_count for the output. - parent_instance_ref: - type: object - properties: - branch_time: - type: string - description: >- - Branch time of the ref database instance. For a - parent ref instance, this is the point in time on - the parent instance from which the instance was - created. For a child ref instance, this is the point - in time on the instance from which the child - instance was created. Input: For specifying the - point in time to create a child instance. Optional. - Output: Only populated if provided as input to - create a child instance. - effective_lsn: - type: string - description: >- - For a parent ref instance, this is the LSN on the - parent instance from which the instance was created. - For a child ref instance, this is the LSN on the - instance from which the child instance was created. - This is an output only field that contains the value - computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - lsn: - type: string - description: >- - User-specified WAL LSN of the ref database instance. - Input: For specifying the WAL LSN to create a child - instance. Optional. Output: Only populated if - provided as input to create a child instance. - name: - type: string - description: Name of the ref database instance. - uid: - type: string - description: Id of the ref database instance. - description: >- - The ref of the parent instance. This is only available - if the instance is child instance. Input: For specifying - the parent instance to create a child instance. - Optional. Output: Only populated if provided as input to - create a child instance. - pg_version: - type: string - description: The version of Postgres running on the instance. - read_only_dns: - type: string - description: >- - The DNS endpoint to connect to the instance for read - only access. This is only available if - enable_readable_secondaries is true. - read_write_dns: + lsn: type: string description: >- - The DNS endpoint to connect to the instance for - read+write access. - retention_window_in_days: - type: integer - description: >- - The retention window for the instance. This is the time - window in days for which the historical data is - retained. The default value is 7 days. Valid values are - 2 to 35 days. - state: + User-specified WAL LSN of the ref database instance. + Input: For specifying the WAL LSN to create a child + instance. Optional. Output: Only populated if provided + as input to create a child instance. + name: type: string - x-enum: - - AVAILABLE - - DELETING - - FAILING_OVER - - STARTING - - STOPPED - - UPDATING - - UPGRADING - description: The current state of the instance. - stopped: - type: boolean - description: >- - Whether to stop the instance. An input only param, see - effective_stopped for the output. + description: Name of the ref database instance. uid: type: string - description: An immutable UUID identifier for the instance. - usage_policy_id: - type: string - description: The desired usage policy to associate with the instance. - required: - - name + description: Id of the ref database instance. + description: >- + The ref of the parent instance. This is only available if + the instance is child instance. Input: For specifying the + parent instance to create a child instance. Optional. + Output: Only populated if provided as input to create a + child instance. + pg_version: + type: string + description: The version of Postgres running on the instance. + read_only_dns: + type: string + description: >- + The DNS endpoint to connect to the instance for read only + access. This is only available if + enable_readable_secondaries is true. + read_write_dns: + type: string description: >- - A DatabaseInstance represents a logical Postgres instance, - comprised of both compute and - storage. + The DNS endpoint to connect to the instance for read+write + access. + retention_window_in_days: + type: integer + description: >- + The retention window for the instance. This is the time + window in days for which the historical data is retained. + The default value is 7 days. Valid values are 2 to 35 days. + state: + type: string + x-enum: + - AVAILABLE + - DELETING + - FAILING_OVER + - STARTING + - STOPPED + - UPDATING + description: The current state of the instance. + stopped: + type: boolean + description: >- + Whether to stop the instance. An input only param, see + effective_stopped for the output. + uid: + type: string + description: An immutable UUID identifier for the instance. + usage_policy_id: + type: string + description: The desired usage policy to associate with the instance. required: - - database_instance + - name responses: '200': description: Success @@ -1886,11 +1773,20 @@ paths: summary: Deletes a role for a Database Instance. tags: - database - description: |- + description: >- Deletes a role for a Database Instance. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Delete a role + + `__. + + :param instance_name: str + :param name: str + :param allow_missing: bool (optional) This is the AIP standard name for the equivalent of Postgres' ``IF EXISTS`` option :param reassign_owned_to: str (optional) @@ -1938,56 +1834,20 @@ paths: summary: Gets a role for a Database Instance. tags: - database - description: |- + description: >- Gets a role for a Database Instance. - :param instance_name: str - :param name: str - :returns: :class:`DatabaseInstanceRole` - parameters: - - name: instance_name - in: path - required: true - schema: - type: string - - name: name - in: path - required: true - schema: - type: string - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DatabaseInstanceRole' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: DatabaseAPI - patch: - operationId: database_update_database_instance_role - summary: Update a role for a Database Instance. - tags: - - database - description: |- - Update a role for a Database Instance. + For new workloads, Databricks recommends the Postgres API equivalent: + `Get a role + + `__. + :param instance_name: str + :param name: str - The name of the role. This is the unique identifier for the role in an instance. - :param database_instance_role: :class:`DatabaseInstanceRole` - :param database_instance_name: str (optional) + :returns: :class:`DatabaseInstanceRole` parameters: @@ -2001,79 +1861,6 @@ paths: required: true schema: type: string - description: >- - The name of the role. This is the unique identifier for the role in - an instance. - - name: database_instance_name - in: query - required: false - schema: - type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - database_instance_role: - type: object - properties: - name: - type: string - description: >- - The name of the role. This is the unique identifier for - the role in an instance. - attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: >- - The desired API-exposed Postgres role attribute to - associate with the role. Optional. - effective_attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: >- - The attributes that are applied to the role. This is an - output only field that contains the value computed from - the input field combined with server side defaults. Use - the field without the effective_ prefix to set the - value. - identity_type: - type: string - x-enum: - - GROUP - - PG_ONLY - - SERVICE_PRINCIPAL - - USER - description: The type of the role. - instance_name: - type: string - membership_role: - type: string - x-enum: - - DATABRICKS_SUPERUSER - description: >- - An enum value for a standard role that this role is a - member of. - required: - - name - description: >- - A DatabaseInstanceRole represents a Postgres role in a - database instance. - required: - - database_instance_role responses: '200': description: Success @@ -2166,10 +1953,18 @@ paths: summary: Delete a Synced Database Table. tags: - database - description: |- + description: >- Delete a Synced Database Table. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Delete a synced table + + `__. + + :param name: str + :param purge_data: bool (optional) Optional. When set to true, the actual PostgreSQL table will be dropped from the database. parameters: @@ -2206,11 +2001,19 @@ paths: summary: Get a Synced Database Table. tags: - database - description: |- + description: >- Get a Synced Database Table. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Get a synced table + + `__. + + :param name: str + :returns: :class:`SyncedDatabaseTable` parameters: - name: name @@ -2274,578 +2077,448 @@ paths: schema: type: object properties: - synced_table: + name: + type: string + data_synchronization_status: type: object properties: - name: - type: string - data_synchronization_status: + continuous_update_status: type: object properties: - continuous_update_status: + initial_pipeline_sync_progress: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. - description: Progress of the initial data synchronization. - last_processed_commit_version: - type: integer - description: >- - The last source table Delta version that was - successfully synced to the synced table. - timestamp: - type: string + estimated_completion_time_seconds: + type: number description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. This is when the data is available in the - synced table. - description: >- - Detailed status of a synced table. Shown if the - synced table is in the SYNCED_CONTINUOUS_UPDATE - or the SYNCED_UPDATING_PIPELINE_RESOURCES state. - detailed_state: - type: string - x-enum: - - SYNCED_TABLED_OFFLINE - - SYNCED_TABLE_OFFLINE_FAILED - - SYNCED_TABLE_ONLINE - - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE - - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE - - SYNCED_TABLE_ONLINE_PIPELINE_FAILED - - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE - - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES - - SYNCED_TABLE_PROVISIONING - - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT - - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES - description: The state of the synced table. - failed_status: - type: object - properties: - last_processed_commit_version: + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: type: integer description: >- - The last source table Delta version that was - successfully synced to the synced table. The - last source table Delta version that was synced - to the synced table. Only populated if the table - is still synced and available for serving. - timestamp: + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string + x-enum: + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. Only populated if the table is still - synced and available for serving. - description: >- - Detailed status of a synced table. Shown if the - synced table is in the OFFLINE_FAILED or the - SYNCED_PIPELINE_FAILED state. - last_sync: - type: object - properties: - delta_table_sync_info: - type: object - properties: - delta_commit_timestamp: - type: string - delta_commit_version: - type: integer - description: >- - The Delta Lake commit version that was last - successfully synced. - sync_end_timestamp: - type: string + The current phase of the data synchronization + pipeline. + sync_progress_completion: + type: number description: >- - The end timestamp of the most recent successful - synchronization. This is the time when the data - is available in the synced table. - sync_start_timestamp: - type: string + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer description: >- - The starting timestamp of the most recent - successful synchronization from the source table - to the destination (synced) table. Note this is - the starting timestamp of the sync operation, - not the end time. E.g., for a batch, this is the - time when the sync operation started. + The total number of rows that need to be synced + in this update. This number may be an estimate. + description: Progress of the initial data synchronization. + last_processed_commit_version: + type: integer description: >- - Summary of the last successful synchronization from - source to destination. Will always be present if - there has been a successful sync. Even if the most - recent syncs have failed. Limitation: The only - exception is if the synced table is doing a FULL - REFRESH, then the last sync information will not be - available until the full refresh is complete. This - limitation will be addressed in a future version. - This top-level field is a convenience for consumers - who want easy access to last sync information - without having to traverse detailed_status. - message: + The last source table Delta version that was + successfully synced to the synced table. + timestamp: type: string description: >- - A text description of the current state of the + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. This is when the data is available in the synced table. - pipeline_id: + description: >- + Detailed status of a synced table. Shown if the synced + table is in the SYNCED_CONTINUOUS_UPDATE + or the SYNCED_UPDATING_PIPELINE_RESOURCES state. + detailed_state: + type: string + x-enum: + - SYNCED_TABLED_OFFLINE + - SYNCED_TABLE_OFFLINE_FAILED + - SYNCED_TABLE_ONLINE + - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE + - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE + - SYNCED_TABLE_ONLINE_PIPELINE_FAILED + - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE + - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES + - SYNCED_TABLE_PROVISIONING + - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT + - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES + description: The state of the synced table. + failed_status: + type: object + properties: + last_processed_commit_version: + type: integer + description: >- + The last source table Delta version that was + successfully synced to the synced table. The last + source table Delta version that was synced to the + synced table. Only populated if the table is still + synced and available for serving. + timestamp: type: string description: >- - ID of the associated pipeline. The pipeline ID may - have been provided by the client (in the case of bin - packing), or generated by the server (when creating - a new pipeline). - provisioning_status: + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. Only populated if the table is still synced + and available for serving. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the OFFLINE_FAILED or the + SYNCED_PIPELINE_FAILED state. + last_sync: + type: object + properties: + delta_table_sync_info: type: object properties: - initial_pipeline_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. + delta_commit_timestamp: + type: string + delta_commit_version: + type: integer description: >- - Details about initial data synchronization. Only - populated when in the - PROVISIONING_INITIAL_SNAPSHOT state. + The Delta Lake commit version that was last + successfully synced. + sync_end_timestamp: + type: string description: >- - Detailed status of a synced table. Shown if the - synced table is in the - PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. - triggered_update_status: + The end timestamp of the most recent successful + synchronization. This is the time when the data is + available in the synced table. + sync_start_timestamp: + type: string + description: >- + The starting timestamp of the most recent successful + synchronization from the source table to the + destination (synced) table. Note this is the + starting timestamp of the sync operation, not the + end time. E.g., for a batch, this is the time when + the sync operation started. + description: >- + Summary of the last successful synchronization from + source to destination. Will always be present if there + has been a successful sync. Even if the most recent + syncs have failed. Limitation: The only exception is if + the synced table is doing a FULL REFRESH, then the last + sync information will not be available until the full + refresh is complete. This limitation will be addressed + in a future version. This top-level field is a + convenience for consumers who want easy access to last + sync information without having to traverse + detailed_status. + message: + type: string + description: >- + A text description of the current state of the synced + table. + pipeline_id: + type: string + description: >- + ID of the associated pipeline. The pipeline ID may have + been provided by the client (in the case of bin + packing), or generated by the server (when creating a + new pipeline). + provisioning_status: + type: object + properties: + initial_pipeline_sync_progress: type: object properties: - last_processed_commit_version: + estimated_completion_time_seconds: + type: number + description: >- + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: type: integer description: >- - The last source table Delta version that was - successfully synced to the synced table. - timestamp: + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string + x-enum: + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - The end timestamp of the last time any data was - synchronized from the source table to the synced - table. This is when the data is available in the - synced table. - triggered_update_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: >- - The estimated time remaining to complete - this update in seconds. - latest_version_currently_processing: - type: integer - description: >- - The source table Delta version that was last - processed by the pipeline. The pipeline may - not have completely processed this version - yet. - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: >- - The current phase of the data - synchronization pipeline. - sync_progress_completion: - type: number - description: >- - The completion ratio of this update. This is - a number between 0 and 1. - synced_row_count: - type: integer - description: >- - The number of rows that have been synced in - this update. - total_row_count: - type: integer - description: >- - The total number of rows that need to be - synced in this update. This number may be an - estimate. - description: >- - Progress of the active data synchronization + The current phase of the data synchronization pipeline. + sync_progress_completion: + type: number + description: >- + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer + description: >- + The number of rows that have been synced in this + update. + total_row_count: + type: integer + description: >- + The total number of rows that need to be synced + in this update. This number may be an estimate. description: >- - Detailed status of a synced table. Shown if the - synced table is in the SYNCED_TRIGGERED_UPDATE - or the SYNCED_NO_PENDING_UPDATE state. - description: Synced Table data synchronization status - database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - table. - database_instance_name: - type: string - description: >- - Name of the target database instance. This is required - when creating synced database tables in standard - catalogs. This is optional when creating synced database - tables in registered catalogs. If this field is - specified when creating synced database tables in - registered catalogs, the database instance name MUST - match that of the registered catalog (or the request - will be rejected). - database_project_id: - type: string - description: >- - The project_id of the database project associated with - the table. - effective_database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the - table. This is an output only field that contains the - value computed from the input field combined with server - side defaults. Use the field without the effective_ - prefix to set the value. - effective_database_instance_name: - type: string - description: >- - The name of the database instance that this table is - registered to. This field is always returned, and for - tables inside database catalogs is inferred database - instance associated with the catalog. This is an output - only field that contains the value computed from the - input field combined with server side defaults. Use the - field without the effective_ prefix to set the value. - effective_database_project_id: - type: string - description: >- - The project_id of the database project associated with - the table. This is an output only field that contains - the value computed from the input field combined with - server side defaults. Use the field without the - effective_ prefix to set the value. - effective_logical_database_name: - type: string - description: >- - The name of the logical database that this table is - registered to. This is an output only field that - contains the value computed from the input field - combined with server side defaults. Use the field - without the effective_ prefix to set the value. - logical_database_name: - type: string - description: >- - Target Postgres database object (logical database) name - for this table. When creating a synced table in a - registered Postgres catalog, the target Postgres - database name is inferred to be that of the registered - catalog. If this field is specified in this scenario, - the Postgres database name MUST match that of the - registered catalog (or the request will be rejected). - When creating a synced table in a standard catalog, this - field is required. In this scenario, specifying this - field will allow targeting an arbitrary postgres - database. Note that this has implications for the - ``create_database_objects_is_missing`` field in - ``spec``. - spec: + Details about initial data synchronization. Only + populated when in the PROVISIONING_INITIAL_SNAPSHOT + state. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the + PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. + triggered_update_status: type: object properties: - accelerated_sync: - type: boolean - description: >- - When true, enables accelerated sync mode for the - initial data load. This significantly improves - performance for large tables. Requires - workspace-level enablement. - create_database_objects_if_missing: - type: boolean + last_processed_commit_version: + type: integer description: >- - If true, the synced table's logical database and - schema resources in PG will be created if they do - not already exist. - existing_pipeline_id: + The last source table Delta version that was + successfully synced to the synced table. + timestamp: type: string description: >- - At most one of existing_pipeline_id and - new_pipeline_spec should be defined. If - existing_pipeline_id is defined, the synced table - will be bin packed into the existing pipeline - referenced. This avoids creating a new pipeline and - allows sharing existing compute. In this case, the - scheduling_policy of this synced table must match - the scheduling policy of the existing pipeline. - extra_columns: - type: array - items: - type: object - properties: - column_name: - type: string - description: Name of the column. - column_type: - type: string - description: >- - PostgreSQL type of the column, for example - "tsvector" or "vector(1024)". - compute: - type: string - description: >- - SQL expression used to compute the column's - value, for example "to_tsvector('english', - content)". - maintenance: - type: string - x-enum: - - DEFAULT_VALUE - - STORED_GENERATED - description: >- - How the column's value is populated and kept - up to date. - required: - - column_name - - column_type - description: >- - An extra PostgreSQL column to add to the synced - table. - description: >- - Extra PostgreSQL-only columns to add to the synced - table. - extra_index_definitions: - type: array - items: - type: object - properties: - name: - type: string - description: >- - Name of the index as it will appear in - PostgreSQL. - definition: - type: string - description: >- - The definition portion of a CREATE INDEX - statement, placed after ON table_name. For - example: USING hnsw (embedding - vector_cosine_ops) WITH (m = 16, - ef_construction = 64). - creation_point: - type: string - x-enum: - - CREATION_POINT_AFTER_DATA_LOAD - description: >- - When the index should be created relative to - the initial data load. - required: - - name - - definition - description: >- - Definition of a secondary index to create on the - synced table. - description: Secondary indexes to create on the synced table. - new_pipeline_spec: + The end timestamp of the last time any data was + synchronized from the source table to the synced + table. This is when the data is available in the + synced table. + triggered_update_progress: type: object properties: - budget_policy_id: - type: string + estimated_completion_time_seconds: + type: number description: >- - Budget policy to set on the newly created - pipeline. - pipeline_channel: + The estimated time remaining to complete this + update in seconds. + latest_version_currently_processing: + type: integer + description: >- + The source table Delta version that was last + processed by the pipeline. The pipeline may not + have completely processed this version yet. + provisioning_phase: type: string x-enum: - - CURRENT - - PREVIEW + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN description: >- - Release channel of the underlying pipeline's - runtime. Some source table configurations (e.g., - read-time CDF) require PREVIEW. Defaults to - CURRENT if not specified. - storage_catalog: - type: string + The current phase of the data synchronization + pipeline. + sync_progress_completion: + type: number description: >- - This field needs to be specified if the - destination catalog is a managed postgres - catalog. UC catalog for the pipeline to store - intermediate files (checkpoints, event logs - etc). This needs to be a standard catalog where - the user has permissions to create Delta tables. - storage_schema: - type: string + The completion ratio of this update. This is a + number between 0 and 1. + synced_row_count: + type: integer description: >- - This field needs to be specified if the - destination catalog is a managed postgres - catalog. UC schema for the pipeline to store - intermediate files (checkpoints, event logs - etc). This needs to be in the standard catalog - where the user has permissions to create Delta - tables. - description: >- - At most one of existing_pipeline_id and - new_pipeline_spec should be defined. If - new_pipeline_spec is defined, a new pipeline is - created for this synced table. The location pointed - to is used to store intermediate files (checkpoints, - event logs etc). The caller must have write - permissions to create Delta tables in the specified - catalog and schema. Again, note this requires write - permissions, whereas the source table only requires - read permissions. - primary_key_columns: - type: array - items: - type: string + The number of rows that have been synced in this + update. + total_row_count: + type: integer + description: >- + The total number of rows that need to be synced + in this update. This number may be an estimate. description: >- - Primary Key columns to be used for data - insert/update in the destination. - scheduling_policy: + Progress of the active data synchronization + pipeline. + description: >- + Detailed status of a synced table. Shown if the synced + table is in the SYNCED_TRIGGERED_UPDATE + or the SYNCED_NO_PENDING_UPDATE state. + description: Synced Table data synchronization status + database_instance_name: + type: string + description: >- + Name of the target database instance. This is required when + creating synced database tables in standard catalogs. This + is optional when creating synced database tables in + registered catalogs. If this field is specified when + creating synced database tables in registered catalogs, the + database instance name MUST match that of the registered + catalog (or the request will be rejected). + effective_database_instance_name: + type: string + description: >- + The name of the database instance that this table is + registered to. This field is always returned, and for tables + inside database catalogs is inferred database instance + associated with the catalog. This is an output only field + that contains the value computed from the input field + combined with server side defaults. Use the field without + the effective_ prefix to set the value. + effective_logical_database_name: + type: string + description: >- + The name of the logical database that this table is + registered to. This is an output only field that contains + the value computed from the input field combined with server + side defaults. Use the field without the effective_ prefix + to set the value. + logical_database_name: + type: string + description: >- + Target Postgres database object (logical database) name for + this table. When creating a synced table in a registered + Postgres catalog, the target Postgres database name is + inferred to be that of the registered catalog. If this field + is specified in this scenario, the Postgres database name + MUST match that of the registered catalog (or the request + will be rejected). When creating a synced table in a + standard catalog, this field is required. In this scenario, + specifying this field will allow targeting an arbitrary + postgres database. Note that this has implications for the + ``create_database_objects_is_missing`` field in ``spec``. + spec: + type: object + properties: + accelerated_sync: + type: boolean + description: >- + When true, enables accelerated sync mode for the initial + data load. This significantly improves performance for + large tables. Requires workspace-level enablement. + create_database_objects_if_missing: + type: boolean + description: >- + If true, the synced table's logical database and schema + resources in PG will be created if they do not already + exist. + existing_pipeline_id: + type: string + description: >- + At most one of existing_pipeline_id and + new_pipeline_spec should be defined. If + existing_pipeline_id is defined, the synced table will + be bin packed into the existing pipeline referenced. + This avoids creating a new pipeline and allows sharing + existing compute. In this case, the scheduling_policy of + this synced table must match the scheduling policy of + the existing pipeline. + new_pipeline_spec: + type: object + properties: + budget_policy_id: type: string - x-enum: - - CONTINUOUS - - SNAPSHOT - - TRIGGERED - description: Scheduling policy of the underlying pipeline. - source_table_full_name: + description: Budget policy to set on the newly created pipeline. + storage_catalog: type: string description: >- - Three-part (catalog, schema, table) name of the - source Delta table. - timeseries_key: + This field needs to be specified if the destination + catalog is a managed postgres catalog. UC catalog + for the pipeline to store intermediate files + (checkpoints, event logs etc). This needs to be a + standard catalog where the user has permissions to + create Delta tables. + storage_schema: type: string description: >- - Time series key to deduplicate (tie-break) rows with - the same primary key. - type_overrides: - type: array - items: - type: object - properties: - column_name: - type: string - description: >- - Name of the source column whose target - PostgreSQL type should be overridden. - pg_type: - type: string - x-enum: - - PG_SPECIFIC_TYPE_HALFVEC - - PG_SPECIFIC_TYPE_VARCHAR - - PG_SPECIFIC_TYPE_VECTOR - description: >- - PostgreSQL-specific target type to use for the - column. - size: - type: integer - description: >- - Size parameter for the target type, for types - that take one (e.g. vector dimension, varchar - length). Required when the chosen pg_type - needs a size. - required: - - column_name - - pg_type - description: >- - Overrides the default Delta-to-PostgreSQL type - mapping for a single column. - description: >- - Override the default Delta->PG type mapping for - specific columns. A TypeOverride with - PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid - pg_type must be set. - description: Specification of a synced database table. - table_serving_url: - type: string - description: Data serving REST API URL for this table - unity_catalog_provisioning_state: + This field needs to be specified if the destination + catalog is a managed postgres catalog. UC schema for + the pipeline to store intermediate files + (checkpoints, event logs etc). This needs to be in + the standard catalog where the user has permissions + to create Delta tables. + description: >- + At most one of existing_pipeline_id and + new_pipeline_spec should be defined. If + new_pipeline_spec is defined, a new pipeline is created + for this synced table. The location pointed to is used + to store intermediate files (checkpoints, event logs + etc). The caller must have write permissions to create + Delta tables in the specified catalog and schema. Again, + note this requires write permissions, whereas the source + table only requires read permissions. + primary_key_columns: + type: array + items: + type: string + description: >- + Primary Key columns to be used for data insert/update in + the destination. + scheduling_policy: type: string x-enum: - - ACTIVE - - DEGRADED - - DELETING - - FAILED - - PROVISIONING - - UPDATING + - CONTINUOUS + - SNAPSHOT + - TRIGGERED + description: Scheduling policy of the underlying pipeline. + source_table_full_name: + type: string description: >- - The provisioning state of the synced table entity in - Unity Catalog. This is distinct from the state of the - data synchronization pipeline (i.e. the table may be in - "ACTIVE" but the pipeline may be in "PROVISIONING" as it - runs asynchronously). - required: - - name + Three-part (catalog, schema, table) name of the source + Delta table. + timeseries_key: + type: string + description: >- + Time series key to deduplicate (tie-break) rows with the + same primary key. + type_overrides: + type: array + items: + type: object + properties: + column_name: + type: string + description: >- + Name of the source column whose target PostgreSQL + type should be overridden. + pg_type: + type: string + x-enum: + - PG_SPECIFIC_TYPE_HALFVEC + - PG_SPECIFIC_TYPE_VARCHAR + - PG_SPECIFIC_TYPE_VECTOR + description: >- + PostgreSQL-specific target type to use for the + column. + size: + type: integer + description: >- + Size parameter for the target type, for types that + take one (e.g. vector dimension, varchar length). + Required when the chosen pg_type needs a size. + required: + - column_name + - pg_type + description: >- + Overrides the default Delta-to-PostgreSQL type mapping + for a single column. + description: >- + Override the default Delta->PG type mapping for specific + columns. A TypeOverride with + PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid + pg_type must be set. + description: Specification of a synced database table. + unity_catalog_provisioning_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - DELETING + - FAILED + - PROVISIONING + - UPDATING description: >- - Note that updating a synced database table is not yet - supported. + The provisioning state of the synced table entity in Unity + Catalog. This is distinct from the state of the data + synchronization pipeline (i.e. the table may be in "ACTIVE" + but the pipeline may be in "PROVISIONING" as it runs + asynchronously). required: - - synced_table + - name responses: '200': description: Success @@ -2865,54 +2538,6 @@ paths: message: type: string x-stackql-sdk-source: DatabaseAPI - /api/2.0/database/instances/{name}/failover: - post: - operationId: database_failover_database_instance - summary: Failover the primary node of a Database Instance to a secondary. - tags: - - database - description: |- - Failover the primary node of a Database Instance to a secondary. - - :param name: str - Name of the instance to failover. - :param failover_target_database_instance_name: str (optional) - - :returns: :class:`DatabaseInstance` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Name of the instance to failover. - requestBody: - content: - application/json: - schema: - type: object - properties: - failover_target_database_instance_name: - type: string - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DatabaseInstance' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: DatabaseAPI /api/2.0/database/instances:findByUid: get: operationId: database_find_database_instance_by_uid @@ -2958,9 +2583,16 @@ paths: summary: Generates a credential that can be used to access database instances. tags: - database - description: |- + description: >- Generates a credential that can be used to access database instances. + + For new workloads, Databricks recommends the Postgres API equivalent: + `Generate a database credential + + `__. + + :param claims: List[:class:`RequestedClaims`] (optional) A set of UC permissions to add to the credential. We verify that the caller has the necessary permissions in UC and include a reference in the token. Postgres uses that token to give the @@ -2971,6 +2603,7 @@ paths: Instances to request a credential for. At least one of instance_names or claims must be specified. :param request_id: str (optional) + :returns: :class:`DatabaseCredential` requestBody: content: @@ -3094,11 +2727,11 @@ paths: /api/2.0/database/instances/{instance_name}/synced_tables: get: operationId: database_list_synced_database_tables - summary: This API is currently unimplemented, but exposed for Terraform support. + summary: List synced database tables in a Database Instance. tags: - database description: |- - This API is currently unimplemented, but exposed for Terraform support. + List synced database tables in a Database Instance. :param instance_name: str Name of the instance to get synced tables for. @@ -3148,39 +2781,6 @@ paths: message: type: string x-stackql-sdk-source: DatabaseAPI - /api/2.0/database/instances/{name}/upgrade: - patch: - operationId: database_upgrade_instance_to_autoscaling - summary: Upgrade a Database Instance to Autoscaling. - tags: - - database - description: |- - Upgrade a Database Instance to Autoscaling. - - :param name: str - Name of the instance to upgrade. - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Name of the instance to upgrade. - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: DatabaseAPI components: schemas: CustomTag: @@ -3206,12 +2806,6 @@ components: catalog. create_database_if_not_exists: type: boolean - database_branch_id: - type: string - description: The branch_id of the database branch associated with the catalog. - database_project_id: - type: string - description: The project_id of the database project associated with the catalog. uid: type: string required: @@ -3493,9 +3087,6 @@ components: targeting an arbitrary postgres database. Registration of database tables via /database/tables is currently only supported in standard catalogs. - table_serving_url: - type: string - description: Data serving REST API URL for this table required: - name DeltaTableSyncInfo: @@ -3551,12 +3142,6 @@ components: budget_policy_id: type: string description: Budget policy to set on the newly created pipeline. - pipeline_channel: - $ref: '#/components/schemas/PipelineChannel' - description: >- - Release channel of the underlying pipeline's runtime. Some source - table configurations (e.g., read-time CDF) require PREVIEW. Defaults - to CURRENT if not specified. storage_catalog: type: string description: >- @@ -3601,9 +3186,6 @@ components: data_synchronization_status: $ref: '#/components/schemas/SyncedTableStatus' description: Synced Table data synchronization status - database_branch_id: - type: string - description: The branch_id of the database branch associated with the table. database_instance_name: type: string description: >- @@ -3613,16 +3195,6 @@ components: field is specified when creating synced database tables in registered catalogs, the database instance name MUST match that of the registered catalog (or the request will be rejected). - database_project_id: - type: string - description: The project_id of the database project associated with the table. - effective_database_branch_id: - type: string - description: >- - The branch_id of the database branch associated with the table. This - is an output only field that contains the value computed from the - input field combined with server side defaults. Use the field - without the effective_ prefix to set the value. effective_database_instance_name: type: string description: >- @@ -3632,13 +3204,6 @@ components: This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value. - effective_database_project_id: - type: string - description: >- - The project_id of the database project associated with the table. - This is an output only field that contains the value computed from - the input field combined with server side defaults. Use the field - without the effective_ prefix to set the value. effective_logical_database_name: type: string description: >- @@ -3661,9 +3226,6 @@ components: ``create_database_objects_is_missing`` field in ``spec``. spec: $ref: '#/components/schemas/SyncedTableSpec' - table_serving_url: - type: string - description: Data serving REST API URL for this table unity_catalog_provisioning_state: $ref: '#/components/schemas/ProvisioningInfoState' description: >- @@ -3794,16 +3356,6 @@ components: creating a new pipeline and allows sharing existing compute. In this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline. - extra_columns: - type: array - items: - $ref: '#/components/schemas/SyncedTableSpecExtraColumn' - description: Extra PostgreSQL-only columns to add to the synced table. - extra_index_definitions: - type: array - items: - $ref: '#/components/schemas/SyncedTableSpecSecondaryIndex' - description: Secondary indexes to create on the synced table. new_pipeline_spec: $ref: '#/components/schemas/NewPipelineSpec' description: >- @@ -3841,47 +3393,6 @@ components: TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set. description: Specification of a synced database table. - SyncedTableSpecExtraColumn: - type: object - properties: - column_name: - type: string - description: Name of the column. - column_type: - type: string - description: >- - PostgreSQL type of the column, for example "tsvector" or - "vector(1024)". - compute: - type: string - description: >- - SQL expression used to compute the column's value, for example - "to_tsvector('english', content)". - maintenance: - $ref: '#/components/schemas/SyncedTableSpecExtraColumnMaintenance' - required: - - column_name - - column_type - description: An extra PostgreSQL column to add to the synced table. - SyncedTableSpecSecondaryIndex: - type: object - properties: - name: - type: string - description: Name of the index as it will appear in PostgreSQL. - definition: - type: string - description: >- - The definition portion of a CREATE INDEX statement, placed after ON - table_name. For example: USING hnsw (embedding vector_cosine_ops) - WITH (m = 16, ef_construction = 64). - creation_point: - $ref: '#/components/schemas/SyncedTableSpecSecondaryIndexCreationPoint' - description: When the index should be created relative to the initial data load. - required: - - name - - definition - description: Definition of a secondary index to create on the synced table. SyncedTableSpecTypeOverride: type: object properties: @@ -4020,7 +3531,6 @@ components: - STARTING - STOPPED - UPDATING - - UPGRADING description: |- Create a collection of name/value pairs. @@ -4058,19 +3568,6 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - PipelineChannel: - type: string - x-enum: - - CURRENT - - PREVIEW - description: >- - Release channel of the underlying pipeline's runtime. PREVIEW provides - early access to the - - latest features but may be less stable. Some source table configurations - (e.g., read-time CDF) - - require PREVIEW. Defaults to CURRENT if not specified. ProvisioningInfoState: type: string x-enum: @@ -4208,12 +3705,6 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - SyncedTableSpecExtraColumnMaintenance: - type: string - x-enum: - - DEFAULT_VALUE - - STORED_GENERATED - description: How the column's value is populated and kept up to date. SyncedTableSpecPgSpecificType: type: string x-enum: @@ -4223,11 +3714,6 @@ components: description: >- PostgreSQL-specific target types that can override the default Delta-to-PG mapping. - SyncedTableSpecSecondaryIndexCreationPoint: - type: string - x-enum: - - CREATION_POINT_AFTER_DATA_LOAD - description: Controls when the index is created relative to the initial data load. SyncedTableState: type: string x-enum: @@ -4504,48 +3990,6 @@ components: - $ref: >- #/components/x-stackQL-resources/synced_database_tables/methods/delete replace: [] - database: - id: databricks_workspace.database.database - name: database - title: Database - methods: - database_update_database_instance_role: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1database~1instances~1{instance_name}~1roles~1{name}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - database_failover_database_instance: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1database~1instances~1{name}~1failover/post' - response: - mediaType: application/json - openAPIDocKey: '200' - database_upgrade_instance_to_autoscaling: - operation: - $ref: '#/paths/~1api~12.0~1database~1instances~1{name}~1upgrade/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/database/methods/database_failover_database_instance - update: - - $ref: >- - #/components/x-stackQL-resources/database/methods/database_update_database_instance_role - - $ref: >- - #/components/x-stackQL-resources/database/methods/database_upgrade_instance_to_autoscaling - delete: [] - replace: [] database_credentials: id: databricks_workspace.database.database_credentials name: database_credentials diff --git a/providers/src/databricks_workspace/v00.00.00000/services/dataclassification.yaml b/providers/src/databricks_workspace/v00.00.00000/services/dataclassification.yaml new file mode 100644 index 00000000..d40d5e70 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/dataclassification.yaml @@ -0,0 +1,513 @@ +openapi: 3.0.0 +info: + title: Databricks Dataclassification API (workspace) + description: >- + OpenAPI specification for the Databricks dataclassification service + (workspace-level APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.dataclassification +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/data-classification/v1/catalogs/{catalog_name}/config: + post: + operationId: data_classification_create_catalog_config + summary: Create Data Classification configuration for a catalog. + tags: + - dataclassification + - data_classification + description: >- + Create Data Classification configuration for a catalog. + + + Creates a new config resource, which enables Data Classification for the + specified catalog. + + + - The config must not already exist for the catalog. + + + :param parent: str + Parent resource in the format: catalogs/{catalog_name} + :param catalog_config: :class:`CatalogConfig` + The configuration to create. + + :returns: :class:`CatalogConfig` + parameters: + - name: catalog_name + in: path + required: true + schema: + type: string + description: >- + The `catalog_name` segment of the `parent` resource name + (`catalogs/{catalog_name}`). Parent resource in the format: + catalogs/{catalog_name} + requestBody: + content: + application/json: + schema: + type: object + properties: + auto_tag_configs: + type: array + items: + type: object + properties: + classification_tag: + type: string + description: >- + The Classification Tag. For built-in classes this is a + system tag (e.g., "class.name", "class.location"); for + custom classes it is a user-defined governance tag + key. + auto_tagging_mode: + type: string + x-enum: + - AUTO_TAGGING_DISABLED + - AUTO_TAGGING_ENABLED + description: >- + Whether auto-tagging is enabled or disabled for this + classification tag. + required: + - classification_tag + - auto_tagging_mode + description: >- + Auto-tagging configuration for a classification tag. When + enabled, detected columns are + automatically tagged with Unity Catalog tags. + description: >- + List of auto-tagging configurations for this catalog. Empty + list means no auto-tagging is enabled. + excluded_schemas: + type: object + properties: + names: + type: array + items: + type: string + description: >- + Schema names, each relative to the parent catalog. Must + not be empty. + required: + - names + description: >- + Schemas to exclude from the scan, each named relative to the + parent catalog. If specified, all schemas except the + specified ones will be scanned. Mutually exclusive with + ``included_schemas``: only one may be set per request. If + neither ``included_schemas`` nor ``excluded_schemas`` is + set, all schemas are scanned. + included_schemas: + type: object + properties: + names: + type: array + items: + type: string + description: >- + Schema names, each relative to the parent catalog. Must + not be empty. + required: + - names + description: >- + Schemas to include in the scan, each named relative to the + parent catalog. If specified, only listed schemas will be + scanned. Mutually exclusive with ``excluded_schemas``: only + one may be set per request. If neither ``included_schemas`` + nor ``excluded_schemas`` is set, all schemas are scanned. + name: + type: string + description: 'Resource name in the format: catalogs/{catalog_name}/config.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogConfig' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DataClassificationAPI + delete: + operationId: data_classification_delete_catalog_config + summary: Delete Data Classification configuration for a catalog. + tags: + - dataclassification + - data_classification + description: |- + Delete Data Classification configuration for a catalog. + + :param name: str + Resource name in the format: catalogs/{catalog_name}/config + parameters: + - name: catalog_name + in: path + required: true + schema: + type: string + description: >- + The `catalog_name` segment of the `name` resource name + (`catalogs/{catalog_name}/config`). Resource name in the format: + catalogs/{catalog_name}/config + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DataClassificationAPI + get: + operationId: data_classification_get_catalog_config + summary: Get the Data Classification configuration for a catalog. + tags: + - dataclassification + - data_classification + description: |- + Get the Data Classification configuration for a catalog. + + :param name: str + Resource name in the format: catalogs/{catalog_name}/config + + :returns: :class:`CatalogConfig` + parameters: + - name: catalog_name + in: path + required: true + schema: + type: string + description: >- + The `catalog_name` segment of the `name` resource name + (`catalogs/{catalog_name}/config`). Resource name in the format: + catalogs/{catalog_name}/config + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogConfig' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DataClassificationAPI + patch: + operationId: data_classification_update_catalog_config + summary: Update the Data Classification configuration for a catalog. + tags: + - dataclassification + - data_classification + description: >- + Update the Data Classification configuration for a catalog. + + + - The config must already exist for the catalog. + + - Updates fields specified in the update_mask. Use update_mask field to + perform partial updates of the + configuration. + + :param name: str + Resource name in the format: catalogs/{catalog_name}/config. + :param catalog_config: :class:`CatalogConfig` + The configuration to apply to the catalog. The name field in catalog_config identifies which + resource to update. + :param update_mask: FieldMask + Field mask specifying which fields to update. + + :returns: :class:`CatalogConfig` + parameters: + - name: catalog_name + in: path + required: true + schema: + type: string + description: >- + The `catalog_name` segment of the `name` resource name + (`catalogs/{catalog_name}/config`). Resource name in the format: + catalogs/{catalog_name}/config. + - name: update_mask + in: query + required: true + schema: + type: object + description: Field mask specifying which fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + auto_tag_configs: + type: array + items: + type: object + properties: + classification_tag: + type: string + description: >- + The Classification Tag. For built-in classes this is a + system tag (e.g., "class.name", "class.location"); for + custom classes it is a user-defined governance tag + key. + auto_tagging_mode: + type: string + x-enum: + - AUTO_TAGGING_DISABLED + - AUTO_TAGGING_ENABLED + description: >- + Whether auto-tagging is enabled or disabled for this + classification tag. + required: + - classification_tag + - auto_tagging_mode + description: >- + Auto-tagging configuration for a classification tag. When + enabled, detected columns are + automatically tagged with Unity Catalog tags. + description: >- + List of auto-tagging configurations for this catalog. Empty + list means no auto-tagging is enabled. + excluded_schemas: + type: object + properties: + names: + type: array + items: + type: string + description: >- + Schema names, each relative to the parent catalog. Must + not be empty. + required: + - names + description: >- + Schemas to exclude from the scan, each named relative to the + parent catalog. If specified, all schemas except the + specified ones will be scanned. Mutually exclusive with + ``included_schemas``: only one may be set per request. If + neither ``included_schemas`` nor ``excluded_schemas`` is + set, all schemas are scanned. + included_schemas: + type: object + properties: + names: + type: array + items: + type: string + description: >- + Schema names, each relative to the parent catalog. Must + not be empty. + required: + - names + description: >- + Schemas to include in the scan, each named relative to the + parent catalog. If specified, only listed schemas will be + scanned. Mutually exclusive with ``excluded_schemas``: only + one may be set per request. If neither ``included_schemas`` + nor ``excluded_schemas`` is set, all schemas are scanned. + name: + type: string + description: 'Resource name in the format: catalogs/{catalog_name}/config.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogConfig' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DataClassificationAPI +components: + schemas: + AutoTaggingConfig: + type: object + properties: + classification_tag: + type: string + description: >- + The Classification Tag. For built-in classes this is a system tag + (e.g., "class.name", "class.location"); for custom classes it is a + user-defined governance tag key. + auto_tagging_mode: + $ref: '#/components/schemas/AutoTaggingConfigAutoTaggingMode' + description: >- + Whether auto-tagging is enabled or disabled for this classification + tag. + required: + - classification_tag + - auto_tagging_mode + description: >- + Auto-tagging configuration for a classification tag. When enabled, + detected columns are + automatically tagged with Unity Catalog tags. + CatalogConfig: + type: object + properties: + auto_tag_configs: + type: array + items: + $ref: '#/components/schemas/AutoTaggingConfig' + description: >- + List of auto-tagging configurations for this catalog. Empty list + means no auto-tagging is enabled. + excluded_schemas: + $ref: '#/components/schemas/CatalogConfigSchemaNames' + description: >- + Schemas to exclude from the scan, each named relative to the parent + catalog. If specified, all schemas except the specified ones will be + scanned. Mutually exclusive with ``included_schemas``: only one may + be set per request. If neither ``included_schemas`` nor + ``excluded_schemas`` is set, all schemas are scanned. + included_schemas: + $ref: '#/components/schemas/CatalogConfigSchemaNames' + description: >- + Schemas to include in the scan, each named relative to the parent + catalog. If specified, only listed schemas will be scanned. Mutually + exclusive with ``excluded_schemas``: only one may be set per + request. If neither ``included_schemas`` nor ``excluded_schemas`` is + set, all schemas are scanned. + name: + type: string + description: 'Resource name in the format: catalogs/{catalog_name}/config.' + description: >- + Data Classification configuration for a Unity Catalog catalog. This + message follows the "At Most + One Resource" pattern: at most one CatalogConfig exists per catalog. + + - Full CRUD operations are supported: Create enables Data Classification, Delete disables it + - It has no unique identifier of its own and uses its parent catalog's identifier (catalog_name) + CatalogConfigSchemaNames: + type: object + properties: + names: + type: array + items: + type: string + description: >- + Schema names, each relative to the parent catalog. Must not be + empty. + required: + - names + description: Wrapper message for a list of schema names. + AutoTaggingConfigAutoTaggingMode: + type: string + x-enum: + - AUTO_TAGGING_DISABLED + - AUTO_TAGGING_ENABLED + description: Auto-tagging mode. + x-stackQL-resources: + catalog_configs: + id: databricks_workspace.dataclassification.catalog_configs + name: catalog_configs + title: Catalog Configs + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1data-classification~1v1~1catalogs~1{catalog_name}~1config/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1api~1data-classification~1v1~1catalogs~1{catalog_name}~1config/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~1data-classification~1v1~1catalogs~1{catalog_name}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1data-classification~1v1~1catalogs~1{catalog_name}~1config/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/catalog_configs/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/catalog_configs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/catalog_configs/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/catalog_configs/methods/delete' + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml b/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml index 1dbc81b0..9e53b534 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml @@ -6,14 +6,31 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.dataquality servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id}/cancel: post: @@ -173,386 +190,477 @@ paths: schema: type: object properties: - monitor: + object_type: + type: string + description: >- + The type of the monitored object. Can be one of the + following: ``schema`` or ``table``. + object_id: + type: string + description: >- + The UUID of the request object. It is ``schema_id`` for + ``schema``, and ``table_id`` for ``table``. Find the + ``schema_id`` from either: 1. The `schema_id + `__ + of the ``Schemas`` resource. 2. In `Catalog Explorer + `__ > + select the ``schema`` > go to the ``Details`` tab > the + ``Schema ID`` field. Find the ``table_id`` from either: 1. + The `table_id + `__ + of the ``Tables`` resource. 2. In `Catalog Explorer + `__ > + select the ``table`` > go to the ``Details`` tab > the + ``Table ID`` field. + anomaly_detection_config: type: object properties: - object_type: - type: string - description: >- - The type of the monitored object. Can be one of the - following: ``schema`` or ``table``. - object_id: - type: string + excluded_table_full_names: + type: array + items: + type: string description: >- - The UUID of the request object. It is ``schema_id`` for - ``schema``, and ``table_id`` for ``table``. Find the - ``schema_id`` from either: 1. The `schema_id - `__ - of the ``Schemas`` resource. 2. In `Catalog Explorer - `__ - > select the ``schema`` > go to the ``Details`` tab > - the ``Schema ID`` field. Find the ``table_id`` from - either: 1. The `table_id - `__ - of the ``Tables`` resource. 2. In `Catalog Explorer - `__ - > select the ``table`` > go to the ``Details`` tab > the - ``Table ID`` field. - anomaly_detection_config: + List of fully qualified table names to exclude from + anomaly detection. + notification_settings: type: object properties: - anomaly_detection_workflow_id: - type: integer - description: >- - The id of the workflow that detects the anomaly. - This field will only be returned in the Get/Update - response, if the request comes from the workspace - where this anomaly detection job is created. - excluded_table_full_names: - type: array - items: - type: string + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer + description: >- + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - List of fully qualified table names to exclude from - anomaly detection. - job_type: - type: string - x-enum: - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: The type of the last run of the workflow. - publish_health_indicator: - type: boolean - description: If the health indicator should be shown. - validity_check_configurations: - type: array - items: - type: object - properties: - name: + Destinations to send notifications on + failure/timeout. + on_unhealthy_table: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer + description: >- + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - description: Validity check configurations for anomaly detection. + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. + description: >- + Recipients to notify when anomaly detection finds + unhealthy tables in the schema. Each recipient gets + one notification per important unhealthy table. Only + supported on schema monitors, via + ``anomaly_detection_config``. + description: >- + Who to alert when anomaly detection finds unhealthy + tables in this schema. Applicable to ``schema`` monitors + only. This is the same schema alert you manage from + **Manage alerts** in the Data Quality Monitoring UI, so + a change made in either place shows in both. Set the + recipients in ``on_unhealthy_table``; ``on_failure`` is + not supported here. Only ``destination_ids`` and + ``destination_user_ids`` are supported. On update, an + update mask of ``*``, ``anomaly_detection_config``, or + ``anomaly_detection_config.notification_settings`` + replaces the alert's recipients with the ones in the + request; omitting the field, or leaving both recipient + lists empty, removes the alert. Other masks leave the + alert unchanged. + description: >- + Anomaly Detection Configuration, applicable to ``schema`` + object types. + data_profiling_config: + type: object + properties: + output_schema_id: + type: string + description: ID of the schema where output tables are created. + assets_dir: + type: string + description: >- + Field for specifying the absolute path to a custom + directory to store data-monitoring assets. Normally + prepopulated to a default user location via UI and + Python APIs. + baseline_table_name: + type: string description: >- - Anomaly Detection Configuration, applicable to - ``schema`` object types. - data_profiling_config: + Baseline table name. Baseline data is used to compute + drift from the data in the monitored ``table_name``. The + baseline table and the monitored table shall have the + same schema. + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the metric in the output tables. + definition: + type: string + description: >- + Jinja template for a SQL expression that specifies + how to compute the metric. See `create metric + definition + `__. + input_columns: + type: array + items: + type: string + description: >- + A list of column names in the input table the + metric should be computed for. Can use + ``":table"`` to indicate that the metric needs + information from multiple columns. + output_data_type: + type: string + description: The output type of the custom metric. + type: + type: string + x-enum: + - DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE + - DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED + - DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT + description: The type of the custom metric. + required: + - name + - definition + - input_columns + - output_data_type + - type + description: Custom metric definition. + description: Custom metrics. + dashboard_id: + type: string + description: >- + Id of dashboard that visualizes the computed metrics. + This can be empty if the monitor is in PENDING state. + drift_metrics_table_name: + type: string + description: >- + Table that stores drift metrics data. Format: + ``catalog.schema.table_name``. + effective_warehouse_id: + type: string + description: The warehouse for dashboard creation + inference_log: type: object properties: - output_schema_id: - type: string - description: ID of the schema where output tables are created. - assets_dir: + problem_type: type: string - description: >- - Field for specifying the absolute path to a custom - directory to store data-monitoring assets. Normally - prepopulated to a default user location via UI and - Python APIs. - baseline_table_name: + x-enum: + - INFERENCE_PROBLEM_TYPE_CLASSIFICATION + - INFERENCE_PROBLEM_TYPE_REGRESSION + description: Problem type the model aims to solve. + timestamp_column: type: string - description: >- - Baseline table name. Baseline data is used to - compute drift from the data in the monitored - ``table_name``. The baseline table and the monitored - table shall have the same schema. - custom_metrics: + description: Column for the timestamp. + granularities: type: array items: - type: object - properties: - name: - type: string - description: Name of the metric in the output tables. - definition: - type: string - description: >- - Jinja template for a SQL expression that - specifies how to compute the metric. See - `create metric definition - `__. - input_columns: - type: array - items: - type: string - description: >- - A list of column names in the input table the - metric should be computed for. Can use - ``":table"`` to indicate that the metric needs - information from multiple columns. - output_data_type: - type: string - description: The output type of the custom metric. - type: - type: string - x-enum: - - DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE - - DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED - - DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT - description: The type of the custom metric. - required: - - name - - definition - - input_columns - - output_data_type - - type - description: Custom metric definition. - description: Custom metrics. - dashboard_id: - type: string + type: string + x-enum: + - AGGREGATION_GRANULARITY_1_DAY + - AGGREGATION_GRANULARITY_1_HOUR + - AGGREGATION_GRANULARITY_1_MONTH + - AGGREGATION_GRANULARITY_1_WEEK + - AGGREGATION_GRANULARITY_1_YEAR + - AGGREGATION_GRANULARITY_2_WEEKS + - AGGREGATION_GRANULARITY_30_MINUTES + - AGGREGATION_GRANULARITY_3_WEEKS + - AGGREGATION_GRANULARITY_4_WEEKS + - AGGREGATION_GRANULARITY_5_MINUTES + description: >- + The granularity for aggregating data into time + windows based on their timestamp. description: >- - Id of dashboard that visualizes the computed - metrics. This can be empty if the monitor is in - PENDING state. - drift_metrics_table_name: + List of granularities to use when aggregating data + into time windows based on their timestamp. + prediction_column: type: string - description: >- - Table that stores drift metrics data. Format: - ``catalog.schema.table_name``. - effective_warehouse_id: + description: Column for the prediction. + model_id_column: + type: string + description: Column for the model identifier. + label_column: type: string - description: The warehouse for dashboard creation - inference_log: + description: Column for the label. + required: + - problem_type + - timestamp_column + - granularities + - prediction_column + - model_id_column + description: >- + ``Analysis Configuration`` for monitoring inference log + tables. + latest_monitor_failure_message: + type: string + description: The latest error message for a monitor failure. + monitor_version: + type: integer + description: >- + Represents the current monitor configuration version in + use. The version will be represented in a numeric + fashion (1,2,3...). The field has flexibility to take on + negative values, which can indicate corrupted + monitor_version numbers. + monitored_table_name: + type: string + description: >- + Unity Catalog table to monitor. Format: + ``catalog.schema.table_name`` + notification_settings: + type: object + properties: + on_failure: type: object properties: - problem_type: - type: string - x-enum: - - INFERENCE_PROBLEM_TYPE_CLASSIFICATION - - INFERENCE_PROBLEM_TYPE_REGRESSION - description: Problem type the model aims to solve. - timestamp_column: - type: string - description: Column for the timestamp. - granularities: + destination_ids: type: array items: type: string - x-enum: - - AGGREGATION_GRANULARITY_1_DAY - - AGGREGATION_GRANULARITY_1_HOUR - - AGGREGATION_GRANULARITY_1_MONTH - - AGGREGATION_GRANULARITY_1_WEEK - - AGGREGATION_GRANULARITY_1_YEAR - - AGGREGATION_GRANULARITY_2_WEEKS - - AGGREGATION_GRANULARITY_30_MINUTES - - AGGREGATION_GRANULARITY_3_WEEKS - - AGGREGATION_GRANULARITY_4_WEEKS - - AGGREGATION_GRANULARITY_5_MINUTES - description: >- - The granularity for aggregating data into time - windows based on their timestamp. description: >- - List of granularities to use when aggregating - data into time windows based on their timestamp. - prediction_column: - type: string - description: Column for the prediction. - model_id_column: - type: string - description: Column for the model identifier. - label_column: - type: string - description: Column for the label. - prediction_probability_column: - type: string - description: Column for prediction probabilities - required: - - problem_type - - timestamp_column - - granularities - - prediction_column - - model_id_column - description: >- - ``Analysis Configuration`` for monitoring inference - log tables. - latest_monitor_failure_message: - type: string - description: The latest error message for a monitor failure. - monitor_version: - type: integer - description: >- - Represents the current monitor configuration version - in use. The version will be represented in a numeric - fashion (1,2,3...). The field has flexibility to - take on negative values, which can indicate - corrupted monitor_version numbers. - monitored_table_name: - type: string - description: >- - Unity Catalog table to monitor. Format: - ``catalog.schema.table_name`` - notification_settings: - type: object - properties: - on_failure: - type: object - properties: - email_addresses: - type: array - items: - type: string - description: >- - The list of email addresses to send the - notification to. A maximum of 5 email - addresses is supported. + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer description: >- - Destinations to send notifications on - failure/timeout. - description: Field for specifying notification settings. - profile_metrics_table_name: - type: string + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - Table that stores profile metrics data. Format: - ``catalog.schema.table_name``. - schedule: + Destinations to send notifications on + failure/timeout. + on_unhealthy_table: type: object properties: - quartz_cron_expression: - type: string + destination_ids: + type: array + items: + type: string description: >- - The expression that determines when to run the - monitor. See `examples - `__. - timezone_id: - type: string + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer description: >- - A Java timezone id. The schedule for a job will - be resolved with respect to this timezone. See - `Java TimeZone - `_ - for details. The timezone id (e.g., - ``America/Los_Angeles``) in which to evaluate - the quartz expression. - pause_status: - type: string - x-enum: - - CRON_SCHEDULE_PAUSE_STATUS_PAUSED - - CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string description: >- - Read only field that indicates whether the - schedule is paused or not. - required: - - quartz_cron_expression - - timezone_id - description: The cron schedule. - skip_builtin_dashboard: - type: boolean + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - Whether to skip creating a default dashboard - summarizing data quality metrics. - slicing_exprs: - type: array - items: - type: string + Recipients to notify when anomaly detection finds + unhealthy tables in the schema. Each recipient gets + one notification per important unhealthy table. Only + supported on schema monitors, via + ``anomaly_detection_config``. + description: Field for specifying notification settings. + profile_metrics_table_name: + type: string + description: >- + Table that stores profile metrics data. Format: + ``catalog.schema.table_name``. + schedule: + type: object + properties: + quartz_cron_expression: + type: string description: >- - List of column expressions to slice data with for - targeted analysis. The data is grouped by each - expression independently, resulting in a separate - slice for each predicate and its complements. For - example ``slicing_exprs=[“col_1”, “col_2 > 10”]`` - will generate the following slices: two slices for - ``col_2 > 10`` (True and False), and one slice per - unique value in ``col1``. For high-cardinality - columns, only the top 100 unique values by frequency - will generate slices. - snapshot: - type: object - properties: {} + The expression that determines when to run the + monitor. See `examples + `__. + timezone_id: + type: string description: >- - ``Analysis Configuration`` for monitoring snapshot - tables. - status: + A Java timezone id. The schedule for a job will be + resolved with respect to this timezone. See `Java + TimeZone + `_ + for details. The timezone id (e.g., + ``America/Los_Angeles``) in which to evaluate the + quartz expression. + pause_status: type: string x-enum: - - DATA_PROFILING_STATUS_ACTIVE - - DATA_PROFILING_STATUS_DELETE_PENDING - - DATA_PROFILING_STATUS_ERROR - - DATA_PROFILING_STATUS_FAILED - - DATA_PROFILING_STATUS_PENDING - description: The data profiling monitor status. - time_series: - type: object - properties: - timestamp_column: - type: string - description: Column for the timestamp. - granularities: - type: array - items: - type: string - x-enum: - - AGGREGATION_GRANULARITY_1_DAY - - AGGREGATION_GRANULARITY_1_HOUR - - AGGREGATION_GRANULARITY_1_MONTH - - AGGREGATION_GRANULARITY_1_WEEK - - AGGREGATION_GRANULARITY_1_YEAR - - AGGREGATION_GRANULARITY_2_WEEKS - - AGGREGATION_GRANULARITY_30_MINUTES - - AGGREGATION_GRANULARITY_3_WEEKS - - AGGREGATION_GRANULARITY_4_WEEKS - - AGGREGATION_GRANULARITY_5_MINUTES - description: >- - The granularity for aggregating data into time - windows based on their timestamp. - description: >- - List of granularities to use when aggregating - data into time windows based on their timestamp. - required: - - timestamp_column - - granularities + - CRON_SCHEDULE_PAUSE_STATUS_PAUSED + - CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED description: >- - ``Analysis Configuration`` for monitoring time - series tables. - warehouse_id: + Read only field that indicates whether the schedule + is paused or not. + required: + - quartz_cron_expression + - timezone_id + description: The cron schedule. + skip_builtin_dashboard: + type: boolean + description: >- + Whether to skip creating a default dashboard summarizing + data quality metrics. + slicing_exprs: + type: array + items: + type: string + description: >- + List of column expressions to slice data with for + targeted analysis. The data is grouped by each + expression independently, resulting in a separate slice + for each predicate and its complements. For example + ``slicing_exprs=[“col_1”, “col_2 > 10”]`` will generate + the following slices: two slices for ``col_2 > 10`` + (True and False), and one slice per unique value in + ``col1``. For high-cardinality columns, only the top 100 + unique values by frequency will generate slices. + snapshot: + type: object + properties: {} + description: >- + ``Analysis Configuration`` for monitoring snapshot + tables. + status: + type: string + x-enum: + - DATA_PROFILING_STATUS_ACTIVE + - DATA_PROFILING_STATUS_DELETE_PENDING + - DATA_PROFILING_STATUS_ERROR + - DATA_PROFILING_STATUS_FAILED + - DATA_PROFILING_STATUS_PENDING + description: The data profiling monitor status. + time_series: + type: object + properties: + timestamp_column: type: string + description: Column for the timestamp. + granularities: + type: array + items: + type: string + x-enum: + - AGGREGATION_GRANULARITY_1_DAY + - AGGREGATION_GRANULARITY_1_HOUR + - AGGREGATION_GRANULARITY_1_MONTH + - AGGREGATION_GRANULARITY_1_WEEK + - AGGREGATION_GRANULARITY_1_YEAR + - AGGREGATION_GRANULARITY_2_WEEKS + - AGGREGATION_GRANULARITY_30_MINUTES + - AGGREGATION_GRANULARITY_3_WEEKS + - AGGREGATION_GRANULARITY_4_WEEKS + - AGGREGATION_GRANULARITY_5_MINUTES + description: >- + The granularity for aggregating data into time + windows based on their timestamp. description: >- - Optional argument to specify the warehouse for - dashboard creation. If not specified, the first - running warehouse will be used. + List of granularities to use when aggregating data + into time windows based on their timestamp. required: - - output_schema_id + - timestamp_column + - granularities description: >- - Data Profiling Configuration, applicable to ``table`` - object types. Exactly one ``Analysis Configuration`` - must be present. + ``Analysis Configuration`` for monitoring time series + tables. + warehouse_id: + type: string + description: >- + Optional argument to specify the warehouse for dashboard + creation. If not specified, the first running warehouse + will be used. required: - - object_type - - object_id - description: The monitor to create. + - output_schema_id + description: >- + Data Profiling Configuration, applicable to ``table`` object + types. Exactly one ``Analysis Configuration`` must be + present. required: - - monitor + - object_type + - object_id responses: '200': description: Success @@ -698,73 +806,67 @@ paths: schema: type: object properties: - refresh: - type: object - properties: - object_type: - type: string - description: >- - The type of the monitored object. Can be one of the - following: ``schema`` or ``table``. - object_id: - type: string - description: >- - The UUID of the request object. It is ``schema_id`` for - ``schema``, and ``table_id`` for ``table``. Find the - ``schema_id`` from either: 1. The `schema_id - `__ - of the ``Schemas`` resource. 2. In `Catalog Explorer - `__ - > select the ``schema`` > go to the ``Details`` tab > - the ``Schema ID`` field. Find the ``table_id`` from - either: 1. The `table_id - `__ - of the ``Tables`` resource. 2. In `Catalog Explorer - `__ - > select the ``table`` > go to the ``Details`` tab > the - ``Table ID`` field. - end_time_ms: - type: integer - description: >- - Time when the refresh ended (milliseconds since 1/1/1970 - UTC). - message: - type: string - description: >- - An optional message to give insight into the current - state of the refresh (e.g. FAILURE messages). - refresh_id: - type: integer - description: Unique id of the refresh operation. - start_time_ms: - type: integer - description: >- - Time when the refresh started (milliseconds since - 1/1/1970 UTC). - state: - type: string - x-enum: - - MONITOR_REFRESH_STATE_CANCELED - - MONITOR_REFRESH_STATE_FAILED - - MONITOR_REFRESH_STATE_PENDING - - MONITOR_REFRESH_STATE_RUNNING - - MONITOR_REFRESH_STATE_SUCCESS - - MONITOR_REFRESH_STATE_UNKNOWN - description: The current state of the refresh. - trigger: - type: string - x-enum: - - MONITOR_REFRESH_TRIGGER_DATA_CHANGE - - MONITOR_REFRESH_TRIGGER_MANUAL - - MONITOR_REFRESH_TRIGGER_SCHEDULE - - MONITOR_REFRESH_TRIGGER_UNKNOWN - description: What triggered the refresh. - required: - - object_type - - object_id - description: The refresh to create + object_type: + type: string + description: >- + The type of the monitored object. Can be one of the + following: ``schema`` or ``table``. + object_id: + type: string + description: >- + The UUID of the request object. It is ``schema_id`` for + ``schema``, and ``table_id`` for ``table``. Find the + ``schema_id`` from either: 1. The `schema_id + `__ + of the ``Schemas`` resource. 2. In `Catalog Explorer + `__ > + select the ``schema`` > go to the ``Details`` tab > the + ``Schema ID`` field. Find the ``table_id`` from either: 1. + The `table_id + `__ + of the ``Tables`` resource. 2. In `Catalog Explorer + `__ > + select the ``table`` > go to the ``Details`` tab > the + ``Table ID`` field. + end_time_ms: + type: integer + description: >- + Time when the refresh ended (milliseconds since 1/1/1970 + UTC). + message: + type: string + description: >- + An optional message to give insight into the current state + of the refresh (e.g. FAILURE messages). + refresh_id: + type: integer + description: Unique id of the refresh operation. + start_time_ms: + type: integer + description: >- + Time when the refresh started (milliseconds since 1/1/1970 + UTC). + state: + type: string + x-enum: + - MONITOR_REFRESH_STATE_CANCELED + - MONITOR_REFRESH_STATE_FAILED + - MONITOR_REFRESH_STATE_PENDING + - MONITOR_REFRESH_STATE_RUNNING + - MONITOR_REFRESH_STATE_SUCCESS + - MONITOR_REFRESH_STATE_UNKNOWN + description: The current state of the refresh. + trigger: + type: string + x-enum: + - MONITOR_REFRESH_TRIGGER_DATA_CHANGE + - MONITOR_REFRESH_TRIGGER_MANUAL + - MONITOR_REFRESH_TRIGGER_SCHEDULE + - MONITOR_REFRESH_TRIGGER_UNKNOWN + description: What triggered the refresh. required: - - refresh + - object_type + - object_id responses: '200': description: Success @@ -1211,386 +1313,477 @@ paths: schema: type: object properties: - monitor: + object_type: + type: string + description: >- + The type of the monitored object. Can be one of the + following: ``schema`` or ``table``. + object_id: + type: string + description: >- + The UUID of the request object. It is ``schema_id`` for + ``schema``, and ``table_id`` for ``table``. Find the + ``schema_id`` from either: 1. The `schema_id + `__ + of the ``Schemas`` resource. 2. In `Catalog Explorer + `__ > + select the ``schema`` > go to the ``Details`` tab > the + ``Schema ID`` field. Find the ``table_id`` from either: 1. + The `table_id + `__ + of the ``Tables`` resource. 2. In `Catalog Explorer + `__ > + select the ``table`` > go to the ``Details`` tab > the + ``Table ID`` field. + anomaly_detection_config: type: object properties: - object_type: - type: string - description: >- - The type of the monitored object. Can be one of the - following: ``schema`` or ``table``. - object_id: - type: string + excluded_table_full_names: + type: array + items: + type: string description: >- - The UUID of the request object. It is ``schema_id`` for - ``schema``, and ``table_id`` for ``table``. Find the - ``schema_id`` from either: 1. The `schema_id - `__ - of the ``Schemas`` resource. 2. In `Catalog Explorer - `__ - > select the ``schema`` > go to the ``Details`` tab > - the ``Schema ID`` field. Find the ``table_id`` from - either: 1. The `table_id - `__ - of the ``Tables`` resource. 2. In `Catalog Explorer - `__ - > select the ``table`` > go to the ``Details`` tab > the - ``Table ID`` field. - anomaly_detection_config: + List of fully qualified table names to exclude from + anomaly detection. + notification_settings: type: object properties: - anomaly_detection_workflow_id: - type: integer - description: >- - The id of the workflow that detects the anomaly. - This field will only be returned in the Get/Update - response, if the request comes from the workspace - where this anomaly detection job is created. - excluded_table_full_names: - type: array - items: - type: string + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer + description: >- + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - List of fully qualified table names to exclude from - anomaly detection. - job_type: - type: string - x-enum: - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: The type of the last run of the workflow. - publish_health_indicator: - type: boolean - description: If the health indicator should be shown. - validity_check_configurations: - type: array - items: - type: object - properties: - name: + Destinations to send notifications on + failure/timeout. + on_unhealthy_table: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer + description: >- + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - description: Validity check configurations for anomaly detection. + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. + description: >- + Recipients to notify when anomaly detection finds + unhealthy tables in the schema. Each recipient gets + one notification per important unhealthy table. Only + supported on schema monitors, via + ``anomaly_detection_config``. + description: >- + Who to alert when anomaly detection finds unhealthy + tables in this schema. Applicable to ``schema`` monitors + only. This is the same schema alert you manage from + **Manage alerts** in the Data Quality Monitoring UI, so + a change made in either place shows in both. Set the + recipients in ``on_unhealthy_table``; ``on_failure`` is + not supported here. Only ``destination_ids`` and + ``destination_user_ids`` are supported. On update, an + update mask of ``*``, ``anomaly_detection_config``, or + ``anomaly_detection_config.notification_settings`` + replaces the alert's recipients with the ones in the + request; omitting the field, or leaving both recipient + lists empty, removes the alert. Other masks leave the + alert unchanged. + description: >- + Anomaly Detection Configuration, applicable to ``schema`` + object types. + data_profiling_config: + type: object + properties: + output_schema_id: + type: string + description: ID of the schema where output tables are created. + assets_dir: + type: string description: >- - Anomaly Detection Configuration, applicable to - ``schema`` object types. - data_profiling_config: + Field for specifying the absolute path to a custom + directory to store data-monitoring assets. Normally + prepopulated to a default user location via UI and + Python APIs. + baseline_table_name: + type: string + description: >- + Baseline table name. Baseline data is used to compute + drift from the data in the monitored ``table_name``. The + baseline table and the monitored table shall have the + same schema. + custom_metrics: + type: array + items: + type: object + properties: + name: + type: string + description: Name of the metric in the output tables. + definition: + type: string + description: >- + Jinja template for a SQL expression that specifies + how to compute the metric. See `create metric + definition + `__. + input_columns: + type: array + items: + type: string + description: >- + A list of column names in the input table the + metric should be computed for. Can use + ``":table"`` to indicate that the metric needs + information from multiple columns. + output_data_type: + type: string + description: The output type of the custom metric. + type: + type: string + x-enum: + - DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE + - DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED + - DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT + description: The type of the custom metric. + required: + - name + - definition + - input_columns + - output_data_type + - type + description: Custom metric definition. + description: Custom metrics. + dashboard_id: + type: string + description: >- + Id of dashboard that visualizes the computed metrics. + This can be empty if the monitor is in PENDING state. + drift_metrics_table_name: + type: string + description: >- + Table that stores drift metrics data. Format: + ``catalog.schema.table_name``. + effective_warehouse_id: + type: string + description: The warehouse for dashboard creation + inference_log: type: object properties: - output_schema_id: - type: string - description: ID of the schema where output tables are created. - assets_dir: + problem_type: type: string - description: >- - Field for specifying the absolute path to a custom - directory to store data-monitoring assets. Normally - prepopulated to a default user location via UI and - Python APIs. - baseline_table_name: + x-enum: + - INFERENCE_PROBLEM_TYPE_CLASSIFICATION + - INFERENCE_PROBLEM_TYPE_REGRESSION + description: Problem type the model aims to solve. + timestamp_column: type: string - description: >- - Baseline table name. Baseline data is used to - compute drift from the data in the monitored - ``table_name``. The baseline table and the monitored - table shall have the same schema. - custom_metrics: + description: Column for the timestamp. + granularities: type: array items: - type: object - properties: - name: - type: string - description: Name of the metric in the output tables. - definition: - type: string - description: >- - Jinja template for a SQL expression that - specifies how to compute the metric. See - `create metric definition - `__. - input_columns: - type: array - items: - type: string - description: >- - A list of column names in the input table the - metric should be computed for. Can use - ``":table"`` to indicate that the metric needs - information from multiple columns. - output_data_type: - type: string - description: The output type of the custom metric. - type: - type: string - x-enum: - - DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE - - DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED - - DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT - description: The type of the custom metric. - required: - - name - - definition - - input_columns - - output_data_type - - type - description: Custom metric definition. - description: Custom metrics. - dashboard_id: - type: string + type: string + x-enum: + - AGGREGATION_GRANULARITY_1_DAY + - AGGREGATION_GRANULARITY_1_HOUR + - AGGREGATION_GRANULARITY_1_MONTH + - AGGREGATION_GRANULARITY_1_WEEK + - AGGREGATION_GRANULARITY_1_YEAR + - AGGREGATION_GRANULARITY_2_WEEKS + - AGGREGATION_GRANULARITY_30_MINUTES + - AGGREGATION_GRANULARITY_3_WEEKS + - AGGREGATION_GRANULARITY_4_WEEKS + - AGGREGATION_GRANULARITY_5_MINUTES + description: >- + The granularity for aggregating data into time + windows based on their timestamp. description: >- - Id of dashboard that visualizes the computed - metrics. This can be empty if the monitor is in - PENDING state. - drift_metrics_table_name: + List of granularities to use when aggregating data + into time windows based on their timestamp. + prediction_column: type: string - description: >- - Table that stores drift metrics data. Format: - ``catalog.schema.table_name``. - effective_warehouse_id: + description: Column for the prediction. + model_id_column: + type: string + description: Column for the model identifier. + label_column: type: string - description: The warehouse for dashboard creation - inference_log: + description: Column for the label. + required: + - problem_type + - timestamp_column + - granularities + - prediction_column + - model_id_column + description: >- + ``Analysis Configuration`` for monitoring inference log + tables. + latest_monitor_failure_message: + type: string + description: The latest error message for a monitor failure. + monitor_version: + type: integer + description: >- + Represents the current monitor configuration version in + use. The version will be represented in a numeric + fashion (1,2,3...). The field has flexibility to take on + negative values, which can indicate corrupted + monitor_version numbers. + monitored_table_name: + type: string + description: >- + Unity Catalog table to monitor. Format: + ``catalog.schema.table_name`` + notification_settings: + type: object + properties: + on_failure: type: object properties: - problem_type: - type: string - x-enum: - - INFERENCE_PROBLEM_TYPE_CLASSIFICATION - - INFERENCE_PROBLEM_TYPE_REGRESSION - description: Problem type the model aims to solve. - timestamp_column: - type: string - description: Column for the timestamp. - granularities: + destination_ids: type: array items: type: string - x-enum: - - AGGREGATION_GRANULARITY_1_DAY - - AGGREGATION_GRANULARITY_1_HOUR - - AGGREGATION_GRANULARITY_1_MONTH - - AGGREGATION_GRANULARITY_1_WEEK - - AGGREGATION_GRANULARITY_1_YEAR - - AGGREGATION_GRANULARITY_2_WEEKS - - AGGREGATION_GRANULARITY_30_MINUTES - - AGGREGATION_GRANULARITY_3_WEEKS - - AGGREGATION_GRANULARITY_4_WEEKS - - AGGREGATION_GRANULARITY_5_MINUTES - description: >- - The granularity for aggregating data into time - windows based on their timestamp. description: >- - List of granularities to use when aggregating - data into time windows based on their timestamp. - prediction_column: - type: string - description: Column for the prediction. - model_id_column: - type: string - description: Column for the model identifier. - label_column: - type: string - description: Column for the label. - prediction_probability_column: - type: string - description: Column for prediction probabilities - required: - - problem_type - - timestamp_column - - granularities - - prediction_column - - model_id_column - description: >- - ``Analysis Configuration`` for monitoring inference - log tables. - latest_monitor_failure_message: - type: string - description: The latest error message for a monitor failure. - monitor_version: - type: integer - description: >- - Represents the current monitor configuration version - in use. The version will be represented in a numeric - fashion (1,2,3...). The field has flexibility to - take on negative values, which can indicate - corrupted monitor_version numbers. - monitored_table_name: - type: string - description: >- - Unity Catalog table to monitor. Format: - ``catalog.schema.table_name`` - notification_settings: - type: object - properties: - on_failure: - type: object - properties: - email_addresses: - type: array - items: - type: string - description: >- - The list of email addresses to send the - notification to. A maximum of 5 email - addresses is supported. + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer description: >- - Destinations to send notifications on - failure/timeout. - description: Field for specifying notification settings. - profile_metrics_table_name: - type: string + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string + description: >- + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - Table that stores profile metrics data. Format: - ``catalog.schema.table_name``. - schedule: + Destinations to send notifications on + failure/timeout. + on_unhealthy_table: type: object properties: - quartz_cron_expression: - type: string + destination_ids: + type: array + items: + type: string description: >- - The expression that determines when to run the - monitor. See `examples - `__. - timezone_id: - type: string + The notification-destination IDs (Slack / Teams + / webhook) to send the notification to. The + destinations must already exist in the + workspace; a workspace admin creates them. A + maximum of 25 destination IDs is supported. Only + supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + destination_user_ids: + type: array + items: + type: integer description: >- - A Java timezone id. The schedule for a job will - be resolved with respect to this timezone. See - `Java TimeZone - `_ - for details. The timezone id (e.g., - ``America/Los_Angeles``) in which to evaluate - the quartz expression. - pause_status: - type: string - x-enum: - - CRON_SCHEDULE_PAUSE_STATUS_PAUSED - - CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED + The IDs of the workspace users to notify by + email. A maximum of 25 user IDs is supported. + Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table + monitors. + email_addresses: + type: array + items: + type: string description: >- - Read only field that indicates whether the - schedule is paused or not. - required: - - quartz_cron_expression - - timezone_id - description: The cron schedule. - skip_builtin_dashboard: - type: boolean + The list of email addresses to send the + notification to. A maximum of 5 email addresses + is supported. description: >- - Whether to skip creating a default dashboard - summarizing data quality metrics. - slicing_exprs: - type: array - items: - type: string + Recipients to notify when anomaly detection finds + unhealthy tables in the schema. Each recipient gets + one notification per important unhealthy table. Only + supported on schema monitors, via + ``anomaly_detection_config``. + description: Field for specifying notification settings. + profile_metrics_table_name: + type: string + description: >- + Table that stores profile metrics data. Format: + ``catalog.schema.table_name``. + schedule: + type: object + properties: + quartz_cron_expression: + type: string description: >- - List of column expressions to slice data with for - targeted analysis. The data is grouped by each - expression independently, resulting in a separate - slice for each predicate and its complements. For - example ``slicing_exprs=[“col_1”, “col_2 > 10”]`` - will generate the following slices: two slices for - ``col_2 > 10`` (True and False), and one slice per - unique value in ``col1``. For high-cardinality - columns, only the top 100 unique values by frequency - will generate slices. - snapshot: - type: object - properties: {} + The expression that determines when to run the + monitor. See `examples + `__. + timezone_id: + type: string description: >- - ``Analysis Configuration`` for monitoring snapshot - tables. - status: + A Java timezone id. The schedule for a job will be + resolved with respect to this timezone. See `Java + TimeZone + `_ + for details. The timezone id (e.g., + ``America/Los_Angeles``) in which to evaluate the + quartz expression. + pause_status: type: string x-enum: - - DATA_PROFILING_STATUS_ACTIVE - - DATA_PROFILING_STATUS_DELETE_PENDING - - DATA_PROFILING_STATUS_ERROR - - DATA_PROFILING_STATUS_FAILED - - DATA_PROFILING_STATUS_PENDING - description: The data profiling monitor status. - time_series: - type: object - properties: - timestamp_column: - type: string - description: Column for the timestamp. - granularities: - type: array - items: - type: string - x-enum: - - AGGREGATION_GRANULARITY_1_DAY - - AGGREGATION_GRANULARITY_1_HOUR - - AGGREGATION_GRANULARITY_1_MONTH - - AGGREGATION_GRANULARITY_1_WEEK - - AGGREGATION_GRANULARITY_1_YEAR - - AGGREGATION_GRANULARITY_2_WEEKS - - AGGREGATION_GRANULARITY_30_MINUTES - - AGGREGATION_GRANULARITY_3_WEEKS - - AGGREGATION_GRANULARITY_4_WEEKS - - AGGREGATION_GRANULARITY_5_MINUTES - description: >- - The granularity for aggregating data into time - windows based on their timestamp. - description: >- - List of granularities to use when aggregating - data into time windows based on their timestamp. - required: - - timestamp_column - - granularities + - CRON_SCHEDULE_PAUSE_STATUS_PAUSED + - CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED description: >- - ``Analysis Configuration`` for monitoring time - series tables. - warehouse_id: + Read only field that indicates whether the schedule + is paused or not. + required: + - quartz_cron_expression + - timezone_id + description: The cron schedule. + skip_builtin_dashboard: + type: boolean + description: >- + Whether to skip creating a default dashboard summarizing + data quality metrics. + slicing_exprs: + type: array + items: + type: string + description: >- + List of column expressions to slice data with for + targeted analysis. The data is grouped by each + expression independently, resulting in a separate slice + for each predicate and its complements. For example + ``slicing_exprs=[“col_1”, “col_2 > 10”]`` will generate + the following slices: two slices for ``col_2 > 10`` + (True and False), and one slice per unique value in + ``col1``. For high-cardinality columns, only the top 100 + unique values by frequency will generate slices. + snapshot: + type: object + properties: {} + description: >- + ``Analysis Configuration`` for monitoring snapshot + tables. + status: + type: string + x-enum: + - DATA_PROFILING_STATUS_ACTIVE + - DATA_PROFILING_STATUS_DELETE_PENDING + - DATA_PROFILING_STATUS_ERROR + - DATA_PROFILING_STATUS_FAILED + - DATA_PROFILING_STATUS_PENDING + description: The data profiling monitor status. + time_series: + type: object + properties: + timestamp_column: type: string + description: Column for the timestamp. + granularities: + type: array + items: + type: string + x-enum: + - AGGREGATION_GRANULARITY_1_DAY + - AGGREGATION_GRANULARITY_1_HOUR + - AGGREGATION_GRANULARITY_1_MONTH + - AGGREGATION_GRANULARITY_1_WEEK + - AGGREGATION_GRANULARITY_1_YEAR + - AGGREGATION_GRANULARITY_2_WEEKS + - AGGREGATION_GRANULARITY_30_MINUTES + - AGGREGATION_GRANULARITY_3_WEEKS + - AGGREGATION_GRANULARITY_4_WEEKS + - AGGREGATION_GRANULARITY_5_MINUTES + description: >- + The granularity for aggregating data into time + windows based on their timestamp. description: >- - Optional argument to specify the warehouse for - dashboard creation. If not specified, the first - running warehouse will be used. + List of granularities to use when aggregating data + into time windows based on their timestamp. required: - - output_schema_id + - timestamp_column + - granularities description: >- - Data Profiling Configuration, applicable to ``table`` - object types. Exactly one ``Analysis Configuration`` - must be present. + ``Analysis Configuration`` for monitoring time series + tables. + warehouse_id: + type: string + description: >- + Optional argument to specify the warehouse for dashboard + creation. If not specified, the first running warehouse + will be used. required: - - object_type - - object_id - description: The monitor to update. + - output_schema_id + description: >- + Data Profiling Configuration, applicable to ``table`` object + types. Exactly one ``Analysis Configuration`` must be + present. required: - - monitor + - object_type + - object_id responses: '200': description: Success @@ -1880,73 +2073,67 @@ paths: schema: type: object properties: - refresh: - type: object - properties: - object_type: - type: string - description: >- - The type of the monitored object. Can be one of the - following: ``schema`` or ``table``. - object_id: - type: string - description: >- - The UUID of the request object. It is ``schema_id`` for - ``schema``, and ``table_id`` for ``table``. Find the - ``schema_id`` from either: 1. The `schema_id - `__ - of the ``Schemas`` resource. 2. In `Catalog Explorer - `__ - > select the ``schema`` > go to the ``Details`` tab > - the ``Schema ID`` field. Find the ``table_id`` from - either: 1. The `table_id - `__ - of the ``Tables`` resource. 2. In `Catalog Explorer - `__ - > select the ``table`` > go to the ``Details`` tab > the - ``Table ID`` field. - end_time_ms: - type: integer - description: >- - Time when the refresh ended (milliseconds since 1/1/1970 - UTC). - message: - type: string - description: >- - An optional message to give insight into the current - state of the refresh (e.g. FAILURE messages). - refresh_id: - type: integer - description: Unique id of the refresh operation. - start_time_ms: - type: integer - description: >- - Time when the refresh started (milliseconds since - 1/1/1970 UTC). - state: - type: string - x-enum: - - MONITOR_REFRESH_STATE_CANCELED - - MONITOR_REFRESH_STATE_FAILED - - MONITOR_REFRESH_STATE_PENDING - - MONITOR_REFRESH_STATE_RUNNING - - MONITOR_REFRESH_STATE_SUCCESS - - MONITOR_REFRESH_STATE_UNKNOWN - description: The current state of the refresh. - trigger: - type: string - x-enum: - - MONITOR_REFRESH_TRIGGER_DATA_CHANGE - - MONITOR_REFRESH_TRIGGER_MANUAL - - MONITOR_REFRESH_TRIGGER_SCHEDULE - - MONITOR_REFRESH_TRIGGER_UNKNOWN - description: What triggered the refresh. - required: - - object_type - - object_id - description: The refresh to update. + object_type: + type: string + description: >- + The type of the monitored object. Can be one of the + following: ``schema`` or ``table``. + object_id: + type: string + description: >- + The UUID of the request object. It is ``schema_id`` for + ``schema``, and ``table_id`` for ``table``. Find the + ``schema_id`` from either: 1. The `schema_id + `__ + of the ``Schemas`` resource. 2. In `Catalog Explorer + `__ > + select the ``schema`` > go to the ``Details`` tab > the + ``Schema ID`` field. Find the ``table_id`` from either: 1. + The `table_id + `__ + of the ``Tables`` resource. 2. In `Catalog Explorer + `__ > + select the ``table`` > go to the ``Details`` tab > the + ``Table ID`` field. + end_time_ms: + type: integer + description: >- + Time when the refresh ended (milliseconds since 1/1/1970 + UTC). + message: + type: string + description: >- + An optional message to give insight into the current state + of the refresh (e.g. FAILURE messages). + refresh_id: + type: integer + description: Unique id of the refresh operation. + start_time_ms: + type: integer + description: >- + Time when the refresh started (milliseconds since 1/1/1970 + UTC). + state: + type: string + x-enum: + - MONITOR_REFRESH_STATE_CANCELED + - MONITOR_REFRESH_STATE_FAILED + - MONITOR_REFRESH_STATE_PENDING + - MONITOR_REFRESH_STATE_RUNNING + - MONITOR_REFRESH_STATE_SUCCESS + - MONITOR_REFRESH_STATE_UNKNOWN + description: The current state of the refresh. + trigger: + type: string + x-enum: + - MONITOR_REFRESH_TRIGGER_DATA_CHANGE + - MONITOR_REFRESH_TRIGGER_MANUAL + - MONITOR_REFRESH_TRIGGER_SCHEDULE + - MONITOR_REFRESH_TRIGGER_UNKNOWN + description: What triggered the refresh. required: - - refresh + - object_type + - object_id responses: '200': description: Success @@ -1971,12 +2158,6 @@ components: AnomalyDetectionConfig: type: object properties: - anomaly_detection_workflow_id: - type: integer - description: >- - The id of the workflow that detects the anomaly. This field will - only be returned in the Get/Update response, if the request comes - from the workspace where this anomaly detection job is created. excluded_table_full_names: type: array items: @@ -1984,17 +2165,21 @@ components: description: >- List of fully qualified table names to exclude from anomaly detection. - job_type: - $ref: '#/components/schemas/AnomalyDetectionJobType' - description: The type of the last run of the workflow. - publish_health_indicator: - type: boolean - description: If the health indicator should be shown. - validity_check_configurations: - type: array - items: - $ref: '#/components/schemas/ValidityCheckConfiguration' - description: Validity check configurations for anomaly detection. + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: >- + Who to alert when anomaly detection finds unhealthy tables in this + schema. Applicable to ``schema`` monitors only. This is the same + schema alert you manage from **Manage alerts** in the Data Quality + Monitoring UI, so a change made in either place shows in both. Set + the recipients in ``on_unhealthy_table``; ``on_failure`` is not + supported here. Only ``destination_ids`` and + ``destination_user_ids`` are supported. On update, an update mask of + ``*``, ``anomaly_detection_config``, or + ``anomaly_detection_config.notification_settings`` replaces the + alert's recipients with the ones in the request; omitting the field, + or leaving both recipient lists empty, removes the alert. Other + masks leave the alert unchanged. description: Anomaly Detection Configurations. CancelRefreshResponse: type: object @@ -2187,9 +2372,6 @@ components: label_column: type: string description: Column for the label. - prediction_probability_column: - type: string - description: Column for prediction probabilities required: - problem_type - timestamp_column @@ -2259,6 +2441,24 @@ components: NotificationDestination: type: object properties: + destination_ids: + type: array + items: + type: string + description: >- + The notification-destination IDs (Slack / Teams / webhook) to send + the notification to. The destinations must already exist in the + workspace; a workspace admin creates them. A maximum of 25 + destination IDs is supported. Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table monitors. + destination_user_ids: + type: array + items: + type: integer + description: >- + The IDs of the workspace users to notify by email. A maximum of 25 + user IDs is supported. Only supported on schema monitors, via + ``anomaly_detection_config``; rejected on table monitors. email_addresses: type: array items: @@ -2273,30 +2473,14 @@ components: on_failure: $ref: '#/components/schemas/NotificationDestination' description: Destinations to send notifications on failure/timeout. + on_unhealthy_table: + $ref: '#/components/schemas/NotificationDestination' + description: >- + Recipients to notify when anomaly detection finds unhealthy tables + in the schema. Each recipient gets one notification per important + unhealthy table. Only supported on schema monitors, via + ``anomaly_detection_config``. description: Settings for sending notifications on the data quality monitoring. - PercentNullValidityCheck: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: Optional upper bound; we should use auto determined bounds for now - RangeValidityCheck: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range Refresh: type: object properties: @@ -2367,24 +2551,6 @@ components: - timestamp_column - granularities description: Time series analysis configuration. - UniquenessValidityCheck: - type: object - properties: - column_names: - type: array - items: - type: string - ValidityCheckConfiguration: - type: object - properties: - name: - type: string - percent_null_validity_check: - $ref: '#/components/schemas/PercentNullValidityCheck' - range_validity_check: - $ref: '#/components/schemas/RangeValidityCheck' - uniqueness_validity_check: - $ref: '#/components/schemas/UniquenessValidityCheck' AggregationGranularity: type: string x-enum: @@ -2401,12 +2567,6 @@ components: description: >- The granularity for aggregating data into time windows based on their timestamp. - AnomalyDetectionJobType: - type: string - x-enum: - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: Anomaly Detection job type. CronSchedulePauseStatus: type: string x-enum: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/domains.yaml b/providers/src/databricks_workspace/v00.00.00000/services/domains.yaml new file mode 100644 index 00000000..3bd7f251 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/domains.yaml @@ -0,0 +1,846 @@ +openapi: 3.0.0 +info: + title: Databricks Domains API (workspace) + description: >- + OpenAPI specification for the Databricks domains service (workspace-level + APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.domains +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/2.0/domains: + post: + operationId: domains_create_domain + summary: Create a domain. If ``domain_id`` is omitted, the server generates one. + tags: + - domains + description: |- + Create a domain. If ``domain_id`` is omitted, the server generates one. + + :param domain: :class:`Domain` + :param domain_id: str (optional) + Client-supplied resource ID for the new domain. If omitted, the server generates one. + + :returns: :class:`Domain` + parameters: + - name: domain_id + in: query + required: false + schema: + type: string + description: >- + Client-supplied resource ID for the new domain. If omitted, the + server generates one. + requestBody: + content: + application/json: + schema: + type: object + properties: + tag_key: + type: string + business_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the business owners (users, groups, or + service principals). + create_time: + type: string + format: date-time + description: Timestamp when the domain was created. + description: + type: string + description: Full description (max 4096 chars) + domain_id: + type: string + description: >- + Unique identifier for the domain. If omitted at Create, the + server generates one. + draft: + type: boolean + description: >- + Whether to mark the domain as a draft. If omitted on Create, + the server applies a default; the resolved value is returned + in ``effective_draft``. + effective_draft: + type: boolean + description: Resolved draft state of the domain. + icon: + type: object + properties: + color: + type: string + description: 'Hex color code with # prefix (e.g., "#FF5733").' + name: + type: string + x-enum: + - ADDRESS_BOOK + - ALARM + - ARROWS_IN + - ATOM + - BALLOON + - BANK + - BARRICADE + - BASKET + - BRIDGE + - CACTUS + - CALL_BELL + - CARROT + - CHART_PIE_SLICE + - CITY + - CLOUD + - COINS + - COMPASS_ROSE + - CRANE_TOWER + - CROWN + - CUBE_TRANSPARENT + - FADERS + - FLAG_BANNER_FOLD + - FLAG_CHECKERED + - GAVEL + - HAMBURGER + - HEAD_CIRCUIT + - HOURGLASS_HIGH + - INTERSECT_THREE + - MICROSCOPE + - MOON_STARS + - PACKAGE + - PARACHUTE + - PEPPER + - PIGGY_BANK + - PILL + - PLANET + - PLANT + - PLUGS_CONNECTED + - POPCORN + - PRESENTATION_CHART + - PUZZLE_PIECE + - RAINBOW + - RANKING + - RECEIPT + - ROCKET + - RULER + - SAILBOAT + - SCALES + - SCAN_SMILEY + - SCROLL + - SHIELD_CHECKERED + - SNEAKER + - SNOWFLAKE + - SOLAR_ROOF + - SPEEDOMETER + - STAMP + - STEPS + - STRATEGY + - SWORD + - TELEVISION_SIMPLE + - TENT + - TICKET + - TRACTOR + - TRAFFIC_CONE + - TRAIN + - TREE_EVERGREEN + - TREE_STRUCTURE + - TROLLEY_SUITCASE + - TROPHY + - TRUCK_TRAILER + - USERS_THREE + - VECTOR_THREE + description: Available icon names for a domain. + description: Icon to display for the domain. + name: + type: string + description: >- + Full resource name of the domain. The primary identifier for + this resource. Format: ``domains/{domain_id}`` Identifies + the domain on get, update, and delete. Not an input on + create — to choose the id, set + ``CreateDomainRequest.domain_id``. + parent_domain_id: + type: string + description: >- + Domain ID of the parent. If absent, this is a top-level + domain. If present, this domain is a subdomain of the + specified parent. + subtitle: + type: string + description: Short description (max 280 chars) + technical_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the technical owners (users, groups, or + service principals). + update_time: + type: string + format: date-time + description: Timestamp when the domain was last updated. + required: + - tag_key + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DomainsAPI + get: + operationId: domains_list_domains + summary: >- + List domains in the account. Set ``parent_domain_id`` to return only the + direct subdomains of a given + tags: + - domains + description: >- + List domains in the account. Set ``parent_domain_id`` to return only the + direct subdomains of a given + + domain. + + + Authorization: external callers must have the ``MANAGE DISCOVER`` + permission; only domains the caller + + is authorized to read are returned. + + + :param page_size: int (optional) + + :param page_token: str (optional) + + :param parent_domain_id: str (optional) + Filter by parent domain. + + - Absent: return all domains regardless of hierarchy. + - Present: return only direct children of the specified domain. + + :returns: Iterator over :class:`Domain` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + - name: page_token + in: query + required: false + schema: + type: string + - name: parent_domain_id + in: query + required: false + schema: + type: string + description: >- + Filter by parent domain. - Absent: return all domains regardless of + hierarchy. - Present: return only direct children of the specified + domain. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListDomainsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DomainsAPI + /api/2.0/domains/{domain_id}: + delete: + operationId: domains_delete_domain + summary: >- + Delete a domain. By default the request fails if the domain still has + Glossary pages; set ``force`` to + tags: + - domains + description: >- + Delete a domain. By default the request fails if the domain still has + Glossary pages; set ``force`` to + + delete those pages along with the domain. + + + :param name: str + Full resource name of the domain to delete. Format: ``domains/{domain_id}`` + :param force: bool (optional) + When false (default), DeleteDomain is rejected with FAILED_PRECONDITION if the domain still has + Glossary pages. When true, those pages are deleted first and then the domain is removed. + parameters: + - name: domain_id + in: path + required: true + schema: + type: string + description: >- + The `domain_id` segment of the `name` resource name + (`domains/{domain_id}`). Full resource name of the domain to delete. + Format: ``domains/{domain_id}`` + - name: force + in: query + required: false + schema: + type: boolean + description: >- + When false (default), DeleteDomain is rejected with + FAILED_PRECONDITION if the domain still has Glossary pages. When + true, those pages are deleted first and then the domain is removed. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DomainsAPI + get: + operationId: domains_get_domain + summary: Get a domain by resource name. + tags: + - domains + description: >- + Get a domain by resource name. + + + Authorization: external callers must have the ``MANAGE DISCOVER`` + permission. + + + :param name: str + Full resource name of the domain to retrieve. Format: ``domains/{domain_id}`` + + :returns: :class:`Domain` + parameters: + - name: domain_id + in: path + required: true + schema: + type: string + description: >- + The `domain_id` segment of the `name` resource name + (`domains/{domain_id}`). Full resource name of the domain to + retrieve. Format: ``domains/{domain_id}`` + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DomainsAPI + patch: + operationId: domains_update_domain + summary: >- + Update a domain. ``update_mask`` selects which fields to modify; the + domain is identified by its + tags: + - domains + description: >- + Update a domain. ``update_mask`` selects which fields to modify; the + domain is identified by its + + resource ``name``. + + + :param name: str + Full resource name of the domain. The primary identifier for this resource. Format: + ``domains/{domain_id}`` Identifies the domain on get, update, and delete. Not an input on create — + to choose the id, set ``CreateDomainRequest.domain_id``. + :param domain: :class:`Domain` + + :param update_mask: FieldMask + 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. + + :returns: :class:`Domain` + parameters: + - name: domain_id + in: path + required: true + schema: + type: string + description: >- + The `domain_id` segment of the `name` resource name + (`domains/{domain_id}`). Full resource name of the domain. The + primary identifier for this resource. Format: + ``domains/{domain_id}`` Identifies the domain on get, update, and + delete. Not an input on create — to choose the id, set + ``CreateDomainRequest.domain_id``. + - name: update_mask + in: query + required: true + schema: + type: object + 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. + 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. + requestBody: + content: + application/json: + schema: + type: object + properties: + tag_key: + type: string + business_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the business owners (users, groups, or + service principals). + create_time: + type: string + format: date-time + description: Timestamp when the domain was created. + description: + type: string + description: Full description (max 4096 chars) + domain_id: + type: string + description: >- + Unique identifier for the domain. If omitted at Create, the + server generates one. + draft: + type: boolean + description: >- + Whether to mark the domain as a draft. If omitted on Create, + the server applies a default; the resolved value is returned + in ``effective_draft``. + effective_draft: + type: boolean + description: Resolved draft state of the domain. + icon: + type: object + properties: + color: + type: string + description: 'Hex color code with # prefix (e.g., "#FF5733").' + name: + type: string + x-enum: + - ADDRESS_BOOK + - ALARM + - ARROWS_IN + - ATOM + - BALLOON + - BANK + - BARRICADE + - BASKET + - BRIDGE + - CACTUS + - CALL_BELL + - CARROT + - CHART_PIE_SLICE + - CITY + - CLOUD + - COINS + - COMPASS_ROSE + - CRANE_TOWER + - CROWN + - CUBE_TRANSPARENT + - FADERS + - FLAG_BANNER_FOLD + - FLAG_CHECKERED + - GAVEL + - HAMBURGER + - HEAD_CIRCUIT + - HOURGLASS_HIGH + - INTERSECT_THREE + - MICROSCOPE + - MOON_STARS + - PACKAGE + - PARACHUTE + - PEPPER + - PIGGY_BANK + - PILL + - PLANET + - PLANT + - PLUGS_CONNECTED + - POPCORN + - PRESENTATION_CHART + - PUZZLE_PIECE + - RAINBOW + - RANKING + - RECEIPT + - ROCKET + - RULER + - SAILBOAT + - SCALES + - SCAN_SMILEY + - SCROLL + - SHIELD_CHECKERED + - SNEAKER + - SNOWFLAKE + - SOLAR_ROOF + - SPEEDOMETER + - STAMP + - STEPS + - STRATEGY + - SWORD + - TELEVISION_SIMPLE + - TENT + - TICKET + - TRACTOR + - TRAFFIC_CONE + - TRAIN + - TREE_EVERGREEN + - TREE_STRUCTURE + - TROLLEY_SUITCASE + - TROPHY + - TRUCK_TRAILER + - USERS_THREE + - VECTOR_THREE + description: Available icon names for a domain. + description: Icon to display for the domain. + name: + type: string + description: >- + Full resource name of the domain. The primary identifier for + this resource. Format: ``domains/{domain_id}`` Identifies + the domain on get, update, and delete. Not an input on + create — to choose the id, set + ``CreateDomainRequest.domain_id``. + parent_domain_id: + type: string + description: >- + Domain ID of the parent. If absent, this is a top-level + domain. If present, this domain is a subdomain of the + specified parent. + subtitle: + type: string + description: Short description (max 280 chars) + technical_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the technical owners (users, groups, or + service principals). + update_time: + type: string + format: date-time + description: Timestamp when the domain was last updated. + required: + - tag_key + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Domain' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: DomainsAPI +components: + schemas: + Domain: + type: object + properties: + tag_key: + type: string + business_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the business owners (users, groups, or service + principals). + create_time: + type: string + format: date-time + description: Timestamp when the domain was created. + description: + type: string + description: Full description (max 4096 chars) + domain_id: + type: string + description: >- + Unique identifier for the domain. If omitted at Create, the server + generates one. + draft: + type: boolean + description: >- + Whether to mark the domain as a draft. If omitted on Create, the + server applies a default; the resolved value is returned in + ``effective_draft``. + effective_draft: + type: boolean + description: Resolved draft state of the domain. + icon: + $ref: '#/components/schemas/DomainIcon' + description: Icon to display for the domain. + name: + type: string + description: >- + Full resource name of the domain. The primary identifier for this + resource. Format: ``domains/{domain_id}`` Identifies the domain on + get, update, and delete. Not an input on create — to choose the id, + set ``CreateDomainRequest.domain_id``. + parent_domain_id: + type: string + description: >- + Domain ID of the parent. If absent, this is a top-level domain. If + present, this domain is a subdomain of the specified parent. + subtitle: + type: string + description: Short description (max 280 chars) + technical_owner_ids: + type: array + items: + type: integer + description: >- + Principal IDs of the technical owners (users, groups, or service + principals). + update_time: + type: string + format: date-time + description: Timestamp when the domain was last updated. + required: + - tag_key + DomainIcon: + type: object + properties: + color: + type: string + description: 'Hex color code with # prefix (e.g., "#FF5733").' + name: + $ref: '#/components/schemas/DomainIconName' + description: Icon configuration for a domain. + ListDomainsResponse: + type: object + properties: + domains: + type: array + items: + $ref: '#/components/schemas/Domain' + next_page_token: + type: string + DomainIconName: + type: string + x-enum: + - ADDRESS_BOOK + - ALARM + - ARROWS_IN + - ATOM + - BALLOON + - BANK + - BARRICADE + - BASKET + - BRIDGE + - CACTUS + - CALL_BELL + - CARROT + - CHART_PIE_SLICE + - CITY + - CLOUD + - COINS + - COMPASS_ROSE + - CRANE_TOWER + - CROWN + - CUBE_TRANSPARENT + - FADERS + - FLAG_BANNER_FOLD + - FLAG_CHECKERED + - GAVEL + - HAMBURGER + - HEAD_CIRCUIT + - HOURGLASS_HIGH + - INTERSECT_THREE + - MICROSCOPE + - MOON_STARS + - PACKAGE + - PARACHUTE + - PEPPER + - PIGGY_BANK + - PILL + - PLANET + - PLANT + - PLUGS_CONNECTED + - POPCORN + - PRESENTATION_CHART + - PUZZLE_PIECE + - RAINBOW + - RANKING + - RECEIPT + - ROCKET + - RULER + - SAILBOAT + - SCALES + - SCAN_SMILEY + - SCROLL + - SHIELD_CHECKERED + - SNEAKER + - SNOWFLAKE + - SOLAR_ROOF + - SPEEDOMETER + - STAMP + - STEPS + - STRATEGY + - SWORD + - TELEVISION_SIMPLE + - TENT + - TICKET + - TRACTOR + - TRAFFIC_CONE + - TRAIN + - TREE_EVERGREEN + - TREE_STRUCTURE + - TROLLEY_SUITCASE + - TROPHY + - TRUCK_TRAILER + - USERS_THREE + - VECTOR_THREE + description: Available icon names for a domain. + x-stackQL-resources: + domains: + id: databricks_workspace.domains.domains + name: domains + title: Domains + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1domains/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.domains + delete: + operation: + $ref: '#/paths/~1api~12.0~1domains~1{domain_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1domains~1{domain_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1domains~1{domain_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete' + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/environments.yaml b/providers/src/databricks_workspace/v00.00.00000/services/environments.yaml new file mode 100644 index 00000000..52be36ee --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/environments.yaml @@ -0,0 +1,1024 @@ +openapi: 3.0.0 +info: + title: Databricks Environments API (workspace) + description: >- + OpenAPI specification for the Databricks environments service + (workspace-level APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.environments +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/environments/v1/workspace-base-environments: + post: + operationId: environments_create_workspace_base_environment + summary: >- + Creates a new WorkspaceBaseEnvironment. This is a long-running + operation. The operation will + tags: + - environments + description: >- + 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. + + + :param workspace_base_environment: :class:`WorkspaceBaseEnvironment` + Required. The workspace base environment to create. + :param request_id: str (optional) + A unique identifier for this request. A random UUID is recommended. This request is only idempotent + if a request_id is provided. + :param workspace_base_environment_id: str (optional) + The ID to use for the workspace base environment, which will become the final component of the + resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. + + :returns: :class:`Operation` + parameters: + - name: request_id + in: query + required: false + schema: + type: string + description: >- + A unique identifier for this request. A random UUID is recommended. + This request is only idempotent if a request_id is provided. + - name: workspace_base_environment_id + in: query + required: false + schema: + type: string + description: >- + The ID to use for the workspace base environment, which will become + the final component of the resource name. This value should be 4-63 + characters, and valid characters are /[a-z][0-9]-/. + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + Human-readable display name for the workspace base + environment. + base_environment_type: + type: string + x-enum: + - CPU + - GPU + description: The type of base environment (CPU or GPU). + create_time: + type: string + format: date-time + description: Timestamp when the environment was created. + creator_user_id: + type: string + description: User ID of the creator. + filepath: + type: string + description: The WSFS or UC Volumes path to the environment YAML file. + is_default: + type: boolean + description: Whether this is the default environment for the workspace. + last_updated_user_id: + type: string + description: User ID of the last user who updated the environment. + message: + type: string + description: >- + Status message providing additional details about the + environment status. + name: + type: string + description: >- + The resource name of the workspace base environment. Format: + workspace-base-environments/{workspace-base-environment} + spec: + type: object + properties: + dependencies: + type: array + items: + type: string + description: >- + List of pip dependencies, as supported by the version of + pip in this environment. Each dependency is a valid pip + requirements file line per + https://pip.pypa.io/en/stable/reference/requirements-file-format/. + Allowed dependencies include a requirement specifier, an + archive URL, a local project path (such as WSFS or UC + Volumes in Databricks), or a VCS project URL. + environment_version: + type: string + description: >- + Environment version used by the environment. Each + version comes with a specific Python version and a set + of Python packages. The version is a string, consisting + of an integer. + description: >- + The environment specification containing version and + dependencies. + status: + type: string + x-enum: + - CREATED + - EXPIRED + - FAILED + - INVALID + - PENDING + - REFRESHING + description: The status of the materialized workspace base environment. + update_time: + type: string + format: date-time + description: Timestamp when the environment was last updated. + required: + - display_name + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + get: + operationId: environments_list_workspace_base_environments + summary: Lists all WorkspaceBaseEnvironments in the workspace. + tags: + - environments + description: >- + Lists all WorkspaceBaseEnvironments in the workspace. + + + Databricks provides the following base environments: + + + - ``workspace-base-environments/databricks_ai_...``: includes popular AI + and deep learning packages + for serverless GPU compute. + - ``workspace-base-environments/databricks_ml_...``: includes popular ML + packages for serverless + compute. + + Databricks-provided base environments are versioned. For example, + + ``workspace-base-environments/databricks_ml_v5`` corresponds to the ML + environment built on + + environment version 5. + + + :param page_size: int (optional) + The maximum number of environments to return per page. Default is 1000. + :param page_token: str (optional) + Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call. + + :returns: Iterator over :class:`WorkspaceBaseEnvironment` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + The maximum number of environments to return per page. Default is + 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + Page token for pagination. Received from a previous + ListWorkspaceBaseEnvironments call. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkspaceBaseEnvironmentsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + /api/environments/v1/workspace-base-environments/{workspace_base_environment}: + delete: + operationId: environments_delete_workspace_base_environment + summary: >- + Deletes a WorkspaceBaseEnvironment. Deleting a base environment may + impact linked notebooks and jobs. + tags: + - environments + description: >- + 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. + + + :param name: str + Required. The resource name of the workspace base environment to delete. Format: + workspace-base-environments/{workspace_base_environment} + parameters: + - name: workspace_base_environment + in: path + required: true + schema: + type: string + description: >- + The `workspace_base_environment` segment of the `name` resource name + (`workspace-base-environments/{workspace_base_environment}`). + Required. The resource name of the workspace base environment to + delete. Format: + workspace-base-environments/{workspace_base_environment} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + get: + operationId: environments_get_workspace_base_environment + summary: Retrieves a WorkspaceBaseEnvironment by its name. + tags: + - environments + description: |- + Retrieves a WorkspaceBaseEnvironment by its name. + + :param name: str + Required. The resource name of the workspace base environment to retrieve. Format: + workspace-base-environments/{workspace_base_environment} + + :returns: :class:`WorkspaceBaseEnvironment` + parameters: + - name: workspace_base_environment + in: path + required: true + schema: + type: string + description: >- + The `workspace_base_environment` segment of the `name` resource name + (`workspace-base-environments/{workspace_base_environment}`). + Required. The resource name of the workspace base environment to + retrieve. Format: + workspace-base-environments/{workspace_base_environment} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/WorkspaceBaseEnvironment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + patch: + operationId: environments_update_workspace_base_environment + summary: >- + Updates an existing WorkspaceBaseEnvironment. This is a long-running + operation. The operation will + tags: + - environments + description: >- + Updates an existing WorkspaceBaseEnvironment. This is 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. + + + :param name: str + + :param workspace_base_environment: :class:`WorkspaceBaseEnvironment` + Required. The workspace base environment with updated fields. The name field is used to identify the + environment to update. + + :returns: :class:`Operation` + parameters: + - name: workspace_base_environment + in: path + required: true + schema: + $ref: '#/components/schemas/WorkspaceBaseEnvironment' + description: >- + Required. The workspace base environment with updated fields. The + name field is used to identify the environment to update. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + /api/environments/v1/default-workspace-base-environment: + get: + operationId: environments_get_default_workspace_base_environment + summary: >- + Gets the default WorkspaceBaseEnvironment configuration for the + workspace. Returns the current default + tags: + - environments + description: >- + Gets the default WorkspaceBaseEnvironment configuration for the + workspace. Returns the current default + + base environment settings for both CPU and GPU compute. + + + :param name: str + A static resource name of the default workspace base environment. Format: + default-workspace-base-environment + + :returns: :class:`DefaultWorkspaceBaseEnvironment` + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DefaultWorkspaceBaseEnvironment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + patch: + operationId: environments_update_default_workspace_base_environment + summary: >- + Updates the default WorkspaceBaseEnvironment configuration for the + workspace. Sets the specified base + tags: + - environments + description: >- + Updates the default WorkspaceBaseEnvironment configuration for the + workspace. Sets the specified base + + environments as the workspace defaults for CPU and/or GPU compute. + + + :param name: str + The resource name of this singleton resource. Format: default-workspace-base-environment + :param default_workspace_base_environment: + :class:`DefaultWorkspaceBaseEnvironment` + Required. The default workspace base environment configuration to update. + :param update_mask: FieldMask + Field mask specifying which fields to update. Use comma as the separator for multiple fields (no + space). The special value '*' indicates that all fields should be updated (full replacement). Valid + field paths: cpu_workspace_base_environment, gpu_workspace_base_environment + + To unset one or both defaults, include the field path(s) in the mask and omit them from the request + body. To unset both, you must list both paths explicitly — the wildcard '*' cannot be used to + unset fields. + + :returns: :class:`DefaultWorkspaceBaseEnvironment` + parameters: + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Field mask specifying which fields to update. Use comma as the + separator for multiple fields (no space). The special value '*' + indicates that all fields should be updated (full replacement). + Valid field paths: cpu_workspace_base_environment, + gpu_workspace_base_environment To unset one or both defaults, + include the field path(s) in the mask and omit them from the request + body. To unset both, you must list both paths explicitly — the + wildcard '*' cannot be used to unset fields. + requestBody: + content: + application/json: + schema: + type: object + properties: + cpu_workspace_base_environment: + type: string + description: >- + The default workspace base environment for CPU compute. + Format: + workspace-base-environments/{workspace_base_environment} + gpu_workspace_base_environment: + type: string + description: >- + The default workspace base environment for GPU compute. + Format: + workspace-base-environments/{workspace_base_environment} + name: + type: string + description: >- + The resource name of this singleton resource. Format: + default-workspace-base-environment + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DefaultWorkspaceBaseEnvironment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + /api/environments/v1/{name}: + get: + operationId: environments_get_operation + summary: >- + Gets the status of a long-running operation. Clients can use this method + to poll the operation result. + tags: + - environments + description: >- + Gets the status of a long-running operation. Clients can use this method + to poll the operation result. + + + :param name: str + The name of the operation resource. + + :returns: :class:`Operation` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the operation resource. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI + /api/environments/v1/workspace-base-environments/{workspace_base_environment}/refresh: + post: + operationId: environments_refresh_workspace_base_environment + summary: >- + Refreshes the materialized environment for a WorkspaceBaseEnvironment. + This is a long-running + tags: + - environments + description: >- + Refreshes the materialized environment for a WorkspaceBaseEnvironment. + This is 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. + + + :param name: str + Required. The resource name of the workspace base environment to delete. Format: + workspace-base-environments/{workspace_base_environment} + + :returns: :class:`Operation` + parameters: + - name: workspace_base_environment + in: path + required: true + schema: + type: string + description: >- + The `workspace_base_environment` segment of the `name` resource name + (`workspace-base-environments/{workspace_base_environment}`). + Required. The resource name of the workspace base environment to + delete. Format: + workspace-base-environments/{workspace_base_environment} + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: EnvironmentsAPI +components: + schemas: + DatabricksServiceExceptionWithDetailsProto: + type: object + properties: + details: + type: array + items: + type: object + error_code: + $ref: '#/components/schemas/ErrorCode' + message: + type: string + stack_trace: + type: string + description: Databricks Error that is returned by all Databricks APIs. + DefaultWorkspaceBaseEnvironment: + type: object + properties: + cpu_workspace_base_environment: + type: string + description: >- + The default workspace base environment for CPU compute. Format: + workspace-base-environments/{workspace_base_environment} + gpu_workspace_base_environment: + type: string + description: >- + The default workspace base environment for GPU compute. Format: + workspace-base-environments/{workspace_base_environment} + name: + type: string + description: >- + The resource name of this singleton resource. Format: + default-workspace-base-environment + description: >- + A singleton resource representing the default workspace base environment + configuration. This + resource contains the workspace base environments that are used as defaults for serverless + notebooks and jobs in the workspace, for both CPU and GPU compute types. + EnvironmentSpec: + type: object + properties: + dependencies: + type: array + items: + type: string + description: >- + List of pip dependencies, as supported by the version of pip in this + environment. Each dependency is a valid pip requirements file line + per + https://pip.pypa.io/en/stable/reference/requirements-file-format/. + Allowed dependencies include a requirement specifier, an archive + URL, a local project path (such as WSFS or UC Volumes in + Databricks), or a VCS project URL. + environment_version: + type: string + description: >- + Environment version used by the environment. Each version comes with + a specific Python version and a set of Python packages. The version + is a string, consisting of an integer. + description: >- + Environment specification for a WorkspaceBaseEnvironment. Contains the + environment version and + dependencies configuration. + ListWorkspaceBaseEnvironmentsResponse: + type: object + properties: + next_page_token: + type: string + description: >- + Token to retrieve the next page of results. Empty if there are no + more results. + workspace_base_environments: + type: array + items: + $ref: '#/components/schemas/WorkspaceBaseEnvironment' + description: The list of workspace base environments. + description: Response message for ListWorkspaceBaseEnvironments. + Operation: + type: object + properties: + done: + type: boolean + description: >- + If the value is ``false``, it means the operation is still in + progress. If ``true``, the operation is completed, and either + ``error`` or ``response`` is available. + error: + $ref: '#/components/schemas/DatabricksServiceExceptionWithDetailsProto' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the ``name`` should be a resource name ending with + ``operations/{unique_id}``. + response: + type: object + description: The normal, successful response of the operation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + WorkspaceBaseEnvironment: + type: object + properties: + display_name: + type: string + description: Human-readable display name for the workspace base environment. + base_environment_type: + $ref: '#/components/schemas/BaseEnvironmentType' + description: The type of base environment (CPU or GPU). + create_time: + type: string + format: date-time + description: Timestamp when the environment was created. + creator_user_id: + type: string + description: User ID of the creator. + filepath: + type: string + description: The WSFS or UC Volumes path to the environment YAML file. + is_default: + type: boolean + description: Whether this is the default environment for the workspace. + last_updated_user_id: + type: string + description: User ID of the last user who updated the environment. + message: + type: string + description: >- + Status message providing additional details about the environment + status. + name: + type: string + description: >- + The resource name of the workspace base environment. Format: + workspace-base-environments/{workspace-base-environment} + spec: + $ref: '#/components/schemas/EnvironmentSpec' + description: The environment specification containing version and dependencies. + status: + $ref: '#/components/schemas/WorkspaceBaseEnvironmentCacheStatus' + description: The status of the materialized workspace base environment. + update_time: + type: string + format: date-time + description: Timestamp when the environment was last updated. + required: + - display_name + description: >- + A WorkspaceBaseEnvironment defines a workspace-level environment + configuration consisting of an + environment version and a list of dependencies. + WorkspaceBaseEnvironmentOperationMetadata: + type: object + properties: {} + description: >- + Metadata for the WorkspaceBaseEnvironment long-running operations. This + message tracks the + progress of the workspace base environment long-running process. + BaseEnvironmentType: + type: string + x-enum: + - CPU + - GPU + description: >- + If changed, also update + estore/namespaces/defaultbaseenvironments/latest.proto + ErrorCode: + type: string + x-enum: + - ABORTED + - ALREADY_EXISTS + - BAD_REQUEST + - CANCELLED + - CATALOG_ALREADY_EXISTS + - CATALOG_DOES_NOT_EXIST + - CATALOG_NOT_EMPTY + - COULD_NOT_ACQUIRE_LOCK + - CUSTOMER_UNAUTHORIZED + - DAC_ALREADY_EXISTS + - DAC_DOES_NOT_EXIST + - DATA_LOSS + - DEADLINE_EXCEEDED + - DEPLOYMENT_TIMEOUT + - DIRECTORY_NOT_EMPTY + - DIRECTORY_PROTECTED + - DRY_RUN_FAILED + - ENDPOINT_NOT_FOUND + - EXTERNAL_LOCATION_ALREADY_EXISTS + - EXTERNAL_LOCATION_DOES_NOT_EXIST + - FEATURE_DISABLED + - GIT_CONFLICT + - GIT_REMOTE_ERROR + - GIT_SENSITIVE_TOKEN_DETECTED + - GIT_UNKNOWN_REF + - GIT_URL_NOT_ON_ALLOW_LIST + - INSECURE_PARTNER_RESPONSE + - INTERNAL_ERROR + - INVALID_PARAMETER_VALUE + - INVALID_STATE + - INVALID_STATE_TRANSITION + - IO_ERROR + - IPYNB_FILE_IN_REPO + - MALFORMED_PARTNER_RESPONSE + - MALFORMED_REQUEST + - MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST + - MAX_BLOCK_SIZE_EXCEEDED + - MAX_CHILD_NODE_SIZE_EXCEEDED + - MAX_LIST_SIZE_EXCEEDED + - MAX_NOTEBOOK_SIZE_EXCEEDED + - MAX_READ_SIZE_EXCEEDED + - METASTORE_ALREADY_EXISTS + - METASTORE_DOES_NOT_EXIST + - METASTORE_NOT_EMPTY + - NOT_FOUND + - NOT_IMPLEMENTED + - PARTIAL_DELETE + - PERMISSION_DENIED + - PERMISSION_NOT_PROPAGATED + - PRINCIPAL_DOES_NOT_EXIST + - PROJECTS_OPERATION_TIMEOUT + - PROVIDER_ALREADY_EXISTS + - PROVIDER_DOES_NOT_EXIST + - PROVIDER_SHARE_NOT_ACCESSIBLE + - QUOTA_EXCEEDED + - RECIPIENT_ALREADY_EXISTS + - RECIPIENT_DOES_NOT_EXIST + - REQUEST_LIMIT_EXCEEDED + - RESOURCE_ALREADY_EXISTS + - RESOURCE_CONFLICT + - RESOURCE_DOES_NOT_EXIST + - RESOURCE_EXHAUSTED + - RESOURCE_LIMIT_EXCEEDED + - SCHEMA_ALREADY_EXISTS + - SCHEMA_DOES_NOT_EXIST + - SCHEMA_NOT_EMPTY + - SEARCH_QUERY_TOO_LONG + - SEARCH_QUERY_TOO_SHORT + - SERVICE_UNDER_MAINTENANCE + - SHARE_ALREADY_EXISTS + - SHARE_DOES_NOT_EXIST + - STORAGE_CREDENTIAL_ALREADY_EXISTS + - STORAGE_CREDENTIAL_DOES_NOT_EXIST + - TABLE_ALREADY_EXISTS + - TABLE_DOES_NOT_EXIST + - TEMPORARILY_UNAVAILABLE + - UNAUTHENTICATED + - UNAVAILABLE + - UNKNOWN + - UNPARSEABLE_HTTP_ERROR + - WORKSPACE_TEMPORARILY_UNAVAILABLE + description: >- + Error codes returned by Databricks APIs to indicate specific failure + conditions. + WorkspaceBaseEnvironmentCacheStatus: + type: string + x-enum: + - CREATED + - EXPIRED + - FAILED + - INVALID + - PENDING + - REFRESHING + description: Status of the environment materialization. + x-stackQL-resources: + workspace_base_environments: + id: databricks_workspace.environments.workspace_base_environments + name: workspace_base_environments + title: Workspace Base Environments + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~1environments~1v1~1workspace-base-environments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~1environments~1v1~1workspace-base-environments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workspace_base_environments + delete: + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1workspace-base-environments~1{workspace_base_environment}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1workspace-base-environments~1{workspace_base_environment}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1workspace-base-environments~1{workspace_base_environment}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + refresh: + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1workspace-base-environments~1{workspace_base_environment}~1refresh/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workspace_base_environments/methods/get + - $ref: >- + #/components/x-stackQL-resources/workspace_base_environments/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/workspace_base_environments/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/workspace_base_environments/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/workspace_base_environments/methods/delete + replace: [] + default_workspace_base_environment: + id: databricks_workspace.environments.default_workspace_base_environment + name: default_workspace_base_environment + title: Default Workspace Base Environment + methods: + get: + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1default-workspace-base-environment/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~1environments~1v1~1default-workspace-base-environment/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/default_workspace_base_environment/methods/get + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/default_workspace_base_environment/methods/update + delete: [] + replace: [] + environment_operations: + id: databricks_workspace.environments.environment_operations + name: environment_operations + title: Environment Operations + methods: + get: + operation: + $ref: '#/paths/~1api~1environments~1v1~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environment_operations/methods/get + insert: [] + update: [] + delete: [] + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/files.yaml b/providers/src/databricks_workspace/v00.00.00000/services/files.yaml index e0e7feeb..02993ce3 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/files.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/files.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.files servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/dbfs/add-block: post: @@ -1106,7 +1123,7 @@ components: DownloadResponse: type: object properties: - content_length: + content-length: type: integer content-type: type: string @@ -1133,7 +1150,7 @@ components: GetMetadataResponse: type: object properties: - content_length: + content-length: type: integer content-type: type: string diff --git a/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml index 6ae202c9..23dbefef 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml @@ -5,14 +5,28 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.iam servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/access-control/check-policy-v2: get: @@ -1147,7 +1161,6 @@ paths: - CAN_VIEW - CAN_VIEW_METADATA - IS_OWNER - - UNSPECIFIED description: Permission level service_principal_name: type: string @@ -1247,7 +1260,6 @@ paths: - CAN_VIEW - CAN_VIEW_METADATA - IS_OWNER - - UNSPECIFIED description: Permission level service_principal_name: type: string @@ -2459,12 +2471,13 @@ paths: x-stackql-sdk-source: UsersV2API put: operationId: users_v2_update - summary: Replaces a user's information with the data supplied in request. + summary: Replaces a user's information with the data supplied in request. The ``userName`` and ``emails`` tags: - iam - users_v2 description: |- - Replaces a user's information with the data supplied in request. + Replaces a user's information with the data supplied in request. The ``userName`` and ``emails`` + attributes cannot be updated through this API; any supplied changes to them are ignored (no-op). :param id: str Databricks user ID. @@ -2476,7 +2489,8 @@ paths: `__. Use Account SCIM APIs to update ``displayName``. :param emails: List[:class:`ComplexValue`] (optional) - All the emails associated with the Databricks user. + All the emails associated with the Databricks user. This attribute cannot be updated through the + SCIM PATCH or PUT APIs; any supplied change is ignored. :param entitlements: List[:class:`ComplexValue`] (optional) Entitlements assigned to the user. See `assigning entitlements `__ @@ -2490,7 +2504,8 @@ paths: :param schemas: List[:class:`UserSchema`] (optional) The schema of the user. :param user_name: str (optional) - Email address of the Databricks user. + Email address of the Databricks user. This attribute cannot be updated through the SCIM PATCH or PUT + APIs; any supplied change is ignored. parameters: - name: id in: path @@ -2527,7 +2542,8 @@ paths: type: string value: type: string - description: All the emails associated with the Databricks user. + description: All the emails associated with the Databricks user. This attribute cannot be updated through + the SCIM PATCH or PUT APIs; any supplied change is ignored. entitlements: type: array items: @@ -2634,7 +2650,8 @@ paths: description: The schema of the user. userName: type: string - description: Email address of the Databricks user. + description: Email address of the Databricks user. This attribute cannot be updated through the SCIM PATCH + or PUT APIs; any supplied change is ignored. responses: '200': description: Success @@ -3295,16 +3312,10 @@ components: PermissionAssignments: type: object properties: - next_page_token: - type: string permission_assignments: type: array items: $ref: '#/components/schemas/PermissionAssignment' - description: Array of permissions assignments defined for a workspace. - prev_page_token: - type: string - description: Token to retrieve the previous page of results. PermissionOutput: type: object properties: @@ -3751,7 +3762,6 @@ components: - CAN_VIEW - CAN_VIEW_METADATA - IS_OWNER - - UNSPECIFIED description: Permission level RequestAuthzIdentity: type: string @@ -4353,7 +4363,6 @@ components: JSON_EXTRACT(e.value, '$.primary') AS is_primary FROM databricks_workspace.iam.users_v2 u, JSON_EACH(u.emails) e - WHERE u.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4371,7 +4380,6 @@ components: (e.value->>'primary')::boolean AS is_primary FROM databricks_workspace.iam.users_v2 u, jsonb_array_elements(u.emails::jsonb) AS e - WHERE u.deployment_name = '{{ deployment_name }}' vw_user_roles: name: vw_user_roles id: databricks_workspace.iam.vw_user_roles @@ -4409,7 +4417,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_workspace.iam.users_v2 u, JSON_EACH(u.roles) r - WHERE u.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4421,7 +4428,6 @@ components: r.value->>'value' AS role FROM databricks_workspace.iam.users_v2 u, jsonb_array_elements(u.roles::jsonb) AS r - WHERE u.deployment_name = '{{ deployment_name }}' vw_user_entitlements: name: vw_user_entitlements id: databricks_workspace.iam.vw_user_entitlements @@ -4460,7 +4466,6 @@ components: JSON_EXTRACT(e.value, '$.value') AS entitlement FROM databricks_workspace.iam.users_v2 u, JSON_EACH(u.entitlements) e - WHERE u.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4472,7 +4477,6 @@ components: e.value->>'value' AS entitlement FROM databricks_workspace.iam.users_v2 u, jsonb_array_elements(u.entitlements::jsonb) AS e - WHERE u.deployment_name = '{{ deployment_name }}' vw_user_groups: name: vw_user_groups id: databricks_workspace.iam.vw_user_groups @@ -4522,7 +4526,6 @@ components: JSON_EXTRACT(g.value, '$.type') AS group_type FROM databricks_workspace.iam.users_v2 u, JSON_EACH(u.groups) g - WHERE u.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4537,7 +4540,6 @@ components: g.value->>'type' AS group_type FROM databricks_workspace.iam.users_v2 u, jsonb_array_elements(u.groups::jsonb) AS g - WHERE u.deployment_name = '{{ deployment_name }}' vw_group_members: name: vw_group_members id: databricks_workspace.iam.vw_group_members @@ -4583,7 +4585,6 @@ components: JSON_EXTRACT(m.value, '$.type') AS member_type FROM databricks_workspace.iam.groups_v2 g, JSON_EACH(g.members) m - WHERE g.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4597,7 +4598,6 @@ components: m.value->>'type' AS member_type FROM databricks_workspace.iam.groups_v2 g, jsonb_array_elements(g.members::jsonb) AS m - WHERE g.deployment_name = '{{ deployment_name }}' vw_group_entitlements: name: vw_group_entitlements id: databricks_workspace.iam.vw_group_entitlements @@ -4632,7 +4632,6 @@ components: JSON_EXTRACT(e.value, '$.value') AS entitlement FROM databricks_workspace.iam.groups_v2 g, JSON_EACH(g.entitlements) e - WHERE g.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4643,7 +4642,6 @@ components: e.value->>'value' AS entitlement FROM databricks_workspace.iam.groups_v2 g, jsonb_array_elements(g.entitlements::jsonb) AS e - WHERE g.deployment_name = '{{ deployment_name }}' vw_group_roles: name: vw_group_roles id: databricks_workspace.iam.vw_group_roles @@ -4677,7 +4675,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_workspace.iam.groups_v2 g, JSON_EACH(g.roles) r - WHERE g.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4688,7 +4685,6 @@ components: r.value->>'value' AS role FROM databricks_workspace.iam.groups_v2 g, jsonb_array_elements(g.roles::jsonb) AS r - WHERE g.deployment_name = '{{ deployment_name }}' vw_service_principal_entitlements: name: vw_service_principal_entitlements id: databricks_workspace.iam.vw_service_principal_entitlements @@ -4731,7 +4727,6 @@ components: JSON_EXTRACT(e.value, '$.value') AS entitlement FROM databricks_workspace.iam.service_principals_v2 sp, JSON_EACH(sp.entitlements) e - WHERE sp.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4744,7 +4739,6 @@ components: e.value->>'value' AS entitlement FROM databricks_workspace.iam.service_principals_v2 sp, jsonb_array_elements(sp.entitlements::jsonb) AS e - WHERE sp.deployment_name = '{{ deployment_name }}' vw_service_principal_roles: name: vw_service_principal_roles id: databricks_workspace.iam.vw_service_principal_roles @@ -4786,7 +4780,6 @@ components: JSON_EXTRACT(r.value, '$.value') AS role FROM databricks_workspace.iam.service_principals_v2 sp, JSON_EACH(sp.roles) r - WHERE sp.deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4799,7 +4792,6 @@ components: r.value->>'value' AS role FROM databricks_workspace.iam.service_principals_v2 sp, jsonb_array_elements(sp.roles::jsonb) AS r - WHERE sp.deployment_name = '{{ deployment_name }}' vw_permissions: name: vw_permissions id: databricks_workspace.iam.vw_permissions @@ -4873,9 +4865,6 @@ components: FROM databricks_workspace.iam.permissions p, JSON_EACH(p.access_control_list) acl, JSON_EACH(JSON_EXTRACT(acl.value, '$.all_permissions')) perm - WHERE p.deployment_name = '{{ deployment_name }}' - AND p.request_object_type = '{{ request_object_type }}' - AND p.request_object_id = '{{ request_object_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4895,9 +4884,6 @@ components: FROM databricks_workspace.iam.permissions p, jsonb_array_elements(p.access_control_list::jsonb) AS acl, jsonb_array_elements((acl.value->'all_permissions')::jsonb) AS perm - WHERE p.deployment_name = '{{ deployment_name }}' - AND p.request_object_type = '{{ request_object_type }}' - AND p.request_object_id = '{{ request_object_id }}' vw_rule_set_grant_principals: name: vw_rule_set_grant_principals id: databricks_workspace.iam.vw_rule_set_grant_principals @@ -4942,9 +4928,6 @@ components: FROM databricks_workspace.iam.rule_sets rs, JSON_EACH(rs.grant_rules) gr, JSON_EACH(JSON_EXTRACT(gr.value, '$.principals')) pr - WHERE rs.deployment_name = '{{ deployment_name }}' - AND rs.name = '{{ name }}' - AND rs.etag = '{{ etag }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -4957,9 +4940,6 @@ components: FROM databricks_workspace.iam.rule_sets rs, jsonb_array_elements(rs.grant_rules::jsonb) AS gr, jsonb_array_elements((gr.value->'principals')::jsonb) AS pr - WHERE rs.deployment_name = '{{ deployment_name }}' - AND rs.name = '{{ name }}' - AND rs.etag = '{{ etag }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml b/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml index b98f7aac..ae4059cf 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml @@ -5,14 +5,28 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.iamv2 servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/identity/groups/{group_id}/direct-members: post: @@ -43,36 +57,33 @@ paths: schema: type: object properties: - direct_group_member: - type: object - properties: - principal_id: - type: integer - description: Internal ID of the principal in Databricks. - display_name: - type: string - description: Display name of the principal. - external_id: - type: string - description: The external ID of the principal in Databricks. - membership_source: - type: string - x-enum: - - IDENTITY_PROVIDER - - INTERNAL - description: The source of group membership (internal or from identity provider). - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/service principal/group). - required: - - principal_id - description: Required. The group membership to create. + principal_id: + type: integer + description: Internal ID of the principal in Databricks. + display_name: + type: string + description: Display name of the principal. + external_id: + type: string + description: The external ID of the principal in the customer's IdP. + group_id: + type: integer + description: The internal ID of the group this member belongs to. + membership_source: + type: string + x-enum: + - IDENTITY_PROVIDER + - INTERNAL + description: The source of group membership (internal or from identity provider). + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/service principal/group). required: - - direct_group_member + - principal_id responses: '200': description: Success @@ -106,12 +117,12 @@ paths: Required. Internal ID of the group in Databricks whose direct members are being listed. :param page_size: int (optional) The maximum number of members to return. The service may return fewer than this value. If not - provided, defaults to 1000 (also the maximum allowed). + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) - A page token, received from a previous ListDirectGroupMembersProxy call. Provide this to retrieve - the subsequent page. + A page token from a previous list call. Provide this to retrieve the subsequent page. - :returns: :class:`ListDirectGroupMembersResponse` + :returns: Iterator over :class:`DirectGroupMember` parameters: - name: group_id in: path @@ -125,14 +136,13 @@ paths: schema: type: integer description: The maximum number of members to return. The service may return fewer than this value. If not provided, - defaults to 1000 (also the maximum allowed). + defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000. - name: page_token in: query required: false schema: type: string - description: A page token, received from a previous ListDirectGroupMembersProxy call. Provide this to retrieve the - subsequent page. + description: A page token from a previous list call. Provide this to retrieve the subsequent page. responses: '200': description: Success @@ -155,16 +165,21 @@ paths: /api/2.0/identity/groups: post: operationId: workspace_iam_v2_create_group_proxy - summary: Creates a group in the Databricks account that parents the calling workspace and returns the resulting + summary: Creates a local group in the Databricks account that parents the calling workspace and returns the tags: - iamv2 - workspace_iam_v2 description: |- - Creates a group in the Databricks account that parents the calling workspace and returns the resulting - Group resource. + Creates a local group in the Databricks account that parents the calling workspace and returns the + created group. A local group is one that is not synced from the customer's identity provider, and can + be created whether or not Account Identity Management (AIM) is enabled. + + When AIM is enabled, supplying an external ID returns an error. To provision the identity from your + identity provider, resolve it by its external ID with ResolveGroup; to read an existing external + identity, use the ExternalGroup resource. :param group: :class:`Group` - Required. Group to be created in + Required. Group to be created in Databricks :returns: :class:`Group` requestBody: @@ -173,24 +188,18 @@ paths: schema: type: object properties: - group: - type: object - properties: - account_id: - type: string - description: The parent account ID for group in Databricks. - external_id: - type: string - description: ExternalId of the group in the customer's IdP. - group_name: - type: string - description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. - description: Required. Group to be created in - required: - - group + account_id: + type: string + description: The parent account ID for group in Databricks. + external_id: + type: string + description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. + group_name: + type: string + description: Display name of the group. responses: '200': description: Success @@ -223,12 +232,14 @@ paths: :param filter: str (optional) Optional. Allows filtering groups by group name or external id. :param page_size: int (optional) - The maximum number of groups to return. The service may return fewer than this value. + The maximum number of groups to return. The service may return fewer than this value. If not + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page. - :returns: :class:`ListGroupsResponse` + :returns: Iterator over :class:`Group` parameters: - name: filter in: query @@ -241,7 +252,8 @@ paths: required: false schema: type: integer - description: The maximum number of groups to return. The service may return fewer than this value. + description: The maximum number of groups to return. The service may return fewer than this value. If not provided, + defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000. - name: page_token in: query required: false @@ -270,16 +282,22 @@ paths: /api/2.0/identity/service-principals: post: operationId: workspace_iam_v2_create_service_principal_proxy - summary: Creates a service principal in the Databricks account that parents the calling workspace and returns + summary: Creates a local service principal in the Databricks account that parents the calling workspace and tags: - iamv2 - workspace_iam_v2 description: |- - Creates a service principal in the Databricks account that parents the calling workspace and returns - the resulting ServicePrincipal resource. + Creates a local service principal in the Databricks account that parents the calling workspace and + returns the created service principal. A local service principal is one that is not synced from the + customer's identity provider, and can be created whether or not Account Identity Management (AIM) is + enabled. + + When AIM is enabled, supplying an external ID returns an error. To provision the identity from your + identity provider, resolve it by its external ID with ResolveServicePrincipal; to read an existing + external identity, use the ExternalServicePrincipal resource. :param service_principal: :class:`ServicePrincipal` - Required. Service principal to be created in + Required. Service principal to be created in Databricks :returns: :class:`ServicePrincipal` requestBody: @@ -288,33 +306,31 @@ paths: schema: type: object properties: - service_principal: - type: object - properties: - account_id: - type: string - description: The parent account ID for the service principal in Databricks. - account_sp_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a service principal in a Databricks account. - application_id: - type: string - description: Application ID of the service principal. - display_name: - type: string - description: Display name of the service principal. - external_id: - type: string - description: ExternalId of the service principal in the customer's IdP. - internal_id: - type: string - description: Internal service principal ID of the service principal in Databricks. - description: Required. Service principal to be created in + display_name: + type: string + description: Display name of the service principal. + account_sp_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a service principal in a Databricks account. + account_id: + type: string + description: The parent account ID for the service principal in Databricks. + application_id: + type: string + description: Application ID of the service principal. Set at creation time and cannot be changed afterwards; + when omitted, the server generates one. + external_id: + type: string + description: ExternalId of the service principal in the customer's IdP. + service_principal_id: + type: string + description: Internal service principal ID of the service principal in Databricks. required: - - service_principal + - display_name + - account_sp_status responses: '200': description: Success @@ -347,12 +363,14 @@ paths: :param filter: str (optional) Optional. Allows filtering service principals by application id or external id. :param page_size: int (optional) - The maximum number of SPs to return. The service may return fewer than this value. + The maximum number of SPs to return. The service may return fewer than this value. If not provided, + defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped + to 1000. :param page_token: str (optional) A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page. - :returns: :class:`ListServicePrincipalsResponse` + :returns: Iterator over :class:`ServicePrincipal` parameters: - name: filter in: query @@ -365,7 +383,8 @@ paths: required: false schema: type: integer - description: The maximum number of SPs to return. The service may return fewer than this value. + description: The maximum number of SPs to return. The service may return fewer than this value. If not provided, defaults + to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000. - name: page_token in: query required: false @@ -395,16 +414,21 @@ paths: /api/2.0/identity/users: post: operationId: workspace_iam_v2_create_user_proxy - summary: Creates a user in the Databricks account that parents the calling workspace and returns the resulting + summary: Creates a local user in the Databricks account that parents the calling workspace and returns the tags: - iamv2 - workspace_iam_v2 description: |- - Creates a user in the Databricks account that parents the calling workspace and returns the resulting - User resource. The same AIM-dependent provisioning behavior described on CreateUser applies. + Creates a local user in the Databricks account that parents the calling workspace and returns the + created user. A local user is one that is not synced from the customer's identity provider, and can be + created whether or not Account Identity Management (AIM) is enabled. + + When AIM is enabled, supplying an external ID returns an error. To provision the identity from your + identity provider, resolve it by its external ID with ResolveUser; to read an existing external + identity, use the ExternalUser resource. :param user: :class:`User` - Required. User to be created in + Required. User to be created in Databricks :returns: :class:`User` requestBody: @@ -413,37 +437,35 @@ paths: schema: type: object properties: - user: + username: + type: string + description: Username/email of the user. + full_name: type: object properties: - account_id: - type: string - description: The accountId parent of the user in Databricks. - account_user_status: + family_name: type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a user in a Databricks account. - external_id: + given_name: type: string - description: ExternalId of the user in the customer's IdP. - full_name: - type: object - properties: - family_name: - type: string - given_name: - type: string - internal_id: - type: string - description: Internal userId of the user in Databricks. - username: - type: string - description: Username/email of the user. - description: Required. User to be created in + account_user_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. + external_id: + type: string + description: ExternalId of the user in the customer's IdP. + user_id: + type: string + description: Internal userId of the user in Databricks. required: - - user + - username + - full_name + - account_user_status responses: '200': description: Success @@ -476,11 +498,13 @@ paths: :param filter: str (optional) Optional. Allows filtering users by username or external id. :param page_size: int (optional) - The maximum number of users to return. The service may return fewer than this value. + The maximum number of users to return. The service may return fewer than this value. If not + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. - :returns: :class:`ListUsersResponse` + :returns: Iterator over :class:`User` parameters: - name: filter in: query @@ -493,7 +517,8 @@ paths: required: false schema: type: integer - description: The maximum number of users to return. The service may return fewer than this value. + description: The maximum number of users to return. The service may return fewer than this value. If not provided, + defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000. - name: page_token in: query required: false @@ -522,18 +547,15 @@ paths: /api/2.0/identity/workspace-assignment-details: post: operationId: workspace_iam_v2_create_workspace_assignment_detail_proxy - summary: Creates a workspace assignment detail for a principal (workspace-level proxy). Entitlement grants are + summary: Creates a workspace assignment detail for a principal in the calling workspace. tags: - iamv2 - workspace_iam_v2 description: |- - Creates a workspace assignment detail for a principal (workspace-level proxy). Entitlement grants are - applied individually and non-atomically — if a failure occurs partway through, the principal will be - assigned to the workspace but with only a subset of the requested entitlements. Use - GetWorkspaceAssignmentDetail to confirm which entitlements were successfully granted. + Creates a workspace assignment detail for a principal in the calling workspace. :param workspace_assignment_detail: :class:`WorkspaceAssignmentDetail` - Required. Workspace assignment detail to be created in . + Required. Workspace assignment detail to be created in Databricks. :returns: :class:`WorkspaceAssignmentDetail` requestBody: @@ -542,132 +564,125 @@ paths: schema: type: object properties: - workspace_assignment_detail: - type: object - properties: - principal_id: - type: integer - description: The internal ID of the principal (user/sp/group) in Databricks. - account_id: - type: string - description: The account ID parent of the workspace where the principal is assigned - effective_entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: |- - Create a collection of name/value pairs. + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: The account ID parent of the workspace where the principal is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: 'The principal''s full effective entitlements granted in this workspace: every entitlement - it holds whether granted directly or via group membership. Populated on Get; empty on List.' - entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Every entitlement the principal holds in this workspace, whether granted directly or through + group membership. Get responses populate this field. List responses leave it empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: 'Entitlements granted directly to the principal on this workspace. The only client-settable - field: create and update manage exactly this set (including entitlements the principal also holds - via a group). Not populated by ListWorkspaceAssignmentDetails (omitted for scalability); call GetWorkspaceAssignmentDetail - to read the entitlements for a single principal.' - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/sp/group). - workspace_id: - type: integer - description: The workspace ID where the principal is assigned - required: - - principal_id - description: Required. Workspace assignment detail to be created in . + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through + a group. List responses leave this field empty. Get a single principal to read its entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/sp/group). + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - workspace_assignment_detail + - principal_id responses: '200': description: Success @@ -689,23 +704,23 @@ paths: x-stackql-sdk-source: WorkspaceIamV2API get: operationId: workspace_iam_v2_list_workspace_assignment_details_proxy - summary: Lists workspace assignment details for a workspace (workspace-level proxy). For scalability, the + summary: Lists workspace assignment details for the calling workspace. The response omits the per-principal tags: - iamv2 - workspace_iam_v2 description: |- - Lists workspace assignment details for a workspace (workspace-level proxy). For scalability, the - response omits the per-principal entitlement fields (``entitlements`` and ``effective_entitlements``); - call GetWorkspaceAssignmentDetailProxy to read entitlements for a single principal. + Lists workspace assignment details for the calling workspace. The response omits the per-principal + entitlement fields (``entitlements`` and ``effective_entitlements``). To read the entitlements for a + single principal, get that principal's assignment detail. :param page_size: int (optional) The maximum number of workspace assignment details to return. The service may return fewer than this - value. + value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than + the maximum are clamped to 1000. :param page_token: str (optional) - A page token, received from a previous ListWorkspaceAssignmentDetailsProxy call. Provide this to - retrieve the subsequent page. + A page token from a previous list call. Provide this to retrieve the subsequent page. - :returns: :class:`ListWorkspaceAssignmentDetailsResponse` + :returns: Iterator over :class:`WorkspaceAssignmentDetail` parameters: - name: page_size in: query @@ -713,14 +728,14 @@ paths: schema: type: integer description: The maximum number of workspace assignment details to return. The service may return fewer than this - value. + value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. - name: page_token in: query required: false schema: type: string - description: A page token, received from a previous ListWorkspaceAssignmentDetailsProxy call. Provide this to retrieve - the subsequent page. + description: A page token from a previous list call. Provide this to retrieve the subsequent page. responses: '200': description: Success @@ -740,6 +755,220 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API + /api/2.0/identity/workspace-assignments: + post: + operationId: workspace_iam_v2_create_workspace_assignment_proxy + summary: Creates a workspace assignment for a principal in the calling workspace. Entitlements are granted one + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Creates a workspace assignment for a principal in the calling workspace. Entitlements are granted one + at a time rather than atomically. If the request fails partway through, the principal stays assigned + to the workspace with only some of the requested entitlements. Get the assignment afterwards to + confirm which entitlements were granted. + + :param workspace_assignment: :class:`WorkspaceAssignment` + Required. Workspace assignment to be created in Databricks. + + :returns: :class:`WorkspaceAssignment` + requestBody: + content: + application/json: + schema: + type: object + properties: + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: The account ID parent of the workspace where the principal is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Every entitlement the principal holds in this workspace, whether granted directly or through + group membership. Get responses populate this field. List responses leave it empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through + a group. List responses leave this field empty. Get a single principal to read its entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/service principal/group) that is assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. + required: + - principal_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/WorkspaceAssignment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + get: + operationId: workspace_iam_v2_list_workspace_assignments_proxy + summary: Lists workspace assignments for the calling workspace. The response omits the per-principal + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Lists workspace assignments for the calling workspace. The response omits the per-principal + entitlement fields (``entitlements`` and ``effective_entitlements``). To read the entitlements for a + single principal, get that principal's assignment. + + :param page_size: int (optional) + The maximum number of workspace assignments to return. The service may return fewer than this value. + If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the + maximum are clamped to 1000. + :param page_token: str (optional) + A page token from a previous list call. Provide this to retrieve the subsequent page. + + :returns: Iterator over :class:`WorkspaceAssignment` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: The maximum number of workspace assignments to return. The service may return fewer than this value. + If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped + to 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: A page token from a previous list call. Provide this to retrieve the subsequent page. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkspaceAssignmentsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API /api/2.0/identity/groups/{group_id}/direct-members/{principal_id}: delete: operationId: workspace_iam_v2_delete_direct_group_member_proxy @@ -829,7 +1058,7 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API - /api/2.0/identity/groups/{internal_id}: + /api/2.0/identity/groups/{group_id}: delete: operationId: workspace_iam_v2_delete_group_proxy summary: Deletes a group by its internal ID from the Databricks account that parents the calling workspace. @@ -839,10 +1068,10 @@ paths: description: |- Deletes a group by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param group_id: str Required. Internal ID of the group in Databricks. parameters: - - name: internal_id + - name: group_id in: path required: true schema: @@ -872,12 +1101,12 @@ paths: description: |- Fetches a group by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param group_id: str Required. Internal ID of the group in Databricks. :returns: :class:`Group` parameters: - - name: internal_id + - name: group_id in: path required: true schema: @@ -912,16 +1141,21 @@ paths: Updates an existing group in the Databricks account that parents the calling workspace. Only the fields named in the update mask are modified. Returns the updated Group resource. - :param internal_id: str + When AIM is enabled and the group is an external identity (its external_id is set), only external_id + can be updated; its other fields are sourced from your identity provider. With AIM and group + visibility filters, a new nonempty external_id must identify a visible group. Clearing external_id is + allowed. + + :param group_id: str Required. Internal ID of the group in Databricks. :param group: :class:`Group` - Required. Group to be updated in + Required. Group to be updated in Databricks :param update_mask: str - Optional. The list of fields to update. + Required. The list of fields to update. :returns: :class:`Group` parameters: - - name: internal_id + - name: group_id in: path required: true schema: @@ -932,31 +1166,25 @@ paths: required: true schema: type: string - description: Optional. The list of fields to update. + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - group: - type: object - properties: - account_id: - type: string - description: The parent account ID for group in Databricks. - external_id: - type: string - description: ExternalId of the group in the customer's IdP. - group_name: - type: string - description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. - description: Required. Group to be updated in - required: - - group + account_id: + type: string + description: The parent account ID for group in Databricks. + external_id: + type: string + description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. + group_name: + type: string + description: Display name of the group. responses: '200': description: Success @@ -976,7 +1204,7 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API - /api/2.0/identity/service-principals/{internal_id}: + /api/2.0/identity/service-principals/{service_principal_id}: delete: operationId: workspace_iam_v2_delete_service_principal_proxy summary: Deletes a service principal by its internal ID from the Databricks account that parents the calling @@ -987,10 +1215,10 @@ paths: Deletes a service principal by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param service_principal_id: str Required. Internal ID of the service principal in Databricks. parameters: - - name: internal_id + - name: service_principal_id in: path required: true schema: @@ -1021,12 +1249,12 @@ paths: Fetches a service principal by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param service_principal_id: str Required. Internal ID of the service principal in Databricks. :returns: :class:`ServicePrincipal` parameters: - - name: internal_id + - name: service_principal_id in: path required: true schema: @@ -1061,16 +1289,21 @@ paths: Updates an existing service principal in the Databricks account that parents the calling workspace. Only the fields named in the update mask are modified. Returns the updated ServicePrincipal resource. - :param internal_id: str + For locally managed service principals, is_agent must be set to true or false when updated. + + When AIM is enabled and the service principal is an external identity (its external_id is set), only + external_id can be updated; its other fields are sourced from your identity provider. + + :param service_principal_id: str Required. Internal ID of the service principal in Databricks. :param service_principal: :class:`ServicePrincipal` - Required. Service principal to be updated in + Required. Service principal to be updated in Databricks :param update_mask: str - Optional. The list of fields to update. + Required. The list of fields to update. :returns: :class:`ServicePrincipal` parameters: - - name: internal_id + - name: service_principal_id in: path required: true schema: @@ -1081,40 +1314,38 @@ paths: required: true schema: type: string - description: Optional. The list of fields to update. + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - service_principal: - type: object - properties: - account_id: - type: string - description: The parent account ID for the service principal in Databricks. - account_sp_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a service principal in a Databricks account. - application_id: - type: string - description: Application ID of the service principal. - display_name: - type: string - description: Display name of the service principal. - external_id: - type: string - description: ExternalId of the service principal in the customer's IdP. - internal_id: - type: string - description: Internal service principal ID of the service principal in Databricks. - description: Required. Service principal to be updated in + display_name: + type: string + description: Display name of the service principal. + account_sp_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a service principal in a Databricks account. + account_id: + type: string + description: The parent account ID for the service principal in Databricks. + application_id: + type: string + description: Application ID of the service principal. Set at creation time and cannot be changed afterwards; + when omitted, the server generates one. + external_id: + type: string + description: ExternalId of the service principal in the customer's IdP. + service_principal_id: + type: string + description: Internal service principal ID of the service principal in Databricks. required: - - service_principal + - display_name + - account_sp_status responses: '200': description: Success @@ -1134,7 +1365,7 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API - /api/2.0/identity/users/{internal_id}: + /api/2.0/identity/users/{user_id}: delete: operationId: workspace_iam_v2_delete_user_proxy summary: Deletes a user by its internal ID from the Databricks account that parents the calling workspace. @@ -1144,10 +1375,10 @@ paths: description: |- Deletes a user by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param user_id: str Required. Internal ID of the user in Databricks. parameters: - - name: internal_id + - name: user_id in: path required: true schema: @@ -1177,12 +1408,12 @@ paths: description: |- Fetches a user by its internal ID from the Databricks account that parents the calling workspace. - :param internal_id: str + :param user_id: str Required. Internal ID of the user in Databricks. :returns: :class:`User` parameters: - - name: internal_id + - name: user_id in: path required: true schema: @@ -1209,25 +1440,28 @@ paths: x-stackql-sdk-source: WorkspaceIamV2API patch: operationId: workspace_iam_v2_update_user_proxy - summary: Updates an existing user in the Databricks account that parents the calling workspace. Only the fields + summary: Updates an existing user in the Databricks account that parents the calling workspace and returns the tags: - iamv2 - workspace_iam_v2 description: |- - Updates an existing user in the Databricks account that parents the calling workspace. Only the fields - named in the update mask are modified; the updatable fields are fullName.givenName, - fullName.familyName, status, and externalId. Returns the updated User resource. + Updates an existing user in the Databricks account that parents the calling workspace and returns the + updated user. Only the fields named in the update mask are modified. The updatable fields are + fullName.givenName, fullName.familyName, status, and externalId. - :param internal_id: str + When AIM is enabled and the user is an external identity (its external_id is set), only external_id + can be updated; its other fields are sourced from your identity provider. + + :param user_id: str Required. Internal ID of the user in Databricks. :param user: :class:`User` - Required. User to be updated in + Required. User to be updated in Databricks :param update_mask: str - Optional. The list of fields to update. + Required. The list of fields to update. :returns: :class:`User` parameters: - - name: internal_id + - name: user_id in: path required: true schema: @@ -1238,44 +1472,42 @@ paths: required: true schema: type: string - description: Optional. The list of fields to update. + description: Required. The list of fields to update. requestBody: content: application/json: schema: type: object properties: - user: + username: + type: string + description: Username/email of the user. + full_name: type: object properties: - account_id: - type: string - description: The accountId parent of the user in Databricks. - account_user_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of a user in a Databricks account. - external_id: - type: string - description: ExternalId of the user in the customer's IdP. - full_name: - type: object - properties: - family_name: - type: string - given_name: - type: string - internal_id: + family_name: type: string - description: Internal userId of the user in Databricks. - username: + given_name: type: string - description: Username/email of the user. - description: Required. User to be updated in + account_user_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. + external_id: + type: string + description: ExternalId of the user in the customer's IdP. + user_id: + type: string + description: Internal userId of the user in Databricks. required: - - user + - username + - full_name + - account_user_status responses: '200': description: Success @@ -1298,15 +1530,15 @@ paths: /api/2.0/identity/workspace-assignment-details/{principal_id}: delete: operationId: workspace_iam_v2_delete_workspace_assignment_detail_proxy - summary: Deletes a workspace assignment detail for a principal (workspace-level proxy), revoking all associated + summary: Deletes a workspace assignment detail for a principal in the calling workspace, revoking all of its tags: - iamv2 - workspace_iam_v2 description: |- - Deletes a workspace assignment detail for a principal (workspace-level proxy), revoking all associated - entitlements. Entitlement revocations are applied individually and non-atomically — if a failure - occurs partway through, the principal remains assigned with a subset of its original entitlements, and - the operation is safe to retry. + Deletes a workspace assignment detail for a principal in the calling workspace, revoking all of its + entitlements. Entitlements are revoked one at a time rather than atomically. If the request fails + partway through, the principal stays assigned with some of its original entitlements. Retrying is + safe. :param principal_id: int Required. ID of the principal in Databricks to delete workspace assignment for. @@ -1334,12 +1566,12 @@ paths: x-stackql-sdk-source: WorkspaceIamV2API get: operationId: workspace_iam_v2_get_workspace_assignment_detail_proxy - summary: Returns the assignment details for a principal in a workspace (workspace-level proxy). + summary: Returns the assignment details for a principal in the calling workspace. tags: - iamv2 - workspace_iam_v2 description: |- - Returns the assignment details for a principal in a workspace (workspace-level proxy). + Returns the assignment details for a principal in the calling workspace. :param principal_id: int Required. The internal ID of the principal (user/sp/group) for which the assignment details are @@ -1375,20 +1607,19 @@ paths: x-stackql-sdk-source: WorkspaceIamV2API patch: operationId: workspace_iam_v2_update_workspace_assignment_detail_proxy - summary: Updates the entitlements of a directly assigned principal in a workspace (workspace-level proxy). + summary: Updates the entitlements of a directly assigned principal in the calling workspace. Changes are tags: - iamv2 - workspace_iam_v2 description: |- - Updates the entitlements of a directly assigned principal in a workspace (workspace-level proxy). - Entitlement changes are applied individually and non-atomically — if a failure occurs partway - through, only a subset of the requested changes may have been applied. Use - GetWorkspaceAssignmentDetail to confirm the final state. + Updates the entitlements of a directly assigned principal in the calling workspace. Changes are + applied one at a time rather than atomically. If the request fails partway through, only some of the + requested changes take effect. Get the assignment detail afterwards to confirm the final state. :param principal_id: int Required. ID of the principal in Databricks. :param workspace_assignment_detail: :class:`WorkspaceAssignmentDetail` - Required. Workspace assignment detail to be updated in . + Required. Workspace assignment detail to be updated in Databricks. :param update_mask: FieldMask Required. The list of fields to update. @@ -1412,139 +1643,474 @@ paths: schema: type: object properties: - workspace_assignment_detail: - type: object - properties: - principal_id: - type: integer - description: The internal ID of the principal (user/sp/group) in Databricks. - account_id: - type: string - description: The account ID parent of the workspace where the principal is assigned - effective_entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: |- - Create a collection of name/value pairs. + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: The account ID parent of the workspace where the principal is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: 'The principal''s full effective entitlements granted in this workspace: every entitlement - it holds whether granted directly or via group membership. Populated on Get; empty on List.' - entitlements: - type: array - items: - type: string - x-enum: - - ALLOW_CLUSTER_CREATE - - ALLOW_INSTANCE_POOL_CREATE - - DATABRICKS_SQL_ACCESS - - WORKSPACE_ACCESS - - WORKSPACE_ADMIN - - WORKSPACE_CONSUME - description: |- - Create a collection of name/value pairs. + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Every entitlement the principal holds in this workspace, whether granted directly or through + group membership. Get responses populate this field. List responses leave it empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many members they have: + Enumerations can be iterated over, and know how many members they have: - >>> len(Color) - 3 + >>> len(Color) + 3 - >>> list(Color) - [, , ] + >>> list(Color) + [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - description: 'Entitlements granted directly to the principal on this workspace. The only client-settable - field: create and update manage exactly this set (including entitlements the principal also holds - via a group). Not populated by ListWorkspaceAssignmentDetails (omitted for scalability); call GetWorkspaceAssignmentDetail - to read the entitlements for a single principal.' - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/sp/group). - workspace_id: - type: integer - description: The workspace ID where the principal is assigned - required: - - principal_id - description: Required. Workspace assignment detail to be updated in . + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through + a group. List responses leave this field empty. Get a single principal to read its entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/sp/group). + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. + required: + - principal_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/WorkspaceAssignmentDetail' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + /api/2.0/identity/workspace-assignments/{principal_id}: + delete: + operationId: workspace_iam_v2_delete_workspace_assignment_proxy + summary: Deletes a workspace assignment for a principal in the calling workspace, revoking all of its + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Deletes a workspace assignment for a principal in the calling workspace, revoking all of its + entitlements. Entitlements are revoked one at a time rather than atomically. If the request fails + partway through, the principal stays assigned with some of its original entitlements. Retrying is + safe. + + :param principal_id: int + Required. ID of the principal in Databricks to delete workspace assignment for. + parameters: + - name: principal_id + in: path + required: true + schema: + type: integer + description: Required. ID of the principal in Databricks to delete workspace assignment for. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + get: + operationId: workspace_iam_v2_get_workspace_assignment_proxy + summary: Returns the assignment for a principal in the calling workspace. + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Returns the assignment for a principal in the calling workspace. + + :param principal_id: int + Required. The internal ID of the principal (user/sp/group) for which the assignment is being + requested. + + :returns: :class:`WorkspaceAssignment` + parameters: + - name: principal_id + in: path + required: true + schema: + type: integer + description: Required. The internal ID of the principal (user/sp/group) for which the assignment is being requested. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/WorkspaceAssignment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + patch: + operationId: workspace_iam_v2_update_workspace_assignment_proxy + summary: Updates the entitlements of a directly assigned principal in the calling workspace. Changes are + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Updates the entitlements of a directly assigned principal in the calling workspace. Changes are + applied one at a time rather than atomically. If the request fails partway through, only some of the + requested changes take effect. Get the assignment afterwards to confirm the final state. + + :param principal_id: int + Required. ID of the principal in Databricks. + :param workspace_assignment: :class:`WorkspaceAssignment` + Required. Workspace assignment to be updated in Databricks. + :param update_mask: FieldMask + Required. The list of fields to update. + + :returns: :class:`WorkspaceAssignment` + parameters: + - name: principal_id + in: path + required: true + schema: + type: integer + description: Required. ID of the principal in Databricks. + - name: update_mask + in: query + required: true + schema: + type: object + description: Required. The list of fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: The account ID parent of the workspace where the principal is assigned + effective_entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Every entitlement the principal holds in this workspace, whether granted directly or through + group membership. Get responses populate this field. List responses leave it empty. + entitlements: + type: array + items: + type: string + x-enum: + - ALLOW_CLUSTER_CREATE + - ALLOW_INSTANCE_POOL_CREATE + - DATABRICKS_SQL_ACCESS + - WORKSPACE_ACCESS + - WORKSPACE_ADMIN + - WORKSPACE_CONSUME + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through + a group. List responses leave this field empty. Get a single principal to read its entitlements. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/service principal/group) that is assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. required: - - workspace_assignment_detail + - principal_id + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/WorkspaceAssignment' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + /api/2.0/identity/external-groups/{external_group_id}: + get: + operationId: workspace_iam_v2_get_external_group_proxy + summary: Retrieves an external group with the given external ID from the customer's IdP. If the group does not + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Retrieves an external group with the given external ID from the customer's IdP. If the group does not + exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity + Management (AIM), this will return an error. Workspace-scoped variant for workspace-authenticated + callers. + + :param name: str + Required. The resource name of the external group. Format: external-groups/{external_group_id} + + :returns: :class:`ExternalGroup` + parameters: + - name: external_group_id + in: path + required: true + schema: + type: string + description: 'The `external_group_id` segment of the `name` resource name (`external-groups/{external_group_id}`). + Required. The resource name of the external group. Format: external-groups/{external_group_id}' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalGroup' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: WorkspaceIamV2API + /api/2.0/identity/external-service-principals/{external_service_principal_id}: + get: + operationId: workspace_iam_v2_get_external_service_principal_proxy + summary: Retrieves an external service principal with the given external ID from the customer's IdP. If the + tags: + - iamv2 + - workspace_iam_v2 + description: |- + Retrieves an external service principal with the given external ID from the customer's IdP. If the + service principal does not exist, it will be created. If the customer is not onboarded onto Automatic + Identity Management (AIM), this will return an error. Workspace-scoped variant for + workspace-authenticated callers. + + :param name: str + Required. The resource name of the external service principal. Format: + external-service-principals/{external_service_principal_id} + + :returns: :class:`ExternalServicePrincipal` + parameters: + - name: external_service_principal_id + in: path + required: true + schema: + type: string + description: 'The `external_service_principal_id` segment of the `name` resource name (`external-service-principals/{external_service_principal_id}`). + Required. The resource name of the external service principal. Format: external-service-principals/{external_service_principal_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/WorkspaceAssignmentDetail' + $ref: '#/components/schemas/ExternalServicePrincipal' default: description: Error response content: @@ -1557,7 +2123,7 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API - /api/2.0/identity/{name}: + /api/2.0/identity/external-users/{external_user_id}: get: operationId: workspace_iam_v2_get_external_user_proxy summary: Retrieves an external user with the given external ID from the customer's IdP. If the user does not @@ -1574,12 +2140,13 @@ paths: :returns: :class:`ExternalUser` parameters: - - name: name + - name: external_user_id in: path required: true schema: type: string - description: 'Required. The resource name of the external user. Format: external-users/{external_user_id}' + description: 'The `external_user_id` segment of the `name` resource name (`external-users/{external_user_id}`). Required. + The resource name of the external user. Format: external-users/{external_user_id}' responses: '200': description: Success @@ -1706,7 +2273,7 @@ paths: :param principal_id: int Required. ID of the principal in Databricks. :param workspace_identity_detail: :class:`WorkspaceIdentityDetail` - Required. Workspace identity detail to be updated in . + Required. Workspace identity detail to be updated in Databricks. :param update_mask: FieldMask Required. The list of fields to update. @@ -1730,34 +2297,28 @@ paths: schema: type: object properties: - workspace_identity_detail: - type: object - properties: - assignment_type: - type: string - x-enum: - - DIRECT - - INDIRECT - description: The type of assignment the principal has to the workspace (direct or indirect). - principal_id: - type: integer - description: The internal ID of the principal (user/sp/group) in Databricks. - principal_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the principal (user/service principal/group). - workspace_identity_status: - type: string - x-enum: - - ACTIVE - - INACTIVE - description: The activity status of an identity in a Databricks workspace. - description: Required. Workspace identity detail to be updated in . - required: - - workspace_identity_detail + assignment_type: + type: string + x-enum: + - DIRECT + - INDIRECT + description: The type of assignment the principal has to the workspace (direct or indirect). + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + principal_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the principal (user/service principal/group). + workspace_identity_status: + type: string + x-enum: + - ACTIVE + - INACTIVE + description: The activity status of an identity in a Databricks workspace. responses: '200': description: Success @@ -1792,7 +2353,8 @@ paths: listed. :param page_size: int (optional) The maximum number of parent groups to return. The service may return fewer than this value. If not - provided, defaults to 1000 (also the maximum allowed). + provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum + are clamped to 1000. :param page_token: str (optional) A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page. @@ -1811,7 +2373,7 @@ paths: schema: type: integer description: The maximum number of parent groups to return. The service may return fewer than this value. If not provided, - defaults to 1000 (also the maximum allowed). + defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000. - name: page_token in: query required: false @@ -1838,61 +2400,6 @@ paths: message: type: string x-stackql-sdk-source: WorkspaceIamV2API - /api/2.0/identity/workspace-access-details: - get: - operationId: workspace_iam_v2_list_workspace_access_details_local - summary: Lists the access details of every provisioned principal (user, service principal, or group) with - tags: - - iamv2 - - workspace_iam_v2 - description: |- - Lists the access details of every provisioned principal (user, service principal, or group) with - access to the current workspace, returning one page per call. - - - Provisioned principal here refers to one that has been synced into Databricks from the customer's - IdP or added explicitly to Databricks via SCIM/UI. - - :param page_size: int (optional) - The maximum number of workspace access details to return. The service may return fewer than this - value. - :param page_token: str (optional) - A page token, received from a previous ListWorkspaceAccessDetails call. Provide this to retrieve the - subsequent page. - - :returns: :class:`ListWorkspaceAccessDetailsResponse` - parameters: - - name: page_size - in: query - required: false - schema: - type: integer - description: The maximum number of workspace access details to return. The service may return fewer than this value. - - name: page_token - in: query - required: false - schema: - type: string - description: A page token, received from a previous ListWorkspaceAccessDetails call. Provide this to retrieve the - subsequent page. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListWorkspaceAccessDetailsResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: WorkspaceIamV2API /api/2.0/identity/groups/resolve-by-external-id: post: operationId: workspace_iam_v2_resolve_group_proxy @@ -1942,14 +2449,14 @@ paths: /api/2.0/identity/service-principals/resolve-by-external-id: post: operationId: workspace_iam_v2_resolve_service_principal_proxy - summary: Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will + summary: Resolves a service principal with the given external ID from the customer's IdP. If the service tags: - iamv2 - workspace_iam_v2 description: |- - Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will - be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will - return an error. + Resolves a service principal with the given external ID from the customer's IdP. If the service + principal does not exist, it will be created. If the customer is not onboarded onto Automatic Identity + Management (AIM), this will return an error. :param external_id: str Required. The external ID of the service principal in the customer's IdP. @@ -2033,45 +2540,6 @@ paths: x-stackql-sdk-source: WorkspaceIamV2API components: schemas: - AccountAccessIdentityRule: - type: object - properties: - action: - $ref: '#/components/schemas/AccountAccessRuleAction' - description: Currently, only DENY action is supported. - display_name: - type: string - description: Display name of the principal. - external_principal_id: - type: string - description: External ID of the principal in the customer's IdP. - name: - type: string - description: 'Fully qualified name for the rule. Format: accounts/{account_id}/account-access-identity-rules/{external_principal_id}' - principal_type: - $ref: '#/components/schemas/PrincipalType' - description: The type of the principal (user/service principal/group). This field is populated by the server based - on the external_principal_id. - required: - - action - description: An identity rule that controls which principals can access an account. - AttributeControlEntry: - type: object - properties: - is_allowed: - type: boolean - description: Whether the attribute is permitted. Always true in the Identity Attributes PrPr. - name: - type: string - description: 'The resource name of the entry. Format: accounts/{account_id}/attribute-control-entries/{attribute_name} - where {attribute_name} is the IdP attribute being governed (e.g. "department").' - description: |- - A single entry in an account's identity attribute control list. The presence of an entry means - the governed attribute (the last segment of ``name``) is controlled across all write sources - (SCIM, Identity APIs, AIM); is_allowed records whether the attribute is permitted (always true - in the Identity Attributes PrPr). For the Identity Attributes PrPr the control list is an - explicit allowlist: an attribute that is NOT present in the control list is treated as not - allowed. This may change post-PrPr. DirectGroupMember: type: object properties: @@ -2083,7 +2551,10 @@ components: description: Display name of the principal. external_id: type: string - description: The external ID of the principal in Databricks. + description: The external ID of the principal in the customer's IdP. + group_id: + type: integer + description: The internal ID of the group this member belongs to. membership_source: $ref: '#/components/schemas/GroupMembershipSource' description: The source of group membership (internal or from identity provider). @@ -2093,6 +2564,16 @@ components: required: - principal_id description: Represents a principal that is a direct member of a group, with its source of membership. + ExactMatchRule: + type: object + properties: + external_id: + type: string + description: The identity provider's external ID for the group to match. This is not the Databricks group ID. The + value must be non-empty and is matched exactly, including case. + required: + - external_id + description: An exact-match rule that matches a group's external ID from the identity provider. ExternalGroup: type: object properties: @@ -2110,7 +2591,8 @@ components: description: Internal groupId of the group in Databricks. name: type: string - description: 'The resource name of the external group. Format: accounts/{account_id}/external-groups/{external_group_id}' + description: 'The resource name of the external group. The format depends on the API that returned it: - Account-scoped: + accounts/{account_id}/external-groups/{external_group_id} - Workspace-scoped: external-groups/{external_group_id}' description: |- An external group from the customer's Identity Provider, resolved into Databricks. This is a read-only resource keyed by the IdP external ID. The Get method may trigger an idempotent sync @@ -2138,7 +2620,9 @@ components: description: Internal servicePrincipalId of the service principal in Databricks. name: type: string - description: 'The resource name of the external service principal. Format: accounts/{account_id}/external-service-principals/{external_service_principal_id}' + description: 'The resource name of the external service principal. The format depends on the API that returned it: + - Account-scoped: accounts/{account_id}/external-service-principals/{external_service_principal_id} - Workspace-scoped: + external-service-principals/{external_service_principal_id}' description: |- An external service principal from the customer's Identity Provider, resolved into Databricks. This is a read-only resource keyed by the IdP external ID. The Get method may trigger an @@ -2167,7 +2651,8 @@ components: description: Internal userId of the user in Databricks. name: type: string - description: 'The resource name of the external user. Format: accounts/{account_id}/external-users/{external_user_id}' + description: 'The resource name of the external user. The format depends on the API that returned it: - Account-scoped: + accounts/{account_id}/external-users/{external_user_id} - Workspace-scoped: external-users/{external_user_id}' username: type: string description: Username/email of the user, from Databricks. @@ -2196,36 +2681,46 @@ components: external_id: type: string description: ExternalId of the group in the customer's IdP. + group_id: + type: string + description: Internal group ID of the group in Databricks. group_name: type: string description: Display name of the group. - internal_id: - type: string - description: Internal group ID of the group in Databricks. description: The details of a Group resource. - ListAccountAccessIdentityRulesResponse: - type: object - properties: - account_access_identity_rules: - type: array - items: - $ref: '#/components/schemas/AccountAccessIdentityRule' - next_page_token: - type: string - description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there - are no subsequent pages. - description: Response message for listing account access identity rules. - ListAttributeControlEntriesResponse: + IdentityVisibilityFilter: type: object properties: - attribute_control_entries: - type: array - items: - $ref: '#/components/schemas/AttributeControlEntry' - next_page_token: + principal_type: + $ref: '#/components/schemas/PrincipalType' + description: The type of principal this rule applies to. Set to ``GROUP`` when creating a filter. Other principal + types are not supported for creation. + exact: + $ref: '#/components/schemas/ExactMatchRule' + description: Exact match on the group's external ID from the identity provider. + name: type: string - description: A token to retrieve the next page; empty when there are no more results. - description: Response message for listing identity attribute control-list entries. + description: 'The resource name of the identity-visibility filter. Format: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}' + prefix: + $ref: '#/components/schemas/PrefixMatchRule' + description: Case-sensitive starts-with match on the group's display name. + regex: + $ref: '#/components/schemas/RegexMatchRule' + description: Full, case-sensitive RE2 match on the identity's display name. + required: + - principal_type + description: |- + An account-level rule that controls which identity provider groups are discoverable in directory + search and group pickers when automatic identity management is enabled. Filters apply across all + workspaces in the account. + + If no group filters are configured, all groups are visible. Otherwise, a group is visible if it + or any of its transitive parent groups matches at least one rule. A group is also visible if it + or any transitive parent group is already provisioned in the account. Local Databricks groups + remain visible regardless of the filters. + + Only group filters can be created. Filters do not change provisioning or sign-in for users and + service principals. Filters are immutable: to change a rule, delete it and create a new one. ListDirectGroupMembersResponse: type: object properties: @@ -2251,6 +2746,19 @@ components: description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. description: Response message containing a page of groups in the account. + ListIdentityVisibilityFiltersResponse: + type: object + properties: + identity_visibility_filters: + type: array + items: + $ref: '#/components/schemas/IdentityVisibilityFilter' + description: The filters in this page. These are filter rules, not the groups matched by the rules. + next_page_token: + type: string + description: A token, which can be sent as page_token to retrieve the next page. If omitted, there are no subsequent + pages. + description: Response message containing a page of identity-visibility filters in the account. ListServicePrincipalsResponse: type: object properties: @@ -2285,30 +2793,53 @@ components: type: array items: $ref: '#/components/schemas/User' - ListWorkspaceAccessDetailsResponse: + ListWorkspaceAssignmentDetailsResponse: type: object properties: next_page_token: type: string description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - workspace_access_details: + workspace_assignment_details: type: array items: - $ref: '#/components/schemas/WorkspaceAccessDetail' - description: Response message containing a page of workspace access details. - ListWorkspaceAssignmentDetailsResponse: + $ref: '#/components/schemas/WorkspaceAssignmentDetail' + description: Response message for listing workspace assignment details. + ListWorkspaceAssignmentsResponse: type: object properties: next_page_token: type: string description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - workspace_assignment_details: + workspace_assignments: type: array items: - $ref: '#/components/schemas/WorkspaceAssignmentDetail' - description: Response message for listing workspace assignment details. + $ref: '#/components/schemas/WorkspaceAssignment' + description: Response message for listing workspace assignments. + PrefixMatchRule: + type: object + properties: + display_name_prefix: + type: string + description: The display-name prefix to match. Must contain at least one non-whitespace character. Leading and trailing + whitespace are preserved, and matching is case-sensitive. + required: + - display_name_prefix + description: |- + A starts-with rule that matches groups whose display name begins with a specified prefix. + Matching is case-sensitive. For example, the prefix ``data-`` matches ``data-platform``. + RegexMatchRule: + type: object + properties: + display_name_regex: + type: string + description: The RE2 regular expression matched against the complete display name. + required: + - display_name_regex + description: |- + A rule that matches an identity whose complete display name matches an RE2 regular expression. + Matching is case-sensitive. Use .* explicitly when substring matching is desired. ResolveGroupResponse: type: object properties: @@ -2327,24 +2858,28 @@ components: ServicePrincipal: type: object properties: - account_id: + display_name: type: string - description: The parent account ID for the service principal in Databricks. + description: Display name of the service principal. account_sp_status: $ref: '#/components/schemas/State' description: The activity status of a service principal in a Databricks account. - application_id: + account_id: type: string - description: Application ID of the service principal. - display_name: + description: The parent account ID for the service principal in Databricks. + application_id: type: string - description: Display name of the service principal. + description: Application ID of the service principal. Set at creation time and cannot be changed afterwards; when + omitted, the server generates one. external_id: type: string description: ExternalId of the service principal in the customer's IdP. - internal_id: + service_principal_id: type: string description: Internal service principal ID of the service principal in Databricks. + required: + - display_name + - account_sp_status description: The details of a ServicePrincipal resource. TransitiveParentGroup: type: object @@ -2355,30 +2890,34 @@ components: external_id: type: string description: ExternalId of the group in the customer's IdP. - internal_id: + group_id: type: string description: Internal group ID of the group in Databricks. description: Represents a group that is a transitive parent of a principal. User: type: object properties: - account_id: + username: type: string - description: The accountId parent of the user in Databricks. + description: Username/email of the user. + full_name: + $ref: '#/components/schemas/UserFullName' account_user_status: $ref: '#/components/schemas/State' description: The activity status of a user in a Databricks account. + account_id: + type: string + description: The accountId parent of the user in Databricks. external_id: type: string description: ExternalId of the user in the customer's IdP. - full_name: - $ref: '#/components/schemas/UserFullName' - internal_id: + user_id: type: string description: Internal userId of the user in Databricks. - username: - type: string - description: Username/email of the user. + required: + - username + - full_name + - account_user_status description: The details of a User resource. UserFullName: type: object @@ -2412,6 +2951,56 @@ components: type: integer description: The workspace ID where the principal has access. description: The details of a principal's access to a workspace. + WorkspaceAssignment: + type: object + properties: + principal_id: + type: integer + description: The internal ID of the principal (user/sp/group) in Databricks. + account_id: + type: string + description: The account ID parent of the workspace where the principal is assigned + effective_entitlements: + type: array + items: + $ref: '#/components/schemas/Entitlement' + description: Every entitlement the principal holds in this workspace, whether granted directly or through group + membership. Get responses populate this field. List responses leave it empty. + entitlements: + type: array + items: + $ref: '#/components/schemas/Entitlement' + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through a group. + List responses leave this field empty. Get a single principal to read its entitlements. + principal_type: + $ref: '#/components/schemas/PrincipalType' + description: The type of the principal (user/service principal/group) that is assigned. + workspace_id: + type: integer + description: The workspace ID where the principal is assigned. + required: + - principal_id + description: |- + The direct assignment of a provisioned account-level principal (user, service principal, or + group) to a workspace, together with the entitlements that assignment grants in the workspace. + + This resource covers only principals assigned directly to the workspace. Principals that inherit + workspace access through a group are not represented here. See WorkspaceAccessDetail and + WorkspaceIdentityDetail for the effective, direct-or-indirect view. Creating the resource + assigns the principal to the workspace, and deleting it removes the assignment. + + ``entitlements`` is the only client-settable field. It holds the entitlements granted directly + on this assignment, including any the principal also holds through a group. + ``effective_entitlements`` is the read-only union of those and any granted through group + membership. + + A direct assignment always carries at least one directly-assigned entitlement, because the + assignment is what grants it. Create and update both reject an empty ``entitlements`` set. To + remove a principal's assignment entirely, delete the resource. + + This resource replaces workspace assignment previously managed through the workspace SCIM and + permission-assignment APIs, and is intended for account and workspace admins. WorkspaceAssignmentDetail: type: object properties: @@ -2425,39 +3014,39 @@ components: type: array items: $ref: '#/components/schemas/Entitlement' - description: 'The principal''s full effective entitlements granted in this workspace: every entitlement it holds - whether granted directly or via group membership. Populated on Get; empty on List.' + description: Every entitlement the principal holds in this workspace, whether granted directly or through group + membership. Get responses populate this field. List responses leave it empty. entitlements: type: array items: $ref: '#/components/schemas/Entitlement' - description: 'Entitlements granted directly to the principal on this workspace. The only client-settable field: - create and update manage exactly this set (including entitlements the principal also holds via a group). Not populated - by ListWorkspaceAssignmentDetails (omitted for scalability); call GetWorkspaceAssignmentDetail to read the entitlements - for a single principal.' + description: Entitlements granted directly to the principal on this workspace. This is the only client-settable + field. Create and update manage exactly this set, including entitlements the principal also holds through a group. + List responses leave this field empty. Get a single principal to read its entitlements. principal_type: $ref: '#/components/schemas/PrincipalType' workspace_id: type: integer - description: The workspace ID where the principal is assigned + description: The workspace ID where the principal is assigned. required: - principal_id description: |- The direct assignment of a provisioned account-level principal (user, service principal, or group) to a workspace, together with the entitlements that assignment grants in the workspace. - A WorkspaceAssignmentDetail exists only for principals that are directly assigned to the - workspace; principals that merely inherit workspace access through a group are not represented - here (see WorkspaceAccessDetail / WorkspaceIdentityDetail for the effective, direct-or-indirect - view). Creating the resource assigns the principal to the workspace; deleting it removes the - assignment. The ``entitlements`` field is the only client-settable field and defines the - entitlements granted directly on this assignment; ``effective_entitlements`` is the read-only - union of those plus any granted via group membership. + This resource covers only principals assigned directly to the workspace. Principals that inherit + workspace access through a group are not represented here. See WorkspaceAccessDetail and + WorkspaceIdentityDetail for the effective, direct-or-indirect view. Creating the resource + assigns the principal to the workspace, and deleting it removes the assignment. - A direct assignment always carries at least one directly-assigned entitlement: the assignment is - what grants the entitlement, so a WorkspaceAssignmentDetail with an empty ``entitlements`` set - is not a valid state. Both create and update require a non-empty ``entitlements`` set (an empty - set is rejected); to remove a principal's assignment entirely, delete the resource. + ``entitlements`` is the only client-settable field. It holds the entitlements granted directly + on this assignment, including any the principal also holds through a group. + ``effective_entitlements`` is the read-only union of those and any granted through group + membership. + + A direct assignment always carries at least one directly-assigned entitlement, because the + assignment is what grants it. Create and update both reject an empty ``entitlements`` set. To + remove a principal's assignment entirely, delete the resource. This resource replaces workspace assignment previously managed through the workspace SCIM and permission-assignment APIs, and is intended for account and workspace admins. @@ -2477,11 +3066,6 @@ components: $ref: '#/components/schemas/State' description: The activity status of an identity in a Databricks workspace. description: The details of a directly or indirectly assigned principal's details in a workspace. - AccountAccessRuleAction: - type: string - x-enum: - - DENY - description: The action type for an account access identity rule (currently DENY only). Entitlement: type: string x-enum: @@ -2638,13 +3222,13 @@ components: objectKey: $.groups delete: operation: - $ref: '#/paths/~1api~12.0~1identity~1groups~1{internal_id}/delete' + $ref: '#/paths/~1api~12.0~1identity~1groups~1{group_id}/delete' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1identity~1groups~1{internal_id}/get' + $ref: '#/paths/~1api~12.0~1identity~1groups~1{group_id}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -2653,7 +3237,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1identity~1groups~1{internal_id}/patch' + $ref: '#/paths/~1api~12.0~1identity~1groups~1{group_id}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -2700,13 +3284,13 @@ components: objectKey: $.service_principals delete: operation: - $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{internal_id}/delete' + $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{service_principal_id}/delete' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{internal_id}/get' + $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{service_principal_id}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -2715,7 +3299,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{internal_id}/patch' + $ref: '#/paths/~1api~12.0~1identity~1service-principals~1{service_principal_id}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -2762,13 +3346,13 @@ components: objectKey: $.users delete: operation: - $ref: '#/paths/~1api~12.0~1identity~1users~1{internal_id}/delete' + $ref: '#/paths/~1api~12.0~1identity~1users~1{user_id}/delete' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1identity~1users~1{internal_id}/get' + $ref: '#/paths/~1api~12.0~1identity~1users~1{user_id}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -2777,7 +3361,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1identity~1users~1{internal_id}/patch' + $ref: '#/paths/~1api~12.0~1identity~1users~1{user_id}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -2854,6 +3438,95 @@ components: delete: - $ref: '#/components/x-stackQL-resources/workspace_assignment_details/methods/delete' replace: [] + workspace_assignments: + id: databricks_workspace.iamv2.workspace_assignments + name: workspace_assignments + title: Workspace Assignments + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1identity~1workspace-assignments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1identity~1workspace-assignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workspace_assignments + delete: + operation: + $ref: '#/paths/~1api~12.0~1identity~1workspace-assignments~1{principal_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1identity~1workspace-assignments~1{principal_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1identity~1workspace-assignments~1{principal_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/get' + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/workspace_assignments/methods/delete' + replace: [] + external_groups: + id: databricks_workspace.iamv2.external_groups + name: external_groups + title: External Groups + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1identity~1external-groups~1{external_group_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_groups/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + external_service_principals: + id: databricks_workspace.iamv2.external_service_principals + name: external_service_principals + title: External Service Principals + methods: + get: + operation: + $ref: '#/paths/~1api~12.0~1identity~1external-service-principals~1{external_service_principal_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_service_principals/methods/get' + insert: [] + update: [] + delete: [] + replace: [] external_users: id: databricks_workspace.iamv2.external_users name: external_users @@ -2861,7 +3534,7 @@ components: methods: get: operation: - $ref: '#/paths/~1api~12.0~1identity~1{name}/get' + $ref: '#/paths/~1api~12.0~1identity~1external-users~1{external_user_id}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -2883,17 +3556,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1api~12.0~1identity~1workspace-access-details/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.workspace_access_details sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/workspace_access_details/methods/get' - - $ref: '#/components/x-stackQL-resources/workspace_access_details/methods/list' insert: [] update: [] delete: [] @@ -2997,8 +3662,6 @@ components: p.value AS permission FROM databricks_workspace.iamv2.workspace_access_details wa, JSON_EACH(wa.permissions) p - WHERE wa.deployment_name = '{{ deployment_name }}' - AND wa.principal_id = '{{ principal_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -3013,8 +3676,6 @@ components: p.value AS permission FROM databricks_workspace.iamv2.workspace_access_details wa, jsonb_array_elements(wa.permissions::jsonb) AS p - WHERE wa.deployment_name = '{{ deployment_name }}' - AND wa.principal_id = '{{ principal_id }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml b/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml index 38ebc047..91a7c9fc 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.jobs servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.2/jobs/runs/cancel-all: post: @@ -136,10 +153,18 @@ paths: :param continuous: :class:`Continuous` (optional) An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of ``schedule`` and ``continuous`` can be used. + + Pipelines started by a continuous job also run continuously, regardless of their own pipeline mode + setting. :param deployment: :class:`JobDeployment` (optional) Deployment information for jobs managed by external sources. :param description: str (optional) An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding. + :param duration_target: str (optional) + The window the run aims to finish within, in hours, for a Cost-optimized serverless run. Required + only when ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the supported values: + ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional cost-saving optimizations. :param edit_mode: :class:`JobEditMode` (optional) Edit mode of the job. @@ -151,15 +176,18 @@ paths: :param environment_variables: List[:class:`JobEnvironmentVariables`] (optional) Named environment-variable entries that tasks can reference by key from - ``TaskSettings.environment_variables_key``. Each entry holds inline ``variables`` plus optional - ``.env`` ``files``. Maximum 10 entries per job. Entries are independent of one another — there is - no cross-entry merging. + ``TaskSettings.environment_variables_key``. Each entry's ``spec`` holds inline ``variables`` and + optional ``.env`` ``files``. Maximum 10 entries per job. A task can reference at most one entry from + this list. :param environments: List[:class:`JobEnvironment`] (optional) - A list of task execution environment specifications that can be referenced by serverless tasks of - this job. For serverless notebook tasks, if the environment_key is not specified, the notebook - environment will be used if present. If a jobs environment is specified, it will override the - notebook environment. For other serverless tasks, the task environment is required to be specified - using environment_key in the task settings. + A list of task execution environment specifications that can be referenced by tasks that use + serverless compute or a compute resource that uses Environments mode. + + For notebook tasks that use serverless compute or a compute resource that uses Environments mode, if + the environment_key is not specified, the notebook environment will be used if present. If a jobs + environment is specified, it will override the notebook environment. For other tasks that use + serverless compute or a compute resource that uses Environments mode, the task environment is + required to be specified using environment_key in the task settings. :param format: :class:`Format` (optional) Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls. When using the Jobs API 2.1 this value is always set to ``"MULTI_TASK"``. @@ -202,9 +230,11 @@ paths: cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. + - ``STANDARD``: Enables cost-efficient execution of serverless workloads. + - ``COST_OPTIMIZED``: Enables lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. :param queue: :class:`QueueSettings` (optional) The queue settings of the job. :param run_as: :class:`JobRunAs` (optional) @@ -230,6 +260,10 @@ paths: A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to ``runNow``. + :param triggers: List[:class:`TriggerConfiguration`] (optional) + List of triggers attached to this job. A run starts when any active trigger evaluates to true. + Cannot be set in the same request as the legacy ``schedule``, ``trigger``, or ``continuous`` fields. + Gated behind the "Multiple Triggers" feature preview. :param usage_policy_id: str (optional) The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See ``effective_usage_policy_id`` for the @@ -337,6 +371,8 @@ paths: An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of ``schedule`` and ``continuous`` can be used. + Pipelines started by a continuous job also run continuously, + regardless of their own pipeline mode setting. deployment: type: object properties: @@ -375,6 +411,16 @@ paths: description: >- An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of + the supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, + ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional + cost-saving optimizations. edit_mode: type: string x-enum: @@ -478,74 +524,60 @@ paths: Identifier for this entry. Must be unique within ``JobSettings.environment_variables``. Tasks reference it from ``TaskSettings.environment_variables_key``. - files: - type: array - items: - type: string - description: >- - Workspace (``/Workspace/...``) or UC Volumes - (``/Volumes/...``) paths to ``.env`` files. Maximum 5 - files. Files are read, parsed, and merged at task - execution time, not at job creation or update API call - time. File format: each line must be exactly - ``KEY=VALUE``. Keys must match the same regex as - inlined variable names (``^[A-Za-z_][A-Za-z0-9_]*$``); - the value continues to the end of the line. No other - syntax is supported — no comments, no quoted values, - no escape sequences, no variable interpolation. Any - line that does not match the ``KEY=VALUE`` shape fails - the run. Size limits: maximum 1,048,576 bytes (1 MiB) - per file on disk; maximum 131,072 bytes (128 KiB) per - ``KEY=VALUE`` line combined. Caps are enforced at read - time in jobs-runner — files exceeding the per-file - cap, or lines exceeding the per-line cap, fail the - run. On a duplicate key, the later file wins; - ``variables`` override values from any file. Values - may contain {{secrets/scope/key}} references; those - are resolved at task execution time and never - persisted in resolved form. Do not use these files to - store raw secret values; consult `secret management - `__ - for the right way to pass sensitive values. - variables: + spec: type: object - description: >- - Environment variables specified directly as key/value - pairs (as opposed to ``files``, which are read from - ``.env`` file paths). Maximum 100 entries. Each key - must match ``^[A-Za-z_][A-Za-z0-9_]*$`` and be 1 to - 256 characters long. Each value is up to 512 - characters; larger values should be moved into a - ``.env`` file referenced from ``files``. On a - duplicate key, ``variables`` override values from any - file in ``files``. Values may contain - {{secrets/scope/key}} references; those are resolved - at task execution time and never persisted in resolved - form. Do not use this field to store a raw secret - value; consult `secret management - `__ - for the right way to pass sensitive values. + properties: + files: + type: array + items: + type: string + description: >- + Workspace (``/Workspace/...``) or UC Volumes + (``/Volumes/...``) paths to ``.env`` files. + Maximum 5 files. Files are read, parsed, and + merged at task execution time, not at job creation + or update API call time. File format: each line + containing a variable must be exactly + ``KEY=VALUE``. Empty and whitespace-only lines, + and lines beginning with ``#``, are ignored. Keys + must match the same regex as inlined variable + names (``^[A-Za-z_][A-Za-z0-9_]*$``); the value + continues to the end of the line. No other syntax + is supported — no inline comments, no quoted + values, no escape sequences, no variable + interpolation. Any other line that does not match + the ``KEY=VALUE`` shape fails the run. Size + limits: maximum 32,768 bytes (32 KiB) per file on + disk; maximum 1,024 bytes (1 KiB) per + ``KEY=VALUE`` line combined. Files or lines + exceeding these limits fail the run. On a + duplicate key, the later file wins; ``variables`` + override values from any file. + variables: + type: object + description: >- + Environment variables specified directly as + key/value pairs. Maximum 20 entries. Each key must + be 1 to 256 characters and match + ``^[A-Za-z_][A-Za-z0-9_]*$``: it must start with + an ASCII letter or underscore and contain only + ASCII letters, digits, and underscores. Each value + can be any Unicode string of up to 512 characters, + including an empty string. + description: The environment variable specification. + required: + - environment_variables_key description: >- A named environment-variable entry, defined once at the job level and referenced by key from one or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via ``TaskSettings.environment_variables_key``. - - Precedence within a single entry (later overrides earlier on duplicate keys): - - files (merged in submitted order; later file in the list wins) └─▶ variables (inline k/v - override file contents) └─▶ runtime (os.environ / sys.env — overrides all, - classic-parity) - - Resolved values are never persisted: ``{{secrets/scope/key}}`` references in ``variables`` or in - ``files`` contents are stored verbatim and resolved at task execution time on the DP . description: >- Named environment-variable entries that tasks can reference by key from ``TaskSettings.environment_variables_key``. Each - entry holds inline ``variables`` plus optional ``.env`` - ``files``. Maximum 10 entries per job. Entries are - independent of one another — there is no cross-entry - merging. + entry's ``spec`` holds inline ``variables`` and optional + ``.env`` ``files``. Maximum 10 entries per job. A task can + reference at most one entry from this list. environments: type: array items: @@ -559,12 +591,15 @@ paths: - environment_key description: >- A list of task execution environment specifications that can - be referenced by serverless tasks of this job. For - serverless notebook tasks, if the environment_key is not + be referenced by tasks that use serverless compute or a + compute resource that uses Environments mode. For notebook + tasks that use serverless compute or a compute resource that + uses Environments mode, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the - notebook environment. For other serverless tasks, the task - environment is required to be specified using + notebook environment. For other tasks that use serverless + compute or a compute resource that uses Environments mode, + the task environment is required to be specified using environment_key in the task settings. format: type: string @@ -759,7 +794,6 @@ paths: this cluster. required: - job_cluster_key - - new_cluster description: >- A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in @@ -829,10 +863,13 @@ paths: determines the level of compute performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of serverless - workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast - startup and execution times through rapid scaling and - optimized cluster performance. + ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and + execution times through rapid scaling and optimized cluster + performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: + Enables lower job costs by optimizing compute for your + selected target duration time. Must provide a duration + target. queue: type: object properties: @@ -848,8 +885,10 @@ paths: type: string description: >- Group name of an account group assigned to the - workspace. Setting this field requires being a member of - the group. + workspace. When set, all tasks run as the group and the + group's permissions are used for data access. Setting + this field requires being a member of the group, or + having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -939,275 +978,6 @@ paths: properties: task_key: type: string - agentic_task: - type: object - properties: - context: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: >- - Optional. Conversation IDs to load as context - for the agent. - instructions: - type: array - items: - type: string - description: >- - Optional. Additional instructions to guide the - agent's behavior. - description: >- - Optional. Context input providing conversation - history and instructions. - genie_code_api: - type: object - properties: {} - description: >- - Inline Genie Code conversation driven by a single - prompt. Mutually exclusive with the supervisor - variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) instead. Kept - for backwards compatibility with existing callers; - will be removed in a future revision. - input: - type: string - description: >- - Optional. The user query / task input the agent - must accomplish. Mirrors the OpenAI Responses API - ``input`` field. Replaces the deprecated ``goal`` - field; new callers should populate ``input`` going - forward. - output_schema: - type: object - properties: - properties: - type: object - description: Map of property name to property definition. - description: >- - Optional. JSON-Schema-style declaration of the - structured output the agent should produce. - Replaces the deprecated ``task_output_schema`` - map; new callers should populate ``output_schema`` - going forward. - supervisor_agent: - type: object - properties: - agent_id: - type: string - description: >- - Required. The ID of the supervisor agent - (tile_id). - description: >- - A Supervisor Agent that orchestrates sub-agents - and tools, referenced by tile_id. - supervisor_api: - type: object - properties: - instructions: - type: string - description: >- - Optional. System instructions that guide how - the supervisor routes queries across tools and - synthesizes responses. - model: - type: string - description: >- - Required. Databricks-provided FMAPI model, - e.g. "databricks-claude-sonnet-4-5". - tools: - type: array - items: - type: object - properties: - app: - type: object - properties: - name: - type: string - description: >- - Databricks App tool config. Set when the - discriminator == "app". - catalog: - type: object - properties: - name: - type: string - description: >- - Unity Catalog catalog tool config. Set - when the discriminator == "catalog". - dashboard: - type: object - properties: - dashboard_id: - type: string - description: >- - Lakeview dashboard tool config. Set when - the discriminator == "dashboard". - description: - type: string - description: >- - Optional. Free-form description of the - tool. - genie_space: - type: object - properties: - space_id: - type: string - description: >- - Genie space tool config. Set when the - discriminator == "genie_space". - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - description: >- - Knowledge Assistant tool config. Set - when the discriminator == - "knowledge_assistant". - schema: - type: object - properties: - name: - type: string - description: >- - Unity Catalog schema tool config. Set - when the discriminator == "schema". - serving_endpoint: - type: object - properties: - name: - type: string - description: >- - Model serving endpoint tool config. Set - when the discriminator == - "serving_endpoint". - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: >- - Supervisor Agent tool config (a - supervisor agent used as a tool). Set - when the discriminator == - "supervisor_agent". - table: - type: object - properties: - name: - type: string - description: >- - Unity Catalog table tool config. Set - when the discriminator == "table". - tool_type: - type: string - uc_connection: - type: object - properties: - name: - type: string - description: >- - External MCP / UC connection tool - config. Set when the discriminator == - "uc_connection". - uc_function: - type: object - properties: - name: - type: string - description: >- - Unity Catalog function tool config. Set - when the discriminator == "uc_function". - uc_mcp: - type: object - properties: - name: - type: string - description: >- - UC-registered MCP service tool config. - Set when the discriminator == "uc_mcp". - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Vector Search index tool config. Set - when the discriminator == - "vector_search_index". - volume: - type: object - properties: - name: - type: string - description: >- - Unity Catalog volume tool config. Set - when the discriminator == "volume". - web_search: - type: object - properties: {} - description: >- - Web search tool config. Set when the - discriminator == "web_search". - description: >- - Tool configuration for an inlined agentic - task agent. Discriminator selects which - per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - description: Optional. The tools the inlined agent can use. - description: >- - Inlined Responses-API supervisor configuration - (model + instructions + tools). Mutually exclusive - with ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field 8) - instead. Kept for backwards compatibility with - existing callers; will be removed in a future - revision. - trace_destination: - type: object - properties: - catalog_name: - type: string - description: >- - Unity Catalog catalog name for the trace - table. - experiment_id: - type: string - description: MLflow experiment ID where traces are written. - schema_name: - type: string - description: Unity Catalog schema name for the trace table. - table_prefix: - type: string - description: >- - Table-name prefix under - ``.``. Trace tables are - created as - ``.._<...>``. - description: >- - Optional. Where MLflow traces produced by this - task run should be persisted. When unset, traces - follow the workspace default destination. - description: Agentic Task for job-based multi-agent execution ai_runtime_task: type: object properties: @@ -1226,20 +996,6 @@ paths: items: type: object properties: - command_path: - type: string - description: >- - Workspace path of the script to run on each - node in this deployment. Upload the script - to this path and supply the path here. When - the task runs, the file at this path is run - on each node; if it fails, the task fails - with its exit code. Example script contents: - Plain Python: python train.py --epochs 10 - Multi-GPU via accelerate: accelerate launch - train.py --config config.yaml Distributed - via torchrun: torchrun --nproc_per_node=8 - train.py compute: type: object properties: @@ -1267,20 +1023,37 @@ paths: ``GPU_8xH100`` with ``accelerator_count: 16`` allocates 2 nodes (8 GPUs per node). + provisioned_capacity_id: + type: string + description: >- + Optional ID of a pre-provisioned + accelerator capacity reservation to run + this AI Runtime workload on. When set, + the workload is scheduled onto the + referenced reserved capacity instead of + the on-demand capacity shared among all + Databricks customers. required: - accelerator_type - accelerator_count description: >- Compute resources allocated to each node in this deployment. - docker_image_url: + command_path: type: string description: >- - Optional Docker image URL for a custom - container image. When set, the task runs on - the specified container image instead of the - default Databricks client image. Format: - ``{organization}/{repository}:{tag}`` + Workspace path of the script to run on each + node in this deployment. Upload the script + to this path and supply the path here. When + the task runs, the file at this path is run + on each node; if it fails, the task fails + with its exit code. Example script contents: + .. code-block:: bash # Plain Python: python + train.py --epochs 10 # Multi-GPU via + accelerate: accelerate launch train.py + --config config.yaml # Distributed via + torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -1291,7 +1064,6 @@ paths: recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one deployment @@ -1323,6 +1095,17 @@ paths: container image instead of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow artifacts logged + by the run. If this field isn't specified the + default artifact location will be in dbfs i.e. + ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is preferred + this can be a custom location in UC: + ``dbfs:/Volumes////...`` + The location should be unique for each experiment. mlflow_experiment_directory: type: string description: >- @@ -1338,20 +1121,27 @@ paths: Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for the workload. May + only be set together with a pre-provisioned + capacity reservation (a deployment's + ``compute.provisioned_capacity_id``); it is + rejected on a workload that runs on on-demand + capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each - deployment's command. Keys are parameter names, - values the corresponding arguments (for example, - ``{"epochs": "3", "dataset": - "s3://bucket/train"}``). Values may contain - dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, which Jobs - substitutes before execution (see - ``AiRuntimeTaskResolvedValues.parameters`` in - runs.proto). + Optional Unity Catalog path for a custom container + image. When set, the task runs on the specified + container image instead of the default Databricks + client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -1526,8 +1316,121 @@ paths: subscription: type: object properties: + attachment: + type: object + properties: + data_attachment: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + page_id: + type: string + description: >- + The URL identifier of the page + containing the widget. This is the value + of the ``name`` field of the + corresponding entry under ``pages`` in + the serialized dashboard definition. + Format: alphanumeric, hyphen, and + underscore characters allowed, max + length 63. + widget_id: + type: string + description: >- + The URL identifier of the widget. This + is the value of the ``name`` field of + the corresponding widget under that + page's ``layout`` in the serialized + dashboard definition. Format: + alphanumeric, hyphen, and underscore + characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data + to attach. ``page_id`` and ``widget_id`` + are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + description: >- + The widgets whose underlying data is + exported. At least one widget must be + referenced. + file_format: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The file format of the exported tabular + data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied + filter values are included alongside the + tabular data as an additional attached + file. + required: + - widgets + - file_format + description: >- + Optional: The configuration for the + underlying data of dashboard widgets + attached as tabular data files. If not + specified, no tabular data is attached. + page_attachment: + type: object + properties: + page_ids: + type: array + items: + type: string + description: >- + The identifiers of the pages to include + in the PDF. Only specified when + ``page_selection`` is + ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the + dashboard's serialized definition + returned by the Get dashboard API + (``serialized_dashboard``): the value of + the ``name`` field of an entry under + ``pages``. Format: alphanumeric, hyphen, + and underscore characters allowed, max + length 63. + page_selection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: >- + How the attached pages are selected. + When set to ``PAGE_SELECTION_SUBSET``, + the pages to include are listed in + ``page_ids``. + description: >- + Optional: The selection of dashboard pages + included in the attached PDF. If not + specified, only the first page is + included. + description: >- + The configuration for the files attached to + the dashboard snapshot notification sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. custom_subject: type: string + description: >- + Optional: Allows users to specify a custom + subject line on the email sent to subscribers. paused: type: boolean description: >- @@ -1778,17 +1681,16 @@ paths: description: >- The key that references an environment spec in a job. This field is required for Python script, Python wheel - and dbt tasks when using serverless compute. + and dbt tasks when using serverless compute or a + compute resource that uses Environments mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in ``JobSettings.environment_variables``. The - selected entry's variables and file contents are - applied to this task at execution time. Length and - pattern mirror ``environment_key`` so the two - references look identical to customers reading task - settings. + selected entry's variables are applied to this task at + execution time. This field supports serverless tasks + using environment version 5 or later. existing_cluster_id: type: string description: >- @@ -1827,23 +1729,6 @@ paths: dl_runtime_image: type: string description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) that - submitted this task. Used by handlers to gate - behavior or reject incompatible versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the user's - workspace contents. When set, the entry script - extracts the tarball into the working directory - before running the training script, so the - training script can import sibling modules and - read packaged data files. Must be a workspace path - (e.g. ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. command: type: string description: >- @@ -1862,13 +1747,6 @@ paths: description: GPU type. required: - num_gpus - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL for - running the training script. Format: - organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- @@ -1876,24 +1754,6 @@ paths: experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run created - for this task. If unset, MLflow auto-generates a - name. Used alongside ``mlflow_experiment_name`` to - identify the run in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file - describing pip dependencies to install before - running the training script. Consumed by the entry - script; format matches the runtime - requirements.yaml convention used by sgcli. Must - be a workspace path (e.g. - ``/Workspace/Users/...``) or volume; ``dbfs:/`` is - not supported. source: type: string x-enum: @@ -1940,17 +1800,6 @@ paths: ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - genie_task: - type: object - properties: - configuration_id: - type: string - description: >- - Required. Resource name of the agent task - configuration to run. - required: - - configuration_id - description: Runs a Genie or Genie Code agent task. health: type: object properties: @@ -2172,71 +2021,6 @@ paths: properties: connection_resource_name: type: string - incremental_refresh_config: - type: object - properties: - archive_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the archive window. Default: - MONTH - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window (total - data retained). Must be greater than the - refresh window when using the same - granularity. Default: 3 (with YEAR granularity - = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether data has - changed in each partition before reimporting. - Partitions with unchanged data are skipped, - reducing refresh cost further. Uses - MAX(datetime_column) as the change detector. - mode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: >- - The refresh policy mode. Hybrid adds a - real-time DirectQuery partition for the most - recent data; Import uses only batch-imported - partitions. Default: HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods (e.g., - skip today's partial data). - refresh_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the refresh window. Default: - DAY - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh - window. Partitions within this window are - re-imported on each refresh. Default: 1 - description: >- - Incremental refresh policy applied to all IMPORT - mode tables in the model. Windows and mode are - shared; partition columns are set per-table on - PowerBiTable. power_bi_model: type: object properties: @@ -2330,14 +2114,6 @@ paths: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental - refresh partitioning on this table. e.g., - "order_date", "updated_at" Only applicable - when the task has incremental_refresh_config - set and this table uses IMPORT storage mode. name: type: string description: The table name in Databricks @@ -2351,24 +2127,6 @@ paths: - DUAL - IMPORT description: The Power BI storage mode of the table - table_type: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of this table. - When set, the server trusts it to classify - the table during metric-view filtering and - skips the server-side lookup. When unset, - the server resolves the type on its own. description: The tables to be exported to Power BI warehouse_id: type: string @@ -3162,6 +2920,311 @@ paths: met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to ``runNow``. + triggers: + type: array + items: + type: object + properties: + continuous: + type: object + properties: + maintenance_window: + type: object + properties: + start_hour: + type: integer + description: >- + An integer between 0 and 23 denoting the start + hour for the maintenance window in the 24-hour + day. Platform-initiated maintenance is + triggered only within a one-hour window + starting at this hour. This field is required. + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + description: >- + The day of week on which maintenance is + allowed to happen. This field is required. + timezone_id: + type: string + description: >- + A Java timezone ID. The maintenance window is + resolved with respect to this timezone. See + `Java TimeZone + `__ + for details. This field is required. + required: + - start_hour + - day_of_week + - timezone_id + description: >- + Defines when platform-initiated maintenance may + run for this trigger. If unspecified, maintenance + may run at any time. + task_retry_mode: + type: string + x-enum: + - NEVER + - ON_FAILURE + description: >- + Whether the continuous job applies task-level + retries. Defaults to NEVER. + description: Continuous trigger configuration. + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after the + specified amount of time passed since the last + time the trigger fired. The minimum allowed value + is 60 seconds + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + file activity has occurred for the specified + amount of time. This makes it possible to wait for + a batch of incoming files to arrive before + triggering a run. The minimum allowed value is 60 + seconds. + required: + - url + description: File arrival trigger configuration. + model: + type: object + properties: + condition: + type: string + x-enum: + - MODEL_ALIAS_SET + - MODEL_CREATED + - MODEL_VERSION_READY + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how + many members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members + can have their own + + attributes -- see the documentation for details. + aliases: + type: array + items: + type: string + description: >- + Aliases of the model versions to monitor. Can only + be used in conjunction with condition + MODEL_ALIAS_SET. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after the + specified amount of time has passed since the last + time the trigger fired. The minimum allowed value + is 60 seconds. + securable_name: + type: string + description: >- + Name of the securable to monitor + ("mycatalog.myschema.mymodel" in the case of + model-level triggers, "mycatalog.myschema" in the + case of schema-level triggers) or empty in the + case of metastore-level triggers. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + model updates have occurred for the specified time + and can be used to wait for a series of model + updates before triggering a run. The minimum + allowed value is 60 seconds. + required: + - condition + description: Model trigger configuration. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: >- + Whether this trigger is paused. Defaults to UNPAUSED + when unset; the server always returns an explicit + value on read. + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + x-enum: + - DAYS + - HOURS + - MINUTES + - WEEKS + description: The unit of time for the interval. + required: + - interval + - unit + description: >- + Trigger type: exactly one must be set; mutual + exclusivity is enforced in the API handler Periodic + trigger configuration. + schedule: + type: object + properties: + quartz_cron_expression: + type: string + description: >- + A Cron expression using Quartz syntax that + describes the schedule for this trigger. See `Cron + Trigger + `__ + for details. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with + respect to this timezone. See `Java TimeZone + `__ + for details. + required: + - quartz_cron_expression + - timezone_id + description: Cron schedule trigger configuration. + sql_condition: + type: object + properties: + sql_query_id: + type: string + warehouse_id: + type: string + description: >- + The canonical identifier of the SQL warehouse to + run the condition query against. + trigger_mode: + type: string + x-enum: + - QUERY_RETURNS_ROWS + - RESULT_VALUE_CHANGES + description: >- + Determines how the SQL query result is interpreted + to decide whether the condition fires. Must be set + to a recognized value when provided. When unset on + an existing serialized configuration, the server + preserves the original semantics by interpreting + it as ``QUERY_RETURNS_ROWS``. New configurations + should set this explicitly — explicit + ``SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`` is + rejected at validation. + required: + - sql_query_id + - warehouse_id + description: >- + Optional SQL condition that gates whether this trigger + fires. + table_update: + type: object + properties: + table_names: + type: array + items: + type: string + condition: + type: string + x-enum: + - ALL_UPDATED + - ANY_UPDATED + description: >- + The table(s) condition based on which to trigger a + job run. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after the + specified amount of time has passed since the last + time the trigger fired. The minimum allowed value + is 60 seconds. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + table updates have occurred for the specified time + and can be used to wait for a series of table + updates before triggering a run. The minimum + allowed value is 60 seconds. + required: + - table_names + description: Table update trigger configuration. + description: >- + A single trigger attached to a job via + ``JobSettings.triggers``. Exactly one of the trigger-type + fields (``periodic``, ``schedule``, ``continuous``, ``file_arrival``, ``table_update``, + ``model``, ``job_completion``) must be set; mutual exclusivity is enforced in the API handler + rather than via ``oneof`` so that codegen, validation, and JSON serialization across SDKs and + Terraform behave consistently. + description: >- + List of triggers attached to this job. A run starts when any + active trigger evaluates to true. Cannot be set in the same + request as the legacy ``schedule``, ``trigger``, or + ``continuous`` fields. Gated behind the "Multiple Triggers" + feature preview. usage_policy_id: type: string description: >- @@ -4138,6 +4201,11 @@ paths: ⚠ **Deprecation note** Use `job parameters `__ to pass information down to tasks. + :param duration_target: str (optional) + The window the run aims to finish within, in hours, for a Cost-optimized serverless run. Required + only when ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the supported values: + ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional cost-saving optimizations. :param jar_params: List[str] (optional) A list of parameters for jobs with Spark JAR tasks, for example ``"jar_params": ["john doe", "35"]``. The parameters are used to invoke the main function of the main class specified in the @@ -4173,9 +4241,11 @@ paths: performance or cost-efficiency for the run. This field overrides the performance target defined on the job level. - - ``STANDARD``: Enables cost-efficient execution of serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. + - ``STANDARD``: Enables cost-efficient execution of serverless workloads. + - ``COST_OPTIMIZED``: Enables lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. :param pipeline_params: :class:`PipelineParams` (optional) Controls whether the pipeline should perform a full refresh :param python_named_params: Dict[str,str] (optional) @@ -4252,6 +4322,16 @@ paths: `job parameters `__ to pass information down to tasks. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of + the supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, + ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional + cost-saving optimizations. jar_params: type: array items: @@ -4305,11 +4385,14 @@ paths: The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the - performance target defined on the job level. - ``STANDARD``: - Enables cost-efficient execution of serverless workloads. - + performance target defined on the job level. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster - performance. + performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: + Enables lower job costs by optimizing compute for your + selected target duration time. Must provide a duration + target. pipeline_params: type: object properties: @@ -4531,7 +4614,9 @@ paths: An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of ``schedule`` and - ``continuous`` can be used. + ``continuous`` can be used. Pipelines started by a + continuous job also run continuously, regardless of + their own pipeline mode setting. deployment: type: object properties: @@ -4573,6 +4658,16 @@ paths: description: >- An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for + a Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be + one of the supported values: ``NO_FLEXIBILITY``, ``4h``, + ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the + run uses the default cost-optimized performance level + without additional cost-saving optimizations. edit_mode: type: string x-enum: @@ -4679,80 +4774,62 @@ paths: ``JobSettings.environment_variables``. Tasks reference it from ``TaskSettings.environment_variables_key``. - files: - type: array - items: - type: string - description: >- - Workspace (``/Workspace/...``) or UC Volumes - (``/Volumes/...``) paths to ``.env`` files. - Maximum 5 files. Files are read, parsed, and - merged at task execution time, not at job creation - or update API call time. File format: each line - must be exactly ``KEY=VALUE``. Keys must match the - same regex as inlined variable names - (``^[A-Za-z_][A-Za-z0-9_]*$``); the value - continues to the end of the line. No other syntax - is supported — no comments, no quoted values, no - escape sequences, no variable interpolation. Any - line that does not match the ``KEY=VALUE`` shape - fails the run. Size limits: maximum 1,048,576 - bytes (1 MiB) per file on disk; maximum 131,072 - bytes (128 KiB) per ``KEY=VALUE`` line combined. - Caps are enforced at read time in jobs-runner — - files exceeding the per-file cap, or lines - exceeding the per-line cap, fail the run. On a - duplicate key, the later file wins; ``variables`` - override values from any file. Values may contain - {{secrets/scope/key}} references; those are - resolved at task execution time and never - persisted in resolved form. Do not use these files - to store raw secret values; consult `secret - management - `__ - for the right way to pass sensitive values. - variables: + spec: type: object - description: >- - Environment variables specified directly as - key/value pairs (as opposed to ``files``, which - are read from ``.env`` file paths). Maximum 100 - entries. Each key must match - ``^[A-Za-z_][A-Za-z0-9_]*$`` and be 1 to 256 - characters long. Each value is up to 512 - characters; larger values should be moved into a - ``.env`` file referenced from ``files``. On a - duplicate key, ``variables`` override values from - any file in ``files``. Values may contain - {{secrets/scope/key}} references; those are - resolved at task execution time and never - persisted in resolved form. Do not use this field - to store a raw secret value; consult `secret - management - `__ - for the right way to pass sensitive values. + properties: + files: + type: array + items: + type: string + description: >- + Workspace (``/Workspace/...``) or UC Volumes + (``/Volumes/...``) paths to ``.env`` files. + Maximum 5 files. Files are read, parsed, and + merged at task execution time, not at job + creation or update API call time. File format: + each line containing a variable must be + exactly ``KEY=VALUE``. Empty and + whitespace-only lines, and lines beginning + with ``#``, are ignored. Keys must match the + same regex as inlined variable names + (``^[A-Za-z_][A-Za-z0-9_]*$``); the value + continues to the end of the line. No other + syntax is supported — no inline comments, no + quoted values, no escape sequences, no + variable interpolation. Any other line that + does not match the ``KEY=VALUE`` shape fails + the run. Size limits: maximum 32,768 bytes (32 + KiB) per file on disk; maximum 1,024 bytes (1 + KiB) per ``KEY=VALUE`` line combined. Files or + lines exceeding these limits fail the run. On + a duplicate key, the later file wins; + ``variables`` override values from any file. + variables: + type: object + description: >- + Environment variables specified directly as + key/value pairs. Maximum 20 entries. Each key + must be 1 to 256 characters and match + ``^[A-Za-z_][A-Za-z0-9_]*$``: it must start + with an ASCII letter or underscore and contain + only ASCII letters, digits, and underscores. + Each value can be any Unicode string of up to + 512 characters, including an empty string. + description: The environment variable specification. + required: + - environment_variables_key description: >- A named environment-variable entry, defined once at the job level and referenced by key from one or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via ``TaskSettings.environment_variables_key``. - - Precedence within a single entry (later overrides earlier on duplicate keys): - - files (merged in submitted order; later file in the list wins) └─▶ variables (inline k/v - override file contents) └─▶ runtime (os.environ / sys.env — overrides all, - classic-parity) - - Resolved values are never persisted: ``{{secrets/scope/key}}`` references in ``variables`` or in - ``files`` contents are stored verbatim and resolved at task execution time on the DP . description: >- Named environment-variable entries that tasks can reference by key from - ``TaskSettings.environment_variables_key``. Each entry - holds inline ``variables`` plus optional ``.env`` - ``files``. Maximum 10 entries per job. Entries are - independent of one another — there is no cross-entry - merging. + ``TaskSettings.environment_variables_key``. Each entry's + ``spec`` holds inline ``variables`` and optional + ``.env`` ``files``. Maximum 10 entries per job. A task + can reference at most one entry from this list. environments: type: array items: @@ -4766,13 +4843,17 @@ paths: - environment_key description: >- A list of task execution environment specifications that - can be referenced by serverless tasks of this job. For - serverless notebook tasks, if the environment_key is not - specified, the notebook environment will be used if - present. If a jobs environment is specified, it will - override the notebook environment. For other serverless - tasks, the task environment is required to be specified - using environment_key in the task settings. + can be referenced by tasks that use serverless compute + or a compute resource that uses Environments mode. For + notebook tasks that use serverless compute or a compute + resource that uses Environments mode, if the + environment_key is not specified, the notebook + environment will be used if present. If a jobs + environment is specified, it will override the notebook + environment. For other tasks that use serverless compute + or a compute resource that uses Environments mode, the + task environment is required to be specified using + environment_key in the task settings. format: type: string x-enum: @@ -4976,7 +5057,6 @@ paths: tasks bound to this cluster. required: - job_cluster_key - - new_cluster description: >- A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be @@ -5048,10 +5128,13 @@ paths: determines the level of compute performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: - Prioritizes fast startup and execution times through - rapid scaling and optimized cluster performance. + ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and + execution times through rapid scaling and optimized + cluster performance. - ``STANDARD``: Enables + cost-efficient execution of serverless workloads. - + ``COST_OPTIMIZED``: Enables lower job costs by + optimizing compute for your selected target duration + time. Must provide a duration target. queue: type: object properties: @@ -5067,8 +5150,11 @@ paths: type: string description: >- Group name of an account group assigned to the - workspace. Setting this field requires being a - member of the group. + workspace. When set, all tasks run as the group and + the group's permissions are used for data access. + Setting this field requires being a member of the + group, or having the ``Assume`` permission on the + group. service_principal_name: type: string description: >- @@ -5162,302 +5248,67 @@ paths: properties: task_key: type: string - agentic_task: + ai_runtime_task: type: object properties: - context: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: >- - Optional. Conversation IDs to load as - context for the agent. - instructions: - type: array - items: - type: string - description: >- - Optional. Additional instructions to guide - the agent's behavior. - description: >- - Optional. Context input providing conversation - history and instructions. - genie_code_api: - type: object - properties: {} - description: >- - Inline Genie Code conversation driven by a - single prompt. Mutually exclusive with the - supervisor variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) instead. - Kept for backwards compatibility with existing - callers; will be removed in a future revision. - input: + experiment: type: string description: >- - Optional. The user query / task input the - agent must accomplish. Mirrors the OpenAI - Responses API ``input`` field. Replaces the - deprecated ``goal`` field; new callers should - populate ``input`` going forward. - output_schema: - type: object - properties: + MLflow experiment name for this run. If an + experiment with this name already exists under + the calling user, the run is appended to it; + otherwise a new experiment is created. To + target a specific MLflow storage location (for + example, when running as a service principal), + set ``mlflow_experiment_directory``. + deployments: + type: array + items: + type: object properties: - type: object - description: >- - Map of property name to property - definition. - description: >- - Optional. JSON-Schema-style declaration of the - structured output the agent should produce. - Replaces the deprecated ``task_output_schema`` - map; new callers should populate - ``output_schema`` going forward. - supervisor_agent: - type: object - properties: - agent_id: - type: string - description: >- - Required. The ID of the supervisor agent - (tile_id). - description: >- - A Supervisor Agent that orchestrates - sub-agents and tools, referenced by tile_id. - supervisor_api: - type: object - properties: - instructions: - type: string - description: >- - Optional. System instructions that guide - how the supervisor routes queries across - tools and synthesizes responses. - model: - type: string - description: >- - Required. Databricks-provided FMAPI model, - e.g. "databricks-claude-sonnet-4-5". - tools: - type: array - items: + compute: type: object properties: - app: - type: object - properties: - name: - type: string - description: >- - Databricks App tool config. Set when the - discriminator == "app". - catalog: - type: object - properties: - name: - type: string - description: >- - Unity Catalog catalog tool config. Set - when the discriminator == "catalog". - dashboard: - type: object - properties: - dashboard_id: - type: string - description: >- - Lakeview dashboard tool config. Set when - the discriminator == "dashboard". - description: + accelerator_type: type: string + x-enum: + - GPU_1xA10 + - GPU_1xH100 + - GPU_8xB300 + - GPU_8xH100 description: >- - Optional. Free-form description of the - tool. - genie_space: - type: object - properties: - space_id: - type: string - description: >- - Genie space tool config. Set when the - discriminator == "genie_space". - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - description: >- - Knowledge Assistant tool config. Set - when the discriminator == - "knowledge_assistant". - schema: - type: object - properties: - name: - type: string - description: >- - Unity Catalog schema tool config. Set - when the discriminator == "schema". - serving_endpoint: - type: object - properties: - name: - type: string - description: >- - Model serving endpoint tool config. Set - when the discriminator == - "serving_endpoint". - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: >- - Supervisor Agent tool config (a - supervisor agent used as a tool). Set - when the discriminator == - "supervisor_agent". - table: - type: object - properties: - name: - type: string + Hardware accelerator type (for example, + ``GPU_1xA10`` or ``GPU_8xH100``). The + number of accelerators per node is + encoded in the enum value — + ``GPU_8xH100`` means 8 H100 GPUs per + node. + accelerator_count: + type: integer description: >- - Unity Catalog table tool config. Set - when the discriminator == "table". - tool_type: + Total number of accelerators across all + nodes. Must be a positive multiple of + the per-node accelerator count encoded + in ``accelerator_type``. For example, + ``GPU_8xH100`` with ``accelerator_count: + 16`` allocates 2 nodes (8 GPUs per + node). + provisioned_capacity_id: type: string - uc_connection: - type: object - properties: - name: - type: string description: >- - External MCP / UC connection tool - config. Set when the discriminator == - "uc_connection". - uc_function: - type: object - properties: - name: - type: string - description: >- - Unity Catalog function tool config. Set - when the discriminator == "uc_function". - uc_mcp: - type: object - properties: - name: - type: string - description: >- - UC-registered MCP service tool config. - Set when the discriminator == "uc_mcp". - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Vector Search index tool config. Set - when the discriminator == - "vector_search_index". - volume: - type: object - properties: - name: - type: string - description: >- - Unity Catalog volume tool config. Set - when the discriminator == "volume". - web_search: - type: object - properties: {} - description: >- - Web search tool config. Set when the - discriminator == "web_search". + Optional ID of a pre-provisioned + accelerator capacity reservation to run + this AI Runtime workload on. When set, + the workload is scheduled onto the + referenced reserved capacity instead of + the on-demand capacity shared among all + Databricks customers. + required: + - accelerator_type + - accelerator_count description: >- - Tool configuration for an inlined - agentic task agent. Discriminator - selects which per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - description: >- - Optional. The tools the inlined agent can - use. - description: >- - Inlined Responses-API supervisor configuration - (model + instructions + tools). Mutually - exclusive with ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field 8) - instead. Kept for backwards compatibility with - existing callers; will be removed in a future - revision. - trace_destination: - type: object - properties: - catalog_name: - type: string - description: >- - Unity Catalog catalog name for the trace - table. - experiment_id: - type: string - description: >- - MLflow experiment ID where traces are - written. - schema_name: - type: string - description: >- - Unity Catalog schema name for the trace - table. - table_prefix: - type: string - description: >- - Table-name prefix under - ``.``. Trace tables are - created as - ``.._<...>``. - description: >- - Optional. Where MLflow traces produced by this - task run should be persisted. When unset, - traces follow the workspace default - destination. - description: Agentic Task for job-based multi-agent execution - ai_runtime_task: - type: object - properties: - experiment: - type: string - description: >- - MLflow experiment name for this run. If an - experiment with this name already exists under - the calling user, the run is appended to it; - otherwise a new experiment is created. To - target a specific MLflow storage location (for - example, when running as a service principal), - set ``mlflow_experiment_directory``. - deployments: - type: array - items: - type: object - properties: + Compute resources allocated to each node + in this deployment. command_path: type: string description: >- @@ -5467,54 +5318,13 @@ paths: here. When the task runs, the file at this path is run on each node; if it fails, the task fails with its exit - code. Example script contents: Plain - Python: python train.py --epochs 10 - Multi-GPU via accelerate: accelerate - launch train.py --config config.yaml - Distributed via torchrun: torchrun - --nproc_per_node=8 train.py - compute: - type: object - properties: - accelerator_type: - type: string - x-enum: - - GPU_1xA10 - - GPU_1xH100 - - GPU_8xB300 - - GPU_8xH100 - description: >- - Hardware accelerator type (for example, - ``GPU_1xA10`` or ``GPU_8xH100``). The - number of accelerators per node is - encoded in the enum value — - ``GPU_8xH100`` means 8 H100 GPUs per - node. - accelerator_count: - type: integer - description: >- - Total number of accelerators across all - nodes. Must be a positive multiple of - the per-node accelerator count encoded - in ``accelerator_type``. For example, - ``GPU_8xH100`` with ``accelerator_count: - 16`` allocates 2 nodes (8 GPUs per - node). - required: - - accelerator_type - - accelerator_count - description: >- - Compute resources allocated to each node - in this deployment. - docker_image_url: - type: string - description: >- - Optional Docker image URL for a custom - container image. When set, the task runs - on the specified container image instead - of the default Databricks client image. - Format: - ``{organization}/{repository}:{tag}`` + code. Example script contents: .. + code-block:: bash # Plain Python: python + train.py --epochs 10 # Multi-GPU via + accelerate: accelerate launch train.py + --config config.yaml # Distributed via + torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -5525,7 +5335,6 @@ paths: recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one @@ -5559,6 +5368,19 @@ paths: the specified container image instead of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow artifacts + logged by the run. If this field isn't + specified the default artifact location will + be in dbfs i.e. + ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is + preferred this can be a custom location in UC: + ``dbfs:/Volumes////...`` + The location should be unique for each + experiment. mlflow_experiment_directory: type: string description: >- @@ -5575,20 +5397,28 @@ paths: Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for the workload. + May only be set together with a + pre-provisioned capacity reservation (a + deployment's + ``compute.provisioned_capacity_id``); it is + rejected on a workload that runs on on-demand + capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each - deployment's command. Keys are parameter - names, values the corresponding arguments (for - example, ``{"epochs": "3", "dataset": - "s3://bucket/train"}``). Values may contain - dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, which - Jobs substitutes before execution (see - ``AiRuntimeTaskResolvedValues.parameters`` in - runs.proto). + Optional Unity Catalog path for a custom + container image. When set, the task runs on + the specified container image instead of the + default Databricks client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -5768,8 +5598,123 @@ paths: subscription: type: object properties: + attachment: + type: object + properties: + data_attachment: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + page_id: + type: string + description: >- + The URL identifier of the page + containing the widget. This is the value + of the ``name`` field of the + corresponding entry under ``pages`` in + the serialized dashboard definition. + Format: alphanumeric, hyphen, and + underscore characters allowed, max + length 63. + widget_id: + type: string + description: >- + The URL identifier of the widget. This + is the value of the ``name`` field of + the corresponding widget under that + page's ``layout`` in the serialized + dashboard definition. Format: + alphanumeric, hyphen, and underscore + characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data + to attach. ``page_id`` and ``widget_id`` + are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + description: >- + The widgets whose underlying data is + exported. At least one widget must be + referenced. + file_format: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The file format of the exported tabular + data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied + filter values are included alongside the + tabular data as an additional attached + file. + required: + - widgets + - file_format + description: >- + Optional: The configuration for the + underlying data of dashboard widgets + attached as tabular data files. If not + specified, no tabular data is attached. + page_attachment: + type: object + properties: + page_ids: + type: array + items: + type: string + description: >- + The identifiers of the pages to include + in the PDF. Only specified when + ``page_selection`` is + ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the + dashboard's serialized definition + returned by the Get dashboard API + (``serialized_dashboard``): the value of + the ``name`` field of an entry under + ``pages``. Format: alphanumeric, hyphen, + and underscore characters allowed, max + length 63. + page_selection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: >- + How the attached pages are selected. + When set to ``PAGE_SELECTION_SUBSET``, + the pages to include are listed in + ``page_ids``. + description: >- + Optional: The selection of dashboard + pages included in the attached PDF. If + not specified, only the first page is + included. + description: >- + The configuration for the files attached + to the dashboard snapshot notification + sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. custom_subject: type: string + description: >- + Optional: Allows users to specify a custom + subject line on the email sent to + subscribers. paused: type: boolean description: >- @@ -6034,17 +5979,17 @@ paths: The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless - compute. + compute or a compute resource that uses + Environments mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in ``JobSettings.environment_variables``. - The selected entry's variables and file contents - are applied to this task at execution time. Length - and pattern mirror ``environment_key`` so the two - references look identical to customers reading - task settings. + The selected entry's variables are applied to this + task at execution time. This field supports + serverless tasks using environment version 5 or + later. existing_cluster_id: type: string description: >- @@ -6084,24 +6029,6 @@ paths: dl_runtime_image: type: string description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) that - submitted this task. Used by handlers to gate - behavior or reject incompatible versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the - user's workspace contents. When set, the entry - script extracts the tarball into the working - directory before running the training script, - so the training script can import sibling - modules and read packaged data files. Must be - a workspace path (e.g. - ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. command: type: string description: >- @@ -6120,13 +6047,6 @@ paths: description: GPU type. required: - num_gpus - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL for - running the training script. Format: - organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- @@ -6134,25 +6054,6 @@ paths: MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run - created for this task. If unset, MLflow - auto-generates a name. Used alongside - ``mlflow_experiment_name`` to identify the run - in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file - describing pip dependencies to install before - running the training script. Consumed by the - entry script; format matches the runtime - requirements.yaml convention used by sgcli. - Must be a workspace path (e.g. - ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. source: type: string x-enum: @@ -6201,17 +6102,6 @@ paths: ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - genie_task: - type: object - properties: - configuration_id: - type: string - description: >- - Required. Resource name of the agent task - configuration to run. - required: - - configuration_id - description: Runs a Genie or Genie Code agent task. health: type: object properties: @@ -6443,72 +6333,6 @@ paths: properties: connection_resource_name: type: string - incremental_refresh_config: - type: object - properties: - archive_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the archive window. - Default: MONTH - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window - (total data retained). Must be greater - than the refresh window when using the - same granularity. Default: 3 (with YEAR - granularity = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether data - has changed in each partition before - reimporting. Partitions with unchanged - data are skipped, reducing refresh cost - further. Uses MAX(datetime_column) as the - change detector. - mode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: >- - The refresh policy mode. Hybrid adds a - real-time DirectQuery partition for the - most recent data; Import uses only - batch-imported partitions. Default: HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods - (e.g., skip today's partial data). - refresh_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the refresh window. - Default: DAY - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh - window. Partitions within this window are - re-imported on each refresh. Default: 1 - description: >- - Incremental refresh policy applied to all - IMPORT mode tables in the model. Windows and - mode are shared; partition columns are set - per-table on PowerBiTable. power_bi_model: type: object properties: @@ -6606,15 +6430,6 @@ paths: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental - refresh partitioning on this table. - e.g., "order_date", "updated_at" Only - applicable when the task has - incremental_refresh_config set and this - table uses IMPORT storage mode. name: type: string description: The table name in Databricks @@ -6628,25 +6443,6 @@ paths: - DUAL - IMPORT description: The Power BI storage mode of the table - table_type: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of this - table. When set, the server trusts it to - classify the table during metric-view - filtering and skips the server-side - lookup. When unset, the server resolves - the type on its own. description: The tables to be exported to Power BI warehouse_id: type: string @@ -7458,100 +7254,410 @@ paths: are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to ``runNow``. - usage_policy_id: - type: string - description: >- - The id of the user specified usage policy to use for - this job. If not specified, a default usage policy may - be applied when creating or modifying the job. See - ``effective_usage_policy_id`` for the usage policy used - by this workload. - webhook_notifications: - type: object - properties: - on_duration_warning_threshold_exceeded: - type: array - items: - type: object - properties: - id: - type: string - required: - - id - on_failure: - type: array - items: - type: object - properties: - id: - type: string - required: - - id - description: >- - An optional list of system notification IDs to call - when the run fails. A maximum of 3 destinations can - be specified for the ``on_failure`` property. - on_maintenance_complete: - type: array - items: - type: object - properties: - id: - type: string - required: - - id - description: >- - An optional list of system notification IDs to call - when platform-initiated maintenance completes for a - continuous job. A maximum of 3 destinations can be - specified for the ``on_maintenance_complete`` - property. - on_maintenance_start: - type: array - items: + triggers: + type: array + items: + type: object + properties: + continuous: type: object properties: - id: + maintenance_window: + type: object + properties: + start_hour: + type: integer + description: >- + An integer between 0 and 23 denoting the + start hour for the maintenance window in + the 24-hour day. Platform-initiated + maintenance is triggered only within a + one-hour window starting at this hour. + This field is required. + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + description: >- + The day of week on which maintenance is + allowed to happen. This field is required. + timezone_id: + type: string + description: >- + A Java timezone ID. The maintenance window + is resolved with respect to this timezone. + See `Java TimeZone + `__ + for details. This field is required. + required: + - start_hour + - day_of_week + - timezone_id + description: >- + Defines when platform-initiated maintenance + may run for this trigger. If unspecified, + maintenance may run at any time. + task_retry_mode: type: string - required: - - id - description: >- - An optional list of system notification IDs to call - when platform-initiated maintenance starts for a - continuous job. A maximum of 3 destinations can be - specified for the ``on_maintenance_start`` property. - on_start: - type: array - items: + x-enum: + - NEVER + - ON_FAILURE + description: >- + Whether the continuous job applies task-level + retries. Defaults to NEVER. + description: Continuous trigger configuration. + file_arrival: type: object properties: - id: + url: type: string + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time passed since the + last time the trigger fired. The minimum + allowed value is 60 seconds + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + file activity has occurred for the specified + amount of time. This makes it possible to wait + for a batch of incoming files to arrive before + triggering a run. The minimum allowed value is + 60 seconds. required: - - id - description: >- - An optional list of system notification IDs to call - when the run starts. A maximum of 3 destinations can - be specified for the ``on_start`` property. - on_streaming_backlog_exceeded: - type: array - items: + - url + description: File arrival trigger configuration. + model: type: object properties: - id: + condition: type: string - required: - - id - description: >- - An optional list of system notification IDs to call - when any streaming backlog thresholds are exceeded - for any stream. Streaming backlog thresholds can be - set in the ``health`` field using the following - metrics: ``STREAMING_BACKLOG_BYTES``, - ``STREAMING_BACKLOG_RECORDS``, - ``STREAMING_BACKLOG_SECONDS``, or - ``STREAMING_BACKLOG_FILES``. Alerting is based on - the 10-minute average of these metrics. If the issue + x-enum: + - MODEL_ALIAS_SET + - MODEL_CREATED + - MODEL_VERSION_READY + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know + how many members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , + ] + + + Methods can be added to enumerations, and + members can have their own + + attributes -- see the documentation for + details. + aliases: + type: array + items: + type: string + description: >- + Aliases of the model versions to monitor. Can + only be used in conjunction with condition + MODEL_ALIAS_SET. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time has passed since + the last time the trigger fired. The minimum + allowed value is 60 seconds. + securable_name: + type: string + description: >- + Name of the securable to monitor + ("mycatalog.myschema.mymodel" in the case of + model-level triggers, "mycatalog.myschema" in + the case of schema-level triggers) or empty in + the case of metastore-level triggers. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + model updates have occurred for the specified + time and can be used to wait for a series of + model updates before triggering a run. The + minimum allowed value is 60 seconds. + required: + - condition + description: Model trigger configuration. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: >- + Whether this trigger is paused. Defaults to + UNPAUSED when unset; the server always returns an + explicit value on read. + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + x-enum: + - DAYS + - HOURS + - MINUTES + - WEEKS + description: The unit of time for the interval. + required: + - interval + - unit + description: >- + Trigger type: exactly one must be set; mutual + exclusivity is enforced in the API handler + Periodic trigger configuration. + schedule: + type: object + properties: + quartz_cron_expression: + type: string + description: >- + A Cron expression using Quartz syntax that + describes the schedule for this trigger. See + `Cron Trigger + `__ + for details. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved + with respect to this timezone. See `Java + TimeZone + `__ + for details. + required: + - quartz_cron_expression + - timezone_id + description: Cron schedule trigger configuration. + sql_condition: + type: object + properties: + sql_query_id: + type: string + warehouse_id: + type: string + description: >- + The canonical identifier of the SQL warehouse + to run the condition query against. + trigger_mode: + type: string + x-enum: + - QUERY_RETURNS_ROWS + - RESULT_VALUE_CHANGES + description: >- + Determines how the SQL query result is + interpreted to decide whether the condition + fires. Must be set to a recognized value when + provided. When unset on an existing serialized + configuration, the server preserves the + original semantics by interpreting it as + ``QUERY_RETURNS_ROWS``. New configurations + should set this explicitly — explicit + ``SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`` is + rejected at validation. + required: + - sql_query_id + - warehouse_id + description: >- + Optional SQL condition that gates whether this + trigger fires. + table_update: + type: object + properties: + table_names: + type: array + items: + type: string + condition: + type: string + x-enum: + - ALL_UPDATED + - ANY_UPDATED + description: >- + The table(s) condition based on which to + trigger a job run. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time has passed since + the last time the trigger fired. The minimum + allowed value is 60 seconds. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + table updates have occurred for the specified + time and can be used to wait for a series of + table updates before triggering a run. The + minimum allowed value is 60 seconds. + required: + - table_names + description: Table update trigger configuration. + description: >- + A single trigger attached to a job via + ``JobSettings.triggers``. Exactly one of the + trigger-type + fields (``periodic``, ``schedule``, ``continuous``, ``file_arrival``, ``table_update``, + ``model``, ``job_completion``) must be set; mutual exclusivity is enforced in the API handler + rather than via ``oneof`` so that codegen, validation, and JSON serialization across SDKs and + Terraform behave consistently. + description: >- + List of triggers attached to this job. A run starts when + any active trigger evaluates to true. Cannot be set in + the same request as the legacy ``schedule``, + ``trigger``, or ``continuous`` fields. Gated behind the + "Multiple Triggers" feature preview. + usage_policy_id: + type: string + description: >- + The id of the user specified usage policy to use for + this job. If not specified, a default usage policy may + be applied when creating or modifying the job. See + ``effective_usage_policy_id`` for the usage policy used + by this workload. + webhook_notifications: + type: object + properties: + on_duration_warning_threshold_exceeded: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + on_failure: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + description: >- + An optional list of system notification IDs to call + when the run fails. A maximum of 3 destinations can + be specified for the ``on_failure`` property. + on_maintenance_complete: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + description: >- + An optional list of system notification IDs to call + when platform-initiated maintenance completes for a + continuous job. A maximum of 3 destinations can be + specified for the ``on_maintenance_complete`` + property. + on_maintenance_start: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + description: >- + An optional list of system notification IDs to call + when platform-initiated maintenance starts for a + continuous job. A maximum of 3 destinations can be + specified for the ``on_maintenance_start`` property. + on_start: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + description: >- + An optional list of system notification IDs to call + when the run starts. A maximum of 3 destinations can + be specified for the ``on_start`` property. + on_streaming_backlog_exceeded: + type: array + items: + type: object + properties: + id: + type: string + required: + - id + description: >- + An optional list of system notification IDs to call + when any streaming backlog thresholds are exceeded + for any stream. Streaming backlog thresholds can be + set in the ``health`` field using the following + metrics: ``STREAMING_BACKLOG_BYTES``, + ``STREAMING_BACKLOG_RECORDS``, + ``STREAMING_BACKLOG_SECONDS``, or + ``STREAMING_BACKLOG_FILES``. Alerting is based on + the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the ``on_streaming_backlog_exceeded`` property. @@ -7614,6 +7720,11 @@ paths: ⚠ **Deprecation note** Use `job parameters `__ to pass information down to tasks. + :param duration_target: str (optional) + The window the run aims to finish within, in hours, for a Cost-optimized serverless run. Required + only when ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the supported values: + ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional cost-saving optimizations. :param idempotency_token: str (optional) An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists, the request does not create a new run but returns the ID of the existing run @@ -7623,9 +7734,6 @@ paths: Databricks guarantees that exactly one run is launched with that idempotency token. This token must have at most 64 characters. - - For more information, see `How to ensure idempotency for jobs - `__. :param jar_params: List[str] (optional) A list of parameters for jobs with Spark JAR tasks, for example ``"jar_params": ["john doe", "35"]``. The parameters are used to invoke the main function of the main class specified in the @@ -7666,9 +7774,11 @@ paths: performance or cost-efficiency for the run. This field overrides the performance target defined on the job level. - - ``STANDARD``: Enables cost-efficient execution of serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. + - ``STANDARD``: Enables cost-efficient execution of serverless workloads. + - ``COST_OPTIMIZED``: Enables lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. :param pipeline_params: :class:`PipelineParams` (optional) Controls whether the pipeline should perform a full refresh :param python_named_params: Dict[str,str] (optional) @@ -7736,6 +7846,16 @@ paths: `job parameters `__ to pass information down to tasks. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of + the supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, + ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional + cost-saving optimizations. idempotency_token: type: string description: >- @@ -7747,9 +7867,7 @@ paths: idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run is launched with that idempotency token. This token must - have at most 64 characters. For more information, see `How - to ensure idempotency for jobs - `__. + have at most 64 characters. jar_params: type: array items: @@ -7810,11 +7928,14 @@ paths: The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the - performance target defined on the job level. - ``STANDARD``: - Enables cost-efficient execution of serverless workloads. - + performance target defined on the job level. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster - performance. + performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: + Enables lower job costs by optimizing compute for your + selected target duration time. Must provide a duration + target. pipeline_params: type: object properties: @@ -7965,14 +8086,19 @@ paths: :param budget_policy_id: str (optional) The user specified id of the budget policy to use for this one-time run. If not specified, the run will be not be attributed to any budget policy. + :param duration_target: str (optional) + The window the run aims to finish within, in hours, for a Cost-optimized serverless run. Required + only when ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the supported values: + ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional cost-saving optimizations. :param email_notifications: :class:`JobEmailNotifications` (optional) An optional set of email addresses notified when the run begins or completes. :param environment_variables: List[:class:`JobEnvironmentVariables`] (optional) Named environment-variable entries that tasks of this one-time run can reference by key from - ``RunTaskSettings.environment_variables_key``. Each entry holds inline ``variables`` plus optional - ``.env`` ``files``. Handled identically to ``JobSettings.environment_variables``. Maximum 10 - entries. Entries are independent of one another — there is no cross-entry merging. + ``RunTaskSettings.environment_variables_key``. Each entry's ``spec`` holds inline ``variables`` and + optional ``.env`` ``files``. Handled identically to ``JobSettings.environment_variables``. Maximum + 10 entries. Entries are independent of one another — there is no cross-entry merging. :param environments: List[:class:`JobEnvironment`] (optional) A list of task execution environment specifications that can be referenced by tasks of this run. :param git_source: :class:`GitSource` (optional) @@ -7995,9 +8121,6 @@ paths: Databricks guarantees that exactly one run is launched with that idempotency token. This token must have at most 64 characters. - - For more information, see `How to ensure idempotency for jobs - `__. :param notification_settings: :class:`JobNotificationSettings` (optional) Optional notification settings that are used when sending notifications to each of the @@ -8007,9 +8130,11 @@ paths: performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. + - ``STANDARD``: Enables cost-efficient execution of serverless workloads. + - ``COST_OPTIMIZED``: Enables lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. :param queue: :class:`QueueSettings` (optional) The queue settings of the one-time run. :param run_as: :class:`JobRunAs` (optional) @@ -8017,10 +8142,6 @@ paths: user who submits the request. :param run_name: str (optional) An optional name for the run. The default value is ``Untitled``. - :param tags: Dict[str,str] (optional) - A map of tags associated with the one-time run, handled identically to job-level tags. The tags are - forwarded to the cluster as cluster tags for the run's compute, attributed in billing, and surfaced - in system tables. A maximum of 25 tags can be added. :param tasks: List[:class:`SubmitTask`] (optional) :param timeout_seconds: int (optional) @@ -8068,6 +8189,16 @@ paths: The user specified id of the budget policy to use for this one-time run. If not specified, the run will be not be attributed to any budget policy. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of + the supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, + ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the run uses the + default cost-optimized performance level without additional + cost-saving optimizations. email_notifications: type: object properties: @@ -8161,73 +8292,60 @@ paths: Identifier for this entry. Must be unique within ``JobSettings.environment_variables``. Tasks reference it from ``TaskSettings.environment_variables_key``. - files: - type: array - items: - type: string - description: >- - Workspace (``/Workspace/...``) or UC Volumes - (``/Volumes/...``) paths to ``.env`` files. Maximum 5 - files. Files are read, parsed, and merged at task - execution time, not at job creation or update API call - time. File format: each line must be exactly - ``KEY=VALUE``. Keys must match the same regex as - inlined variable names (``^[A-Za-z_][A-Za-z0-9_]*$``); - the value continues to the end of the line. No other - syntax is supported — no comments, no quoted values, - no escape sequences, no variable interpolation. Any - line that does not match the ``KEY=VALUE`` shape fails - the run. Size limits: maximum 1,048,576 bytes (1 MiB) - per file on disk; maximum 131,072 bytes (128 KiB) per - ``KEY=VALUE`` line combined. Caps are enforced at read - time in jobs-runner — files exceeding the per-file - cap, or lines exceeding the per-line cap, fail the - run. On a duplicate key, the later file wins; - ``variables`` override values from any file. Values - may contain {{secrets/scope/key}} references; those - are resolved at task execution time and never - persisted in resolved form. Do not use these files to - store raw secret values; consult `secret management - `__ - for the right way to pass sensitive values. - variables: + spec: type: object - description: >- - Environment variables specified directly as key/value - pairs (as opposed to ``files``, which are read from - ``.env`` file paths). Maximum 100 entries. Each key - must match ``^[A-Za-z_][A-Za-z0-9_]*$`` and be 1 to - 256 characters long. Each value is up to 512 - characters; larger values should be moved into a - ``.env`` file referenced from ``files``. On a - duplicate key, ``variables`` override values from any - file in ``files``. Values may contain - {{secrets/scope/key}} references; those are resolved - at task execution time and never persisted in resolved - form. Do not use this field to store a raw secret - value; consult `secret management - `__ - for the right way to pass sensitive values. + properties: + files: + type: array + items: + type: string + description: >- + Workspace (``/Workspace/...``) or UC Volumes + (``/Volumes/...``) paths to ``.env`` files. + Maximum 5 files. Files are read, parsed, and + merged at task execution time, not at job creation + or update API call time. File format: each line + containing a variable must be exactly + ``KEY=VALUE``. Empty and whitespace-only lines, + and lines beginning with ``#``, are ignored. Keys + must match the same regex as inlined variable + names (``^[A-Za-z_][A-Za-z0-9_]*$``); the value + continues to the end of the line. No other syntax + is supported — no inline comments, no quoted + values, no escape sequences, no variable + interpolation. Any other line that does not match + the ``KEY=VALUE`` shape fails the run. Size + limits: maximum 32,768 bytes (32 KiB) per file on + disk; maximum 1,024 bytes (1 KiB) per + ``KEY=VALUE`` line combined. Files or lines + exceeding these limits fail the run. On a + duplicate key, the later file wins; ``variables`` + override values from any file. + variables: + type: object + description: >- + Environment variables specified directly as + key/value pairs. Maximum 20 entries. Each key must + be 1 to 256 characters and match + ``^[A-Za-z_][A-Za-z0-9_]*$``: it must start with + an ASCII letter or underscore and contain only + ASCII letters, digits, and underscores. Each value + can be any Unicode string of up to 512 characters, + including an empty string. + description: The environment variable specification. + required: + - environment_variables_key description: >- A named environment-variable entry, defined once at the job level and referenced by key from one or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via ``TaskSettings.environment_variables_key``. - - Precedence within a single entry (later overrides earlier on duplicate keys): - - files (merged in submitted order; later file in the list wins) └─▶ variables (inline k/v - override file contents) └─▶ runtime (os.environ / sys.env — overrides all, - classic-parity) - - Resolved values are never persisted: ``{{secrets/scope/key}}`` references in ``variables`` or in - ``files`` contents are stored verbatim and resolved at task execution time on the DP . description: >- Named environment-variable entries that tasks of this one-time run can reference by key from - ``RunTaskSettings.environment_variables_key``. Each entry - holds inline ``variables`` plus optional ``.env`` ``files``. - Handled identically to + ``RunTaskSettings.environment_variables_key``. Each entry's + ``spec`` holds inline ``variables`` and optional ``.env`` + ``files``. Handled identically to ``JobSettings.environment_variables``. Maximum 10 entries. Entries are independent of one another — there is no cross-entry merging. @@ -8418,9 +8536,7 @@ paths: you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run is launched with that idempotency token. - This token must have at most 64 characters. For more - information, see `How to ensure idempotency for jobs - `__. + This token must have at most 64 characters. notification_settings: type: object properties: @@ -8445,10 +8561,13 @@ paths: field determines the level of compute performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of serverless - workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast - startup and execution times through rapid scaling and - optimized cluster performance. + ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and + execution times through rapid scaling and optimized cluster + performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: + Enables lower job costs by optimizing compute for your + selected target duration time. Must provide a duration + target. queue: type: object properties: @@ -8464,8 +8583,10 @@ paths: type: string description: >- Group name of an account group assigned to the - workspace. Setting this field requires being a member of - the group. + workspace. When set, all tasks run as the group and the + group's permissions are used for data access. Setting + this field requires being a member of the group, or + having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -8485,14 +8606,6 @@ paths: description: >- An optional name for the run. The default value is ``Untitled``. - tags: - type: object - description: >- - A map of tags associated with the one-time run, handled - identically to job-level tags. The tags are forwarded to the - cluster as cluster tags for the run's compute, attributed in - billing, and surfaced in system tables. A maximum of 25 tags - can be added. tasks: type: array items: @@ -8500,275 +8613,6 @@ paths: properties: task_key: type: string - agentic_task: - type: object - properties: - context: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: >- - Optional. Conversation IDs to load as context - for the agent. - instructions: - type: array - items: - type: string - description: >- - Optional. Additional instructions to guide the - agent's behavior. - description: >- - Optional. Context input providing conversation - history and instructions. - genie_code_api: - type: object - properties: {} - description: >- - Inline Genie Code conversation driven by a single - prompt. Mutually exclusive with the supervisor - variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) instead. Kept - for backwards compatibility with existing callers; - will be removed in a future revision. - input: - type: string - description: >- - Optional. The user query / task input the agent - must accomplish. Mirrors the OpenAI Responses API - ``input`` field. Replaces the deprecated ``goal`` - field; new callers should populate ``input`` going - forward. - output_schema: - type: object - properties: - properties: - type: object - description: Map of property name to property definition. - description: >- - Optional. JSON-Schema-style declaration of the - structured output the agent should produce. - Replaces the deprecated ``task_output_schema`` - map; new callers should populate ``output_schema`` - going forward. - supervisor_agent: - type: object - properties: - agent_id: - type: string - description: >- - Required. The ID of the supervisor agent - (tile_id). - description: >- - A Supervisor Agent that orchestrates sub-agents - and tools, referenced by tile_id. - supervisor_api: - type: object - properties: - instructions: - type: string - description: >- - Optional. System instructions that guide how - the supervisor routes queries across tools and - synthesizes responses. - model: - type: string - description: >- - Required. Databricks-provided FMAPI model, - e.g. "databricks-claude-sonnet-4-5". - tools: - type: array - items: - type: object - properties: - app: - type: object - properties: - name: - type: string - description: >- - Databricks App tool config. Set when the - discriminator == "app". - catalog: - type: object - properties: - name: - type: string - description: >- - Unity Catalog catalog tool config. Set - when the discriminator == "catalog". - dashboard: - type: object - properties: - dashboard_id: - type: string - description: >- - Lakeview dashboard tool config. Set when - the discriminator == "dashboard". - description: - type: string - description: >- - Optional. Free-form description of the - tool. - genie_space: - type: object - properties: - space_id: - type: string - description: >- - Genie space tool config. Set when the - discriminator == "genie_space". - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - description: >- - Knowledge Assistant tool config. Set - when the discriminator == - "knowledge_assistant". - schema: - type: object - properties: - name: - type: string - description: >- - Unity Catalog schema tool config. Set - when the discriminator == "schema". - serving_endpoint: - type: object - properties: - name: - type: string - description: >- - Model serving endpoint tool config. Set - when the discriminator == - "serving_endpoint". - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: >- - Supervisor Agent tool config (a - supervisor agent used as a tool). Set - when the discriminator == - "supervisor_agent". - table: - type: object - properties: - name: - type: string - description: >- - Unity Catalog table tool config. Set - when the discriminator == "table". - tool_type: - type: string - uc_connection: - type: object - properties: - name: - type: string - description: >- - External MCP / UC connection tool - config. Set when the discriminator == - "uc_connection". - uc_function: - type: object - properties: - name: - type: string - description: >- - Unity Catalog function tool config. Set - when the discriminator == "uc_function". - uc_mcp: - type: object - properties: - name: - type: string - description: >- - UC-registered MCP service tool config. - Set when the discriminator == "uc_mcp". - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Vector Search index tool config. Set - when the discriminator == - "vector_search_index". - volume: - type: object - properties: - name: - type: string - description: >- - Unity Catalog volume tool config. Set - when the discriminator == "volume". - web_search: - type: object - properties: {} - description: >- - Web search tool config. Set when the - discriminator == "web_search". - description: >- - Tool configuration for an inlined agentic - task agent. Discriminator selects which - per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - description: Optional. The tools the inlined agent can use. - description: >- - Inlined Responses-API supervisor configuration - (model + instructions + tools). Mutually exclusive - with ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field 8) - instead. Kept for backwards compatibility with - existing callers; will be removed in a future - revision. - trace_destination: - type: object - properties: - catalog_name: - type: string - description: >- - Unity Catalog catalog name for the trace - table. - experiment_id: - type: string - description: MLflow experiment ID where traces are written. - schema_name: - type: string - description: Unity Catalog schema name for the trace table. - table_prefix: - type: string - description: >- - Table-name prefix under - ``.``. Trace tables are - created as - ``.._<...>``. - description: >- - Optional. Where MLflow traces produced by this - task run should be persisted. When unset, traces - follow the workspace default destination. - description: Agentic Task for job-based multi-agent execution ai_runtime_task: type: object properties: @@ -8783,24 +8627,10 @@ paths: as a service principal), set ``mlflow_experiment_directory``. deployments: - type: array - items: - type: object - properties: - command_path: - type: string - description: >- - Workspace path of the script to run on each - node in this deployment. Upload the script - to this path and supply the path here. When - the task runs, the file at this path is run - on each node; if it fails, the task fails - with its exit code. Example script contents: - Plain Python: python train.py --epochs 10 - Multi-GPU via accelerate: accelerate launch - train.py --config config.yaml Distributed - via torchrun: torchrun --nproc_per_node=8 - train.py + type: array + items: + type: object + properties: compute: type: object properties: @@ -8828,20 +8658,37 @@ paths: ``GPU_8xH100`` with ``accelerator_count: 16`` allocates 2 nodes (8 GPUs per node). + provisioned_capacity_id: + type: string + description: >- + Optional ID of a pre-provisioned + accelerator capacity reservation to run + this AI Runtime workload on. When set, + the workload is scheduled onto the + referenced reserved capacity instead of + the on-demand capacity shared among all + Databricks customers. required: - accelerator_type - accelerator_count description: >- Compute resources allocated to each node in this deployment. - docker_image_url: + command_path: type: string description: >- - Optional Docker image URL for a custom - container image. When set, the task runs on - the specified container image instead of the - default Databricks client image. Format: - ``{organization}/{repository}:{tag}`` + Workspace path of the script to run on each + node in this deployment. Upload the script + to this path and supply the path here. When + the task runs, the file at this path is run + on each node; if it fails, the task fails + with its exit code. Example script contents: + .. code-block:: bash # Plain Python: python + train.py --epochs 10 # Multi-GPU via + accelerate: accelerate launch train.py + --config config.yaml # Distributed via + torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -8852,7 +8699,6 @@ paths: recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one deployment @@ -8884,6 +8730,17 @@ paths: container image instead of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow artifacts logged + by the run. If this field isn't specified the + default artifact location will be in dbfs i.e. + ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is preferred + this can be a custom location in UC: + ``dbfs:/Volumes////...`` + The location should be unique for each experiment. mlflow_experiment_directory: type: string description: >- @@ -8899,20 +8756,27 @@ paths: Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for the workload. May + only be set together with a pre-provisioned + capacity reservation (a deployment's + ``compute.provisioned_capacity_id``); it is + rejected on a workload that runs on on-demand + capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each - deployment's command. Keys are parameter names, - values the corresponding arguments (for example, - ``{"epochs": "3", "dataset": - "s3://bucket/train"}``). Values may contain - dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, which Jobs - substitutes before execution (see - ``AiRuntimeTaskResolvedValues.parameters`` in - runs.proto). + Optional Unity Catalog path for a custom container + image. When set, the task runs on the specified + container image instead of the default Databricks + client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -9087,8 +8951,121 @@ paths: subscription: type: object properties: + attachment: + type: object + properties: + data_attachment: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + page_id: + type: string + description: >- + The URL identifier of the page + containing the widget. This is the value + of the ``name`` field of the + corresponding entry under ``pages`` in + the serialized dashboard definition. + Format: alphanumeric, hyphen, and + underscore characters allowed, max + length 63. + widget_id: + type: string + description: >- + The URL identifier of the widget. This + is the value of the ``name`` field of + the corresponding widget under that + page's ``layout`` in the serialized + dashboard definition. Format: + alphanumeric, hyphen, and underscore + characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data + to attach. ``page_id`` and ``widget_id`` + are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + description: >- + The widgets whose underlying data is + exported. At least one widget must be + referenced. + file_format: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The file format of the exported tabular + data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied + filter values are included alongside the + tabular data as an additional attached + file. + required: + - widgets + - file_format + description: >- + Optional: The configuration for the + underlying data of dashboard widgets + attached as tabular data files. If not + specified, no tabular data is attached. + page_attachment: + type: object + properties: + page_ids: + type: array + items: + type: string + description: >- + The identifiers of the pages to include + in the PDF. Only specified when + ``page_selection`` is + ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the + dashboard's serialized definition + returned by the Get dashboard API + (``serialized_dashboard``): the value of + the ``name`` field of an entry under + ``pages``. Format: alphanumeric, hyphen, + and underscore characters allowed, max + length 63. + page_selection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: >- + How the attached pages are selected. + When set to ``PAGE_SELECTION_SUBSET``, + the pages to include are listed in + ``page_ids``. + description: >- + Optional: The selection of dashboard pages + included in the attached PDF. If not + specified, only the first page is + included. + description: >- + The configuration for the files attached to + the dashboard snapshot notification sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. custom_subject: type: string + description: >- + Optional: Allows users to specify a custom + subject line on the email sent to subscribers. paused: type: boolean description: >- @@ -9337,17 +9314,18 @@ paths: description: >- The key that references an environment spec in a job. This field is required for Python script, Python wheel - and dbt tasks when using serverless compute. + and dbt tasks when using serverless compute or a + compute resource that uses Environments mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry - defined in ``RunSettings.environment_variables``. The - selected entry's variables and file contents are - applied to this task at execution time. Length and - pattern mirror ``environment_key`` so the two - references look identical to customers reading task - settings. + defined in ``RunSettings.environment_variables`` for + one-time runs or preserved in + ``Run.environment_variables`` for run snapshots. The + selected entry's variables are applied to this task at + execution time. This field supports serverless tasks + using environment version 5 or later. existing_cluster_id: type: string description: >- @@ -9367,291 +9345,6 @@ paths: properties: task_key: type: string - agentic_task: - type: object - properties: - context: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: >- - Optional. Conversation IDs to load as - context for the agent. - instructions: - type: array - items: - type: string - description: >- - Optional. Additional instructions to - guide the agent's behavior. - description: >- - Optional. Context input providing - conversation history and instructions. - genie_code_api: - type: object - properties: {} - description: >- - Inline Genie Code conversation driven by a - single prompt. Mutually exclusive with the - supervisor variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) - instead. Kept for backwards compatibility - with existing callers; will be removed in - a future revision. - input: - type: string - description: >- - Optional. The user query / task input the - agent must accomplish. Mirrors the OpenAI - Responses API ``input`` field. Replaces - the deprecated ``goal`` field; new callers - should populate ``input`` going forward. - output_schema: - type: object - properties: - properties: - type: object - description: >- - Map of property name to property - definition. - description: >- - Optional. JSON-Schema-style declaration of - the structured output the agent should - produce. Replaces the deprecated - ``task_output_schema`` map; new callers - should populate ``output_schema`` going - forward. - supervisor_agent: - type: object - properties: - agent_id: - type: string - description: >- - Required. The ID of the supervisor agent - (tile_id). - description: >- - A Supervisor Agent that orchestrates - sub-agents and tools, referenced by - tile_id. - supervisor_api: - type: object - properties: - instructions: - type: string - description: >- - Optional. System instructions that guide - how the supervisor routes queries across - tools and synthesizes responses. - model: - type: string - description: >- - Required. Databricks-provided FMAPI - model, e.g. - "databricks-claude-sonnet-4-5". - tools: - type: array - items: - type: object - properties: - app: - type: object - properties: - name: - type: string - description: >- - Databricks App tool config. Set when the - discriminator == "app". - catalog: - type: object - properties: - name: - type: string - description: >- - Unity Catalog catalog tool config. Set - when the discriminator == "catalog". - dashboard: - type: object - properties: - dashboard_id: - type: string - description: >- - Lakeview dashboard tool config. Set when - the discriminator == "dashboard". - description: - type: string - description: >- - Optional. Free-form description of the - tool. - genie_space: - type: object - properties: - space_id: - type: string - description: >- - Genie space tool config. Set when the - discriminator == "genie_space". - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - description: >- - Knowledge Assistant tool config. Set - when the discriminator == - "knowledge_assistant". - schema: - type: object - properties: - name: - type: string - description: >- - Unity Catalog schema tool config. Set - when the discriminator == "schema". - serving_endpoint: - type: object - properties: - name: - type: string - description: >- - Model serving endpoint tool config. Set - when the discriminator == - "serving_endpoint". - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: >- - Supervisor Agent tool config (a - supervisor agent used as a tool). Set - when the discriminator == - "supervisor_agent". - table: - type: object - properties: - name: - type: string - description: >- - Unity Catalog table tool config. Set - when the discriminator == "table". - tool_type: - type: string - uc_connection: - type: object - properties: - name: - type: string - description: >- - External MCP / UC connection tool - config. Set when the discriminator == - "uc_connection". - uc_function: - type: object - properties: - name: - type: string - description: >- - Unity Catalog function tool config. Set - when the discriminator == "uc_function". - uc_mcp: - type: object - properties: - name: - type: string - description: >- - UC-registered MCP service tool config. - Set when the discriminator == "uc_mcp". - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Vector Search index tool config. Set - when the discriminator == - "vector_search_index". - volume: - type: object - properties: - name: - type: string - description: >- - Unity Catalog volume tool config. Set - when the discriminator == "volume". - web_search: - type: object - properties: {} - description: >- - Web search tool config. Set when the - discriminator == "web_search". - description: >- - Tool configuration for an inlined - agentic task agent. Discriminator - selects which per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - description: >- - Optional. The tools the inlined agent - can use. - description: >- - Inlined Responses-API supervisor - configuration (model + instructions + - tools). Mutually exclusive with - ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field - 8) instead. Kept for backwards - compatibility with existing callers; will - be removed in a future revision. - trace_destination: - type: object - properties: - catalog_name: - type: string - description: >- - Unity Catalog catalog name for the trace - table. - experiment_id: - type: string - description: >- - MLflow experiment ID where traces are - written. - schema_name: - type: string - description: >- - Unity Catalog schema name for the trace - table. - table_prefix: - type: string - description: >- - Table-name prefix under - ``.``. Trace tables are - created as - ``.._<...>``. - description: >- - Optional. Where MLflow traces produced by - this task run should be persisted. When - unset, traces follow the workspace default - destination. - description: >- - Agentic Task for job-based multi-agent - execution ai_runtime_task: type: object properties: @@ -9671,21 +9364,6 @@ paths: items: type: object properties: - command_path: - type: string - description: >- - Workspace path of the script to run on - each node in this deployment. Upload the - script to this path and supply the path - here. When the task runs, the file at - this path is run on each node; if it - fails, the task fails with its exit - code. Example script contents: Plain - Python: python train.py --epochs 10 - Multi-GPU via accelerate: accelerate - launch train.py --config config.yaml - Distributed via torchrun: torchrun - --nproc_per_node=8 train.py compute: type: object properties: @@ -9713,21 +9391,38 @@ paths: ``GPU_8xH100`` with ``accelerator_count: 16`` allocates 2 nodes (8 GPUs per node). + provisioned_capacity_id: + type: string + description: >- + Optional ID of a pre-provisioned + accelerator capacity reservation to run + this AI Runtime workload on. When set, + the workload is scheduled onto the + referenced reserved capacity instead of + the on-demand capacity shared among all + Databricks customers. required: - accelerator_type - accelerator_count description: >- Compute resources allocated to each node in this deployment. - docker_image_url: + command_path: type: string description: >- - Optional Docker image URL for a custom - container image. When set, the task runs - on the specified container image instead - of the default Databricks client image. - Format: - ``{organization}/{repository}:{tag}`` + Workspace path of the script to run on + each node in this deployment. Upload the + script to this path and supply the path + here. When the task runs, the file at + this path is run on each node; if it + fails, the task fails with its exit + code. Example script contents: .. + code-block:: bash # Plain Python: python + train.py --epochs 10 # Multi-GPU via + accelerate: accelerate launch train.py + --config config.yaml # Distributed via + torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -9738,7 +9433,6 @@ paths: recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one @@ -9774,6 +9468,20 @@ paths: of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow + artifacts logged by the run. If this field + isn't specified the default artifact + location will be in dbfs i.e. + ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is + preferred this can be a custom location in + UC: + ``dbfs:/Volumes////...`` + The location should be unique for each + experiment. mlflow_experiment_directory: type: string description: >- @@ -9791,21 +9499,29 @@ paths: Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for the + workload. May only be set together with a + pre-provisioned capacity reservation (a + deployment's + ``compute.provisioned_capacity_id``); it + is rejected on a workload that runs on + on-demand capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each - deployment's command. Keys are parameter - names, values the corresponding arguments - (for example, ``{"epochs": "3", "dataset": - "s3://bucket/train"}``). Values may - contain dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, - which Jobs substitutes before execution - (see - ``AiRuntimeTaskResolvedValues.parameters`` - in runs.proto). + Optional Unity Catalog path for a custom + container image. When set, the task runs + on the specified container image instead + of the default Databricks client image. + Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -10000,8 +9716,123 @@ paths: subscription: type: object properties: + attachment: + type: object + properties: + data_attachment: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + page_id: + type: string + description: >- + The URL identifier of the page + containing the widget. This is the value + of the ``name`` field of the + corresponding entry under ``pages`` in + the serialized dashboard definition. + Format: alphanumeric, hyphen, and + underscore characters allowed, max + length 63. + widget_id: + type: string + description: >- + The URL identifier of the widget. This + is the value of the ``name`` field of + the corresponding widget under that + page's ``layout`` in the serialized + dashboard definition. Format: + alphanumeric, hyphen, and underscore + characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data + to attach. ``page_id`` and ``widget_id`` + are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + description: >- + The widgets whose underlying data is + exported. At least one widget must be + referenced. + file_format: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The file format of the exported tabular + data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied + filter values are included alongside the + tabular data as an additional attached + file. + required: + - widgets + - file_format + description: >- + Optional: The configuration for the + underlying data of dashboard widgets + attached as tabular data files. If not + specified, no tabular data is attached. + page_attachment: + type: object + properties: + page_ids: + type: array + items: + type: string + description: >- + The identifiers of the pages to include + in the PDF. Only specified when + ``page_selection`` is + ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the + dashboard's serialized definition + returned by the Get dashboard API + (``serialized_dashboard``): the value of + the ``name`` field of an entry under + ``pages``. Format: alphanumeric, hyphen, + and underscore characters allowed, max + length 63. + page_selection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: >- + How the attached pages are selected. + When set to ``PAGE_SELECTION_SUBSET``, + the pages to include are listed in + ``page_ids``. + description: >- + Optional: The selection of dashboard + pages included in the attached PDF. If + not specified, only the first page is + included. + description: >- + The configuration for the files attached + to the dashboard snapshot notification + sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. custom_subject: type: string + description: >- + Optional: Allows users to specify a + custom subject line on the email sent to + subscribers. paused: type: boolean description: >- @@ -10274,18 +10105,18 @@ paths: The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using - serverless compute. + serverless compute or a compute resource that + uses Environments mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in ``JobSettings.environment_variables``. The - selected entry's variables and file contents - are applied to this task at execution time. - Length and pattern mirror ``environment_key`` - so the two references look identical to - customers reading task settings. + selected entry's variables are applied to this + task at execution time. This field supports + serverless tasks using environment version 5 + or later. existing_cluster_id: type: string description: >- @@ -10308,25 +10139,6 @@ paths: dl_runtime_image: type: string description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) - that submitted this task. Used by handlers - to gate behavior or reject incompatible - versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the - user's workspace contents. When set, the - entry script extracts the tarball into the - working directory before running the - training script, so the training script - can import sibling modules and read - packaged data files. Must be a workspace - path (e.g. ``/Workspace/Users/...``) or - volume; ``dbfs:/`` is not supported. command: type: string description: >- @@ -10345,13 +10157,6 @@ paths: description: GPU type. required: - num_gpus - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL - for running the training script. Format: - organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- @@ -10359,26 +10164,6 @@ paths: MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run - created for this task. If unset, MLflow - auto-generates a name. Used alongside - ``mlflow_experiment_name`` to identify the - run in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file - describing pip dependencies to install - before running the training script. - Consumed by the entry script; format - matches the runtime requirements.yaml - convention used by sgcli. Must be a - workspace path (e.g. - ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. source: type: string x-enum: @@ -10430,17 +10215,6 @@ paths: ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - genie_task: - type: object - properties: - configuration_id: - type: string - description: >- - Required. Resource name of the agent task - configuration to run. - required: - - configuration_id - description: Runs a Genie or Genie Code agent task. health: type: object properties: @@ -10680,75 +10454,6 @@ paths: properties: connection_resource_name: type: string - incremental_refresh_config: - type: object - properties: - archive_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the archive window. - Default: MONTH - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window - (total data retained). Must be greater - than the refresh window when using the - same granularity. Default: 3 (with YEAR - granularity = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether - data has changed in each partition - before reimporting. Partitions with - unchanged data are skipped, reducing - refresh cost further. Uses - MAX(datetime_column) as the change - detector. - mode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: >- - The refresh policy mode. Hybrid adds a - real-time DirectQuery partition for the - most recent data; Import uses only - batch-imported partitions. Default: - HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods - (e.g., skip today's partial data). - refresh_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the refresh window. - Default: DAY - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh - window. Partitions within this window - are re-imported on each refresh. - Default: 1 - description: >- - Incremental refresh policy applied to all - IMPORT mode tables in the model. Windows - and mode are shared; partition columns are - set per-table on PowerBiTable. power_bi_model: type: object properties: @@ -10846,15 +10551,6 @@ paths: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental - refresh partitioning on this table. - e.g., "order_date", "updated_at" Only - applicable when the task has - incremental_refresh_config set and this - table uses IMPORT storage mode. name: type: string description: The table name in Databricks @@ -10868,25 +10564,6 @@ paths: - DUAL - IMPORT description: The Power BI storage mode of the table - table_type: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of this - table. When set, the server trusts it to - classify the table during metric-view - filtering and skips the server-side - lookup. When unset, the server resolves - the type on its own. description: The tables to be exported to Power BI warehouse_id: type: string @@ -11512,24 +11189,7 @@ paths: properties: dl_runtime_image: type: string - description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) that - submitted this task. Used by handlers to gate - behavior or reject incompatible versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the user's - workspace contents. When set, the entry script - extracts the tarball into the working directory - before running the training script, so the - training script can import sibling modules and - read packaged data files. Must be a workspace path - (e.g. ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. + description: Runtime image command: type: string description: >- @@ -11548,13 +11208,6 @@ paths: description: GPU type. required: - num_gpus - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL for - running the training script. Format: - organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- @@ -11562,24 +11215,6 @@ paths: experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run created - for this task. If unset, MLflow auto-generates a - name. Used alongside ``mlflow_experiment_name`` to - identify the run in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file - describing pip dependencies to install before - running the training script. Consumed by the entry - script; format matches the runtime - requirements.yaml convention used by sgcli. Must - be a workspace path (e.g. - ``/Workspace/Users/...``) or volume; ``dbfs:/`` is - not supported. source: type: string x-enum: @@ -11626,17 +11261,6 @@ paths: ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - genie_task: - type: object - properties: - configuration_id: - type: string - description: >- - Required. Resource name of the agent task - configuration to run. - required: - - configuration_id - description: Runs a Genie or Genie Code agent task. health: type: object properties: @@ -11853,71 +11477,6 @@ paths: properties: connection_resource_name: type: string - incremental_refresh_config: - type: object - properties: - archive_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the archive window. Default: - MONTH - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window (total - data retained). Must be greater than the - refresh window when using the same - granularity. Default: 3 (with YEAR granularity - = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether data has - changed in each partition before reimporting. - Partitions with unchanged data are skipped, - reducing refresh cost further. Uses - MAX(datetime_column) as the change detector. - mode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: >- - The refresh policy mode. Hybrid adds a - real-time DirectQuery partition for the most - recent data; Import uses only batch-imported - partitions. Default: HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods (e.g., - skip today's partial data). - refresh_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the refresh window. Default: - DAY - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh - window. Partitions within this window are - re-imported on each refresh. Default: 1 - description: >- - Incremental refresh policy applied to all IMPORT - mode tables in the model. Windows and mode are - shared; partition columns are set per-table on - PowerBiTable. power_bi_model: type: object properties: @@ -12011,14 +11570,6 @@ paths: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental - refresh partitioning on this table. e.g., - "order_date", "updated_at" Only applicable - when the task has incremental_refresh_config - set and this table uses IMPORT storage mode. name: type: string description: The table name in Databricks @@ -12032,24 +11583,6 @@ paths: - DUAL - IMPORT description: The Power BI storage mode of the table - table_type: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of this table. - When set, the server trusts it to classify - the table during metric-view filtering and - skips the server-side lookup. When unset, - the server resolves the type on its own. description: The tables to be exported to Power BI warehouse_id: type: string @@ -12866,7 +12399,9 @@ paths: An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of ``schedule`` and - ``continuous`` can be used. + ``continuous`` can be used. Pipelines started by a + continuous job also run continuously, regardless of + their own pipeline mode setting. deployment: type: object properties: @@ -12908,6 +12443,16 @@ paths: description: >- An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for + a Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be + one of the supported values: ``NO_FLEXIBILITY``, ``4h``, + ``12h``, ``24h``, ``72h``. ``NO_FLEXIBILITY`` means the + run uses the default cost-optimized performance level + without additional cost-saving optimizations. edit_mode: type: string x-enum: @@ -13014,80 +12559,62 @@ paths: ``JobSettings.environment_variables``. Tasks reference it from ``TaskSettings.environment_variables_key``. - files: - type: array - items: - type: string - description: >- - Workspace (``/Workspace/...``) or UC Volumes - (``/Volumes/...``) paths to ``.env`` files. - Maximum 5 files. Files are read, parsed, and - merged at task execution time, not at job creation - or update API call time. File format: each line - must be exactly ``KEY=VALUE``. Keys must match the - same regex as inlined variable names - (``^[A-Za-z_][A-Za-z0-9_]*$``); the value - continues to the end of the line. No other syntax - is supported — no comments, no quoted values, no - escape sequences, no variable interpolation. Any - line that does not match the ``KEY=VALUE`` shape - fails the run. Size limits: maximum 1,048,576 - bytes (1 MiB) per file on disk; maximum 131,072 - bytes (128 KiB) per ``KEY=VALUE`` line combined. - Caps are enforced at read time in jobs-runner — - files exceeding the per-file cap, or lines - exceeding the per-line cap, fail the run. On a - duplicate key, the later file wins; ``variables`` - override values from any file. Values may contain - {{secrets/scope/key}} references; those are - resolved at task execution time and never - persisted in resolved form. Do not use these files - to store raw secret values; consult `secret - management - `__ - for the right way to pass sensitive values. - variables: + spec: type: object - description: >- - Environment variables specified directly as - key/value pairs (as opposed to ``files``, which - are read from ``.env`` file paths). Maximum 100 - entries. Each key must match - ``^[A-Za-z_][A-Za-z0-9_]*$`` and be 1 to 256 - characters long. Each value is up to 512 - characters; larger values should be moved into a - ``.env`` file referenced from ``files``. On a - duplicate key, ``variables`` override values from - any file in ``files``. Values may contain - {{secrets/scope/key}} references; those are - resolved at task execution time and never - persisted in resolved form. Do not use this field - to store a raw secret value; consult `secret - management - `__ - for the right way to pass sensitive values. + properties: + files: + type: array + items: + type: string + description: >- + Workspace (``/Workspace/...``) or UC Volumes + (``/Volumes/...``) paths to ``.env`` files. + Maximum 5 files. Files are read, parsed, and + merged at task execution time, not at job + creation or update API call time. File format: + each line containing a variable must be + exactly ``KEY=VALUE``. Empty and + whitespace-only lines, and lines beginning + with ``#``, are ignored. Keys must match the + same regex as inlined variable names + (``^[A-Za-z_][A-Za-z0-9_]*$``); the value + continues to the end of the line. No other + syntax is supported — no inline comments, no + quoted values, no escape sequences, no + variable interpolation. Any other line that + does not match the ``KEY=VALUE`` shape fails + the run. Size limits: maximum 32,768 bytes (32 + KiB) per file on disk; maximum 1,024 bytes (1 + KiB) per ``KEY=VALUE`` line combined. Files or + lines exceeding these limits fail the run. On + a duplicate key, the later file wins; + ``variables`` override values from any file. + variables: + type: object + description: >- + Environment variables specified directly as + key/value pairs. Maximum 20 entries. Each key + must be 1 to 256 characters and match + ``^[A-Za-z_][A-Za-z0-9_]*$``: it must start + with an ASCII letter or underscore and contain + only ASCII letters, digits, and underscores. + Each value can be any Unicode string of up to + 512 characters, including an empty string. + description: The environment variable specification. + required: + - environment_variables_key description: >- A named environment-variable entry, defined once at the job level and referenced by key from one or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via ``TaskSettings.environment_variables_key``. - - Precedence within a single entry (later overrides earlier on duplicate keys): - - files (merged in submitted order; later file in the list wins) └─▶ variables (inline k/v - override file contents) └─▶ runtime (os.environ / sys.env — overrides all, - classic-parity) - - Resolved values are never persisted: ``{{secrets/scope/key}}`` references in ``variables`` or in - ``files`` contents are stored verbatim and resolved at task execution time on the DP . description: >- Named environment-variable entries that tasks can reference by key from - ``TaskSettings.environment_variables_key``. Each entry - holds inline ``variables`` plus optional ``.env`` - ``files``. Maximum 10 entries per job. Entries are - independent of one another — there is no cross-entry - merging. + ``TaskSettings.environment_variables_key``. Each entry's + ``spec`` holds inline ``variables`` and optional + ``.env`` ``files``. Maximum 10 entries per job. A task + can reference at most one entry from this list. environments: type: array items: @@ -13101,13 +12628,17 @@ paths: - environment_key description: >- A list of task execution environment specifications that - can be referenced by serverless tasks of this job. For - serverless notebook tasks, if the environment_key is not - specified, the notebook environment will be used if - present. If a jobs environment is specified, it will - override the notebook environment. For other serverless - tasks, the task environment is required to be specified - using environment_key in the task settings. + can be referenced by tasks that use serverless compute + or a compute resource that uses Environments mode. For + notebook tasks that use serverless compute or a compute + resource that uses Environments mode, if the + environment_key is not specified, the notebook + environment will be used if present. If a jobs + environment is specified, it will override the notebook + environment. For other tasks that use serverless compute + or a compute resource that uses Environments mode, the + task environment is required to be specified using + environment_key in the task settings. format: type: string x-enum: @@ -13311,7 +12842,6 @@ paths: tasks bound to this cluster. required: - job_cluster_key - - new_cluster description: >- A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be @@ -13383,10 +12913,13 @@ paths: determines the level of compute performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless GPU compute. - - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: - Prioritizes fast startup and execution times through - rapid scaling and optimized cluster performance. + ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and + execution times through rapid scaling and optimized + cluster performance. - ``STANDARD``: Enables + cost-efficient execution of serverless workloads. - + ``COST_OPTIMIZED``: Enables lower job costs by + optimizing compute for your selected target duration + time. Must provide a duration target. queue: type: object properties: @@ -13402,8 +12935,11 @@ paths: type: string description: >- Group name of an account group assigned to the - workspace. Setting this field requires being a - member of the group. + workspace. When set, all tasks run as the group and + the group's permissions are used for data access. + Setting this field requires being a member of the + group, or having the ``Assume`` permission on the + group. service_principal_name: type: string description: >- @@ -13422,359 +12958,81 @@ paths: find the value in all cases, explicit or implicit, use ``run_as_user_name``. schedule: - type: object - properties: - quartz_cron_expression: - type: string - timezone_id: - type: string - description: >- - A Java timezone ID. The schedule for a job is - resolved with respect to this timezone. See `Java - TimeZone - `__ - for details. This field is required. - pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: Indicate whether this schedule is paused or not. - sql_condition: - type: object - properties: - sql_query_id: - type: string - warehouse_id: - type: string - description: >- - The canonical identifier of the SQL warehouse to - run the condition query against. - trigger_mode: - type: string - x-enum: - - QUERY_RETURNS_ROWS - - RESULT_VALUE_CHANGES - description: >- - Determines how the SQL query result is - interpreted to decide whether the condition - fires. Must be set to a recognized value when - provided. When unset on an existing serialized - configuration, the server preserves the original - semantics by interpreting it as - ``QUERY_RETURNS_ROWS``. New configurations - should set this explicitly — explicit - ``SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`` is - rejected at validation. - required: - - sql_query_id - - warehouse_id - description: >- - SQL condition that must be satisfied before a - scheduled run is triggered. The condition is - evaluated after the cron expression fires and must - return a truthy result for the run to proceed. - required: - - quartz_cron_expression - - timezone_id - description: >- - An optional periodic schedule for this job. The default - behavior is that the job only runs when triggered by - clicking “Run Now” in the Jobs UI or sending an API - request to ``runNow``. - tags: - type: object - description: >- - A map of tags associated with the job. These are - forwarded to the cluster as cluster tags for jobs - clusters, and are subject to the same limitations as - cluster tags. A maximum of 25 tags can be added to the - job. - tasks: - type: array - items: - type: object - properties: - task_key: - type: string - agentic_task: - type: object - properties: - context: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: >- - Optional. Conversation IDs to load as - context for the agent. - instructions: - type: array - items: - type: string - description: >- - Optional. Additional instructions to guide - the agent's behavior. - description: >- - Optional. Context input providing conversation - history and instructions. - genie_code_api: - type: object - properties: {} - description: >- - Inline Genie Code conversation driven by a - single prompt. Mutually exclusive with the - supervisor variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) instead. - Kept for backwards compatibility with existing - callers; will be removed in a future revision. - input: - type: string - description: >- - Optional. The user query / task input the - agent must accomplish. Mirrors the OpenAI - Responses API ``input`` field. Replaces the - deprecated ``goal`` field; new callers should - populate ``input`` going forward. - output_schema: - type: object - properties: - properties: - type: object - description: >- - Map of property name to property - definition. - description: >- - Optional. JSON-Schema-style declaration of the - structured output the agent should produce. - Replaces the deprecated ``task_output_schema`` - map; new callers should populate - ``output_schema`` going forward. - supervisor_agent: - type: object - properties: - agent_id: - type: string - description: >- - Required. The ID of the supervisor agent - (tile_id). - description: >- - A Supervisor Agent that orchestrates - sub-agents and tools, referenced by tile_id. - supervisor_api: - type: object - properties: - instructions: - type: string - description: >- - Optional. System instructions that guide - how the supervisor routes queries across - tools and synthesizes responses. - model: - type: string - description: >- - Required. Databricks-provided FMAPI model, - e.g. "databricks-claude-sonnet-4-5". - tools: - type: array - items: - type: object - properties: - app: - type: object - properties: - name: - type: string - description: >- - Databricks App tool config. Set when the - discriminator == "app". - catalog: - type: object - properties: - name: - type: string - description: >- - Unity Catalog catalog tool config. Set - when the discriminator == "catalog". - dashboard: - type: object - properties: - dashboard_id: - type: string - description: >- - Lakeview dashboard tool config. Set when - the discriminator == "dashboard". - description: - type: string - description: >- - Optional. Free-form description of the - tool. - genie_space: - type: object - properties: - space_id: - type: string - description: >- - Genie space tool config. Set when the - discriminator == "genie_space". - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - description: >- - Knowledge Assistant tool config. Set - when the discriminator == - "knowledge_assistant". - schema: - type: object - properties: - name: - type: string - description: >- - Unity Catalog schema tool config. Set - when the discriminator == "schema". - serving_endpoint: - type: object - properties: - name: - type: string - description: >- - Model serving endpoint tool config. Set - when the discriminator == - "serving_endpoint". - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: >- - Supervisor Agent tool config (a - supervisor agent used as a tool). Set - when the discriminator == - "supervisor_agent". - table: - type: object - properties: - name: - type: string - description: >- - Unity Catalog table tool config. Set - when the discriminator == "table". - tool_type: - type: string - uc_connection: - type: object - properties: - name: - type: string - description: >- - External MCP / UC connection tool - config. Set when the discriminator == - "uc_connection". - uc_function: - type: object - properties: - name: - type: string - description: >- - Unity Catalog function tool config. Set - when the discriminator == "uc_function". - uc_mcp: - type: object - properties: - name: - type: string - description: >- - UC-registered MCP service tool config. - Set when the discriminator == "uc_mcp". - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Vector Search index tool config. Set - when the discriminator == - "vector_search_index". - volume: - type: object - properties: - name: - type: string - description: >- - Unity Catalog volume tool config. Set - when the discriminator == "volume". - web_search: - type: object - properties: {} - description: >- - Web search tool config. Set when the - discriminator == "web_search". - description: >- - Tool configuration for an inlined - agentic task agent. Discriminator - selects which per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - description: >- - Optional. The tools the inlined agent can - use. - description: >- - Inlined Responses-API supervisor configuration - (model + instructions + tools). Mutually - exclusive with ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field 8) - instead. Kept for backwards compatibility with - existing callers; will be removed in a future - revision. - trace_destination: - type: object - properties: - catalog_name: - type: string - description: >- - Unity Catalog catalog name for the trace - table. - experiment_id: - type: string - description: >- - MLflow experiment ID where traces are - written. - schema_name: - type: string - description: >- - Unity Catalog schema name for the trace - table. - table_prefix: - type: string - description: >- - Table-name prefix under - ``.``. Trace tables are - created as - ``.._<...>``. - description: >- - Optional. Where MLflow traces produced by this - task run should be persisted. When unset, - traces follow the workspace default - destination. - description: Agentic Task for job-based multi-agent execution + type: object + properties: + quartz_cron_expression: + type: string + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule for a job is + resolved with respect to this timezone. See `Java + TimeZone + `__ + for details. This field is required. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: Indicate whether this schedule is paused or not. + sql_condition: + type: object + properties: + sql_query_id: + type: string + warehouse_id: + type: string + description: >- + The canonical identifier of the SQL warehouse to + run the condition query against. + trigger_mode: + type: string + x-enum: + - QUERY_RETURNS_ROWS + - RESULT_VALUE_CHANGES + description: >- + Determines how the SQL query result is + interpreted to decide whether the condition + fires. Must be set to a recognized value when + provided. When unset on an existing serialized + configuration, the server preserves the original + semantics by interpreting it as + ``QUERY_RETURNS_ROWS``. New configurations + should set this explicitly — explicit + ``SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`` is + rejected at validation. + required: + - sql_query_id + - warehouse_id + description: >- + SQL condition that must be satisfied before a + scheduled run is triggered. The condition is + evaluated after the cron expression fires and must + return a truthy result for the run to proceed. + required: + - quartz_cron_expression + - timezone_id + description: >- + An optional periodic schedule for this job. The default + behavior is that the job only runs when triggered by + clicking “Run Now” in the Jobs UI or sending an API + request to ``runNow``. + tags: + type: object + description: >- + A map of tags associated with the job. These are + forwarded to the cluster as cluster tags for jobs + clusters, and are subject to the same limitations as + cluster tags. A maximum of 25 tags can be added to the + job. + tasks: + type: array + items: + type: object + properties: + task_key: + type: string ai_runtime_task: type: object properties: @@ -13793,21 +13051,6 @@ paths: items: type: object properties: - command_path: - type: string - description: >- - Workspace path of the script to run on - each node in this deployment. Upload the - script to this path and supply the path - here. When the task runs, the file at - this path is run on each node; if it - fails, the task fails with its exit - code. Example script contents: Plain - Python: python train.py --epochs 10 - Multi-GPU via accelerate: accelerate - launch train.py --config config.yaml - Distributed via torchrun: torchrun - --nproc_per_node=8 train.py compute: type: object properties: @@ -13835,21 +13078,38 @@ paths: ``GPU_8xH100`` with ``accelerator_count: 16`` allocates 2 nodes (8 GPUs per node). + provisioned_capacity_id: + type: string + description: >- + Optional ID of a pre-provisioned + accelerator capacity reservation to run + this AI Runtime workload on. When set, + the workload is scheduled onto the + referenced reserved capacity instead of + the on-demand capacity shared among all + Databricks customers. required: - accelerator_type - accelerator_count description: >- Compute resources allocated to each node in this deployment. - docker_image_url: + command_path: type: string description: >- - Optional Docker image URL for a custom - container image. When set, the task runs - on the specified container image instead - of the default Databricks client image. - Format: - ``{organization}/{repository}:{tag}`` + Workspace path of the script to run on + each node in this deployment. Upload the + script to this path and supply the path + here. When the task runs, the file at + this path is run on each node; if it + fails, the task fails with its exit + code. Example script contents: .. + code-block:: bash # Plain Python: python + train.py --epochs 10 # Multi-GPU via + accelerate: accelerate launch train.py + --config config.yaml # Distributed via + torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -13860,7 +13120,6 @@ paths: recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one @@ -13894,6 +13153,19 @@ paths: the specified container image instead of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow artifacts + logged by the run. If this field isn't + specified the default artifact location will + be in dbfs i.e. + ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is + preferred this can be a custom location in UC: + ``dbfs:/Volumes////...`` + The location should be unique for each + experiment. mlflow_experiment_directory: type: string description: >- @@ -13910,20 +13182,28 @@ paths: Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for the workload. + May only be set together with a + pre-provisioned capacity reservation (a + deployment's + ``compute.provisioned_capacity_id``); it is + rejected on a workload that runs on on-demand + capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each - deployment's command. Keys are parameter - names, values the corresponding arguments (for - example, ``{"epochs": "3", "dataset": - "s3://bucket/train"}``). Values may contain - dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, which - Jobs substitutes before execution (see - ``AiRuntimeTaskResolvedValues.parameters`` in - runs.proto). + Optional Unity Catalog path for a custom + container image. When set, the task runs on + the specified container image instead of the + default Databricks client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -14103,8 +13383,123 @@ paths: subscription: type: object properties: + attachment: + type: object + properties: + data_attachment: + type: object + properties: + widgets: + type: array + items: + type: object + properties: + page_id: + type: string + description: >- + The URL identifier of the page + containing the widget. This is the value + of the ``name`` field of the + corresponding entry under ``pages`` in + the serialized dashboard definition. + Format: alphanumeric, hyphen, and + underscore characters allowed, max + length 63. + widget_id: + type: string + description: >- + The URL identifier of the widget. This + is the value of the ``name`` field of + the corresponding widget under that + page's ``layout`` in the serialized + dashboard definition. Format: + alphanumeric, hyphen, and underscore + characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data + to attach. ``page_id`` and ``widget_id`` + are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + description: >- + The widgets whose underlying data is + exported. At least one widget must be + referenced. + file_format: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The file format of the exported tabular + data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied + filter values are included alongside the + tabular data as an additional attached + file. + required: + - widgets + - file_format + description: >- + Optional: The configuration for the + underlying data of dashboard widgets + attached as tabular data files. If not + specified, no tabular data is attached. + page_attachment: + type: object + properties: + page_ids: + type: array + items: + type: string + description: >- + The identifiers of the pages to include + in the PDF. Only specified when + ``page_selection`` is + ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the + dashboard's serialized definition + returned by the Get dashboard API + (``serialized_dashboard``): the value of + the ``name`` field of an entry under + ``pages``. Format: alphanumeric, hyphen, + and underscore characters allowed, max + length 63. + page_selection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: >- + How the attached pages are selected. + When set to ``PAGE_SELECTION_SUBSET``, + the pages to include are listed in + ``page_ids``. + description: >- + Optional: The selection of dashboard + pages included in the attached PDF. If + not specified, only the first page is + included. + description: >- + The configuration for the files attached + to the dashboard snapshot notification + sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. custom_subject: type: string + description: >- + Optional: Allows users to specify a custom + subject line on the email sent to + subscribers. paused: type: boolean description: >- @@ -14369,17 +13764,17 @@ paths: The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless - compute. + compute or a compute resource that uses + Environments mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in ``JobSettings.environment_variables``. - The selected entry's variables and file contents - are applied to this task at execution time. Length - and pattern mirror ``environment_key`` so the two - references look identical to customers reading - task settings. + The selected entry's variables are applied to this + task at execution time. This field supports + serverless tasks using environment version 5 or + later. existing_cluster_id: type: string description: >- @@ -14419,24 +13814,6 @@ paths: dl_runtime_image: type: string description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) that - submitted this task. Used by handlers to gate - behavior or reject incompatible versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the - user's workspace contents. When set, the entry - script extracts the tarball into the working - directory before running the training script, - so the training script can import sibling - modules and read packaged data files. Must be - a workspace path (e.g. - ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. command: type: string description: >- @@ -14455,13 +13832,6 @@ paths: description: GPU type. required: - num_gpus - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL for - running the training script. Format: - organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- @@ -14469,25 +13839,6 @@ paths: MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run - created for this task. If unset, MLflow - auto-generates a name. Used alongside - ``mlflow_experiment_name`` to identify the run - in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file - describing pip dependencies to install before - running the training script. Consumed by the - entry script; format matches the runtime - requirements.yaml convention used by sgcli. - Must be a workspace path (e.g. - ``/Workspace/Users/...``) or volume; - ``dbfs:/`` is not supported. source: type: string x-enum: @@ -14536,17 +13887,6 @@ paths: ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - genie_task: - type: object - properties: - configuration_id: - type: string - description: >- - Required. Resource name of the agent task - configuration to run. - required: - - configuration_id - description: Runs a Genie or Genie Code agent task. health: type: object properties: @@ -14778,72 +14118,6 @@ paths: properties: connection_resource_name: type: string - incremental_refresh_config: - type: object - properties: - archive_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the archive window. - Default: MONTH - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window - (total data retained). Must be greater - than the refresh window when using the - same granularity. Default: 3 (with YEAR - granularity = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether data - has changed in each partition before - reimporting. Partitions with unchanged - data are skipped, reducing refresh cost - further. Uses MAX(datetime_column) as the - change detector. - mode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: >- - The refresh policy mode. Hybrid adds a - real-time DirectQuery partition for the - most recent data; Import uses only - batch-imported partitions. Default: HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods - (e.g., skip today's partial data). - refresh_window_granularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: >- - Granularity for the refresh window. - Default: DAY - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh - window. Partitions within this window are - re-imported on each refresh. Default: 1 - description: >- - Incremental refresh policy applied to all - IMPORT mode tables in the model. Windows and - mode are shared; partition columns are set - per-table on PowerBiTable. power_bi_model: type: object properties: @@ -14941,15 +14215,6 @@ paths: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental - refresh partitioning on this table. - e.g., "order_date", "updated_at" Only - applicable when the task has - incremental_refresh_config set and this - table uses IMPORT storage mode. name: type: string description: The table name in Databricks @@ -14963,25 +14228,6 @@ paths: - DUAL - IMPORT description: The Power BI storage mode of the table - table_type: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of this - table. When set, the server trusts it to - classify the table during metric-view - filtering and skips the server-side - lookup. When unset, the server resolves - the type on its own. description: The tables to be exported to Power BI warehouse_id: type: string @@ -15763,36 +15009,346 @@ paths: type: array items: type: string - condition: - type: string - x-enum: - - ALL_UPDATED - - ANY_UPDATED - description: >- - The table(s) condition based on which to trigger - a job run. - min_time_between_triggers_seconds: - type: integer - description: >- - If set, the trigger starts a run only after the - specified amount of time has passed since the - last time the trigger fired. The minimum allowed - value is 60 seconds. - wait_after_last_change_seconds: - type: integer - description: >- - If set, the trigger starts a run only after no - table updates have occurred for the specified - time and can be used to wait for a series of - table updates before triggering a run. The - minimum allowed value is 60 seconds. - required: - - table_names + condition: + type: string + x-enum: + - ALL_UPDATED + - ANY_UPDATED + description: >- + The table(s) condition based on which to trigger + a job run. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after the + specified amount of time has passed since the + last time the trigger fired. The minimum allowed + value is 60 seconds. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + table updates have occurred for the specified + time and can be used to wait for a series of + table updates before triggering a run. The + minimum allowed value is 60 seconds. + required: + - table_names + description: >- + A configuration to trigger a run when certain conditions + are met. The default behavior is that the job runs only + when triggered by clicking “Run Now” in the Jobs UI or + sending an API request to ``runNow``. + triggers: + type: array + items: + type: object + properties: + continuous: + type: object + properties: + maintenance_window: + type: object + properties: + start_hour: + type: integer + description: >- + An integer between 0 and 23 denoting the + start hour for the maintenance window in + the 24-hour day. Platform-initiated + maintenance is triggered only within a + one-hour window starting at this hour. + This field is required. + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + description: >- + The day of week on which maintenance is + allowed to happen. This field is required. + timezone_id: + type: string + description: >- + A Java timezone ID. The maintenance window + is resolved with respect to this timezone. + See `Java TimeZone + `__ + for details. This field is required. + required: + - start_hour + - day_of_week + - timezone_id + description: >- + Defines when platform-initiated maintenance + may run for this trigger. If unspecified, + maintenance may run at any time. + task_retry_mode: + type: string + x-enum: + - NEVER + - ON_FAILURE + description: >- + Whether the continuous job applies task-level + retries. Defaults to NEVER. + description: Continuous trigger configuration. + file_arrival: + type: object + properties: + url: + type: string + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time passed since the + last time the trigger fired. The minimum + allowed value is 60 seconds + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + file activity has occurred for the specified + amount of time. This makes it possible to wait + for a batch of incoming files to arrive before + triggering a run. The minimum allowed value is + 60 seconds. + required: + - url + description: File arrival trigger configuration. + model: + type: object + properties: + condition: + type: string + x-enum: + - MODEL_ALIAS_SET + - MODEL_CREATED + - MODEL_VERSION_READY + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know + how many members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , + ] + + + Methods can be added to enumerations, and + members can have their own + + attributes -- see the documentation for + details. + aliases: + type: array + items: + type: string + description: >- + Aliases of the model versions to monitor. Can + only be used in conjunction with condition + MODEL_ALIAS_SET. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time has passed since + the last time the trigger fired. The minimum + allowed value is 60 seconds. + securable_name: + type: string + description: >- + Name of the securable to monitor + ("mycatalog.myschema.mymodel" in the case of + model-level triggers, "mycatalog.myschema" in + the case of schema-level triggers) or empty in + the case of metastore-level triggers. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + model updates have occurred for the specified + time and can be used to wait for a series of + model updates before triggering a run. The + minimum allowed value is 60 seconds. + required: + - condition + description: Model trigger configuration. + pause_status: + type: string + x-enum: + - PAUSED + - UNPAUSED + description: >- + Whether this trigger is paused. Defaults to + UNPAUSED when unset; the server always returns an + explicit value on read. + periodic: + type: object + properties: + interval: + type: integer + unit: + type: string + x-enum: + - DAYS + - HOURS + - MINUTES + - WEEKS + description: The unit of time for the interval. + required: + - interval + - unit + description: >- + Trigger type: exactly one must be set; mutual + exclusivity is enforced in the API handler + Periodic trigger configuration. + schedule: + type: object + properties: + quartz_cron_expression: + type: string + description: >- + A Cron expression using Quartz syntax that + describes the schedule for this trigger. See + `Cron Trigger + `__ + for details. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved + with respect to this timezone. See `Java + TimeZone + `__ + for details. + required: + - quartz_cron_expression + - timezone_id + description: Cron schedule trigger configuration. + sql_condition: + type: object + properties: + sql_query_id: + type: string + warehouse_id: + type: string + description: >- + The canonical identifier of the SQL warehouse + to run the condition query against. + trigger_mode: + type: string + x-enum: + - QUERY_RETURNS_ROWS + - RESULT_VALUE_CHANGES + description: >- + Determines how the SQL query result is + interpreted to decide whether the condition + fires. Must be set to a recognized value when + provided. When unset on an existing serialized + configuration, the server preserves the + original semantics by interpreting it as + ``QUERY_RETURNS_ROWS``. New configurations + should set this explicitly — explicit + ``SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`` is + rejected at validation. + required: + - sql_query_id + - warehouse_id + description: >- + Optional SQL condition that gates whether this + trigger fires. + table_update: + type: object + properties: + table_names: + type: array + items: + type: string + condition: + type: string + x-enum: + - ALL_UPDATED + - ANY_UPDATED + description: >- + The table(s) condition based on which to + trigger a job run. + min_time_between_triggers_seconds: + type: integer + description: >- + If set, the trigger starts a run only after + the specified amount of time has passed since + the last time the trigger fired. The minimum + allowed value is 60 seconds. + wait_after_last_change_seconds: + type: integer + description: >- + If set, the trigger starts a run only after no + table updates have occurred for the specified + time and can be used to wait for a series of + table updates before triggering a run. The + minimum allowed value is 60 seconds. + required: + - table_names + description: Table update trigger configuration. + description: >- + A single trigger attached to a job via + ``JobSettings.triggers``. Exactly one of the + trigger-type + fields (``periodic``, ``schedule``, ``continuous``, ``file_arrival``, ``table_update``, + ``model``, ``job_completion``) must be set; mutual exclusivity is enforced in the API handler + rather than via ``oneof`` so that codegen, validation, and JSON serialization across SDKs and + Terraform behave consistently. description: >- - A configuration to trigger a run when certain conditions - are met. The default behavior is that the job runs only - when triggered by clicking “Run Now” in the Jobs UI or - sending an API request to ``runNow``. + List of triggers attached to this job. A run starts when + any active trigger evaluates to true. Cannot be set in + the same request as the legacy ``schedule``, + ``trigger``, or ``continuous`` fields. Gated behind the + "Multiple Triggers" feature preview. usage_policy_id: type: string description: >- @@ -16118,215 +15674,6 @@ paths: x-stackql-sdk-source: PolicyComplianceForJobsAPI components: schemas: - AgentTool: - type: object - properties: - app: - $ref: '#/components/schemas/AppTool' - description: Databricks App tool config. Set when the discriminator == "app". - catalog: - $ref: '#/components/schemas/CatalogTool' - description: >- - Unity Catalog catalog tool config. Set when the discriminator == - "catalog". - dashboard: - $ref: '#/components/schemas/DashboardTool' - description: >- - Lakeview dashboard tool config. Set when the discriminator == - "dashboard". - description: - type: string - description: Optional. Free-form description of the tool. - genie_space: - $ref: '#/components/schemas/GenieSpaceTool' - description: >- - Genie space tool config. Set when the discriminator == - "genie_space". - knowledge_assistant: - $ref: '#/components/schemas/KnowledgeAssistantTool' - description: >- - Knowledge Assistant tool config. Set when the discriminator == - "knowledge_assistant". - schema: - $ref: '#/components/schemas/SchemaTool' - description: >- - Unity Catalog schema tool config. Set when the discriminator == - "schema". - serving_endpoint: - $ref: '#/components/schemas/ServingEndpointTool' - description: >- - Model serving endpoint tool config. Set when the discriminator == - "serving_endpoint". - supervisor_agent: - $ref: '#/components/schemas/SupervisorAgentTool' - description: >- - Supervisor Agent tool config (a supervisor agent used as a tool). - Set when the discriminator == "supervisor_agent". - table: - $ref: '#/components/schemas/TableTool' - description: >- - Unity Catalog table tool config. Set when the discriminator == - "table". - tool_type: - type: string - uc_connection: - $ref: '#/components/schemas/UcConnectionTool' - description: >- - External MCP / UC connection tool config. Set when the discriminator - == "uc_connection". - uc_function: - $ref: '#/components/schemas/UcFunctionTool' - description: >- - Unity Catalog function tool config. Set when the discriminator == - "uc_function". - uc_mcp: - $ref: '#/components/schemas/UcMcpTool' - description: >- - UC-registered MCP service tool config. Set when the discriminator == - "uc_mcp". - vector_search_index: - $ref: '#/components/schemas/VectorSearchIndexTool' - description: >- - Vector Search index tool config. Set when the discriminator == - "vector_search_index". - volume: - $ref: '#/components/schemas/VolumeTool' - description: >- - Unity Catalog volume tool config. Set when the discriminator == - "volume". - web_search: - $ref: '#/components/schemas/WebSearchTool' - description: Web search tool config. Set when the discriminator == "web_search". - description: >- - Tool configuration for an inlined agentic task agent. Discriminator - selects which per-asset - config message applies (``genie_space``, ``knowledge_assistant``, ``uc_function``, - ``uc_connection``, ``uc_mcp``, ``app``, ``table``, ``vector_search_index``, ``volume``, - ``catalog``, ``schema``, ``dashboard``, ``supervisor_agent``, ``serving_endpoint``, - ``web_search``); ``description`` is a free-form top-level description; each per-asset config - carries only the asset's identifier. - - The discriminator is exposed under two interchangeable names: ``type`` mirrors the Supervisor - (Responses) API surface, and ``tool_type`` is the AIP-friendly alias for clients where ``type`` - is a reserved keyword (Terraform, etc.). Set exactly one. - AgenticTask: - type: object - properties: - context: - $ref: '#/components/schemas/AgenticTaskContext' - description: >- - Optional. Context input providing conversation history and - instructions. - genie_code_api: - $ref: '#/components/schemas/GenieCodeApi' - description: >- - Inline Genie Code conversation driven by a single prompt. Mutually - exclusive with the supervisor variants. - goal: - type: string - description: >- - Deprecated. Use ``input`` (field 7) instead. Kept for backwards - compatibility with existing callers; will be removed in a future - revision. - input: - type: string - description: >- - Optional. The user query / task input the agent must accomplish. - Mirrors the OpenAI Responses API ``input`` field. Replaces the - deprecated ``goal`` field; new callers should populate ``input`` - going forward. - output_schema: - $ref: '#/components/schemas/TaskOutputSchema' - description: >- - Optional. JSON-Schema-style declaration of the structured output the - agent should produce. Replaces the deprecated ``task_output_schema`` - map; new callers should populate ``output_schema`` going forward. - supervisor_agent: - $ref: '#/components/schemas/SupervisorAgent' - description: >- - A Supervisor Agent that orchestrates sub-agents and tools, - referenced by tile_id. - supervisor_api: - $ref: '#/components/schemas/SupervisorApi' - description: >- - Inlined Responses-API supervisor configuration (model + instructions - + tools). Mutually exclusive with ``supervisor_agent``. - task_output_schema: - type: object - description: >- - Deprecated. Use ``output_schema`` (field 8) instead. Kept for - backwards compatibility with existing callers; will be removed in a - future revision. - trace_destination: - $ref: '#/components/schemas/TraceDestination' - description: >- - Optional. Where MLflow traces produced by this task run should be - persisted. When unset, traces follow the workspace default - destination. - description: >- - Defines an agentic task configuration for job-based execution. Three - configuration paths via - ``oneof agent``: - - - Reference a pre-registered Supervisor Agent tile via ``supervisor_agent.agent_id``. - - Provide an inlined Responses-API-style config via ``supervisor_api``. - - Run an inline Genie Code prompt via ``genie_code_api``. - AgenticTaskContext: - type: object - properties: - conversation_ids: - type: array - items: - type: string - description: Optional. Conversation IDs to load as context for the agent. - instructions: - type: array - items: - type: string - description: Optional. Additional instructions to guide the agent's behavior. - description: >- - Context input for an agentic task, providing conversation history and - additional instructions to - guide the agent. - AgenticTaskOutput: - type: object - properties: - conversation_id: - type: string - description: The conversation ID generated during this task execution. - created_at: - type: number - description: Deprecated. Run timestamps are exposed on the surrounding job-run. - genie_code: - $ref: '#/components/schemas/GenieCodeOutput' - description: Genie Code execution output (conversation notebook reference). - id: - type: string - description: >- - Deprecated. Run-level identity already lives on the surrounding - ``RunOutput``; ``SupervisorOutput.response_id`` is the canonical - handle for the structured response. - response: - type: string - description: >- - Deprecated. The final text response is now surfaced in - ``task_output["response"]``; new callers should read it from there. - status: - type: string - description: >- - Deprecated. Run lifecycle state is exposed on the surrounding - job-run. - supervisor: - $ref: '#/components/schemas/SupervisorOutput' - description: Supervisor (tile or inlined) execution output. - task_output: - type: object - description: >- - Custom output values from the agent. When the caller specified a - ``task_output_schema`` / ``output_schema``, this carries those - user-defined keys. When no schema is specified, this carries default - supervisor keys (``response``, ``truncated``, ...). - description: Output returned after an agentic task completes. AiRuntimeTask: type: object properties: @@ -16361,6 +15708,15 @@ components: the task runs on the specified container image instead of the default Databricks client image. Format: ``{organization}/{repository}:{tag}`` + mlflow_artifact_location: + type: string + description: >- + Optional root location for MLflow artifacts logged by the run. If + this field isn't specified the default artifact location will be in + dbfs i.e. ``dbfs:/databricks/mlflow-tracking//...`` + If dbfs access is restricted or UC is preferred this can be a custom + location in UC: ``dbfs:/Volumes////...`` + The location should be unique for each experiment. mlflow_experiment_directory: type: string description: >- @@ -16374,17 +15730,20 @@ components: description: >- Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name. - parameters: - type: object + priority_class: + $ref: '#/components/schemas/AiRuntimeTaskPriorityClass' + description: >- + Scheduling priority class for the workload. May only be set together + with a pre-provisioned capacity reservation (a deployment's + ``compute.provisioned_capacity_id``); it is rejected on a workload + that runs on on-demand capacity. + unity_catalog_image_path: + type: string description: >- - Optional named parameters passed to each deployment's command. Keys - are parameter names, values the corresponding arguments (for - example, ``{"epochs": "3", "dataset": "s3://bucket/train"}``). - Values may contain dynamic references such as - ``{{job.trigger.time.iso_date}}`` or - ``{{tasks..values.}}``, which Jobs substitutes - before execution (see ``AiRuntimeTaskResolvedValues.parameters`` in - runs.proto). + Optional Unity Catalog path for a custom container image. When set, + the task runs on the specified container image instead of the + default Databricks client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}`` required: - experiment - deployments @@ -16476,11 +15835,6 @@ components: Represents a subscriber that will receive alert notifications. A subscriber can be either a user (via email) or a notification destination (via destination_id). - AppTool: - type: object - properties: - name: - type: string BaseJob: type: object properties: @@ -16515,17 +15869,22 @@ components: job_id: type: integer description: The canonical identifier for this job. - path: - type: string - description: >- - Path of the job object in workspace file tree, including file - extension. If absent, the job doesn't have a workspace object. - Example: /Workspace/user@example.com/my_project/my_job.job.json settings: $ref: '#/components/schemas/JobSettings' description: >- Settings for this job and all of its runs. These settings can be updated using the ``resetJob`` method. + trigger_details: + type: array + items: + $ref: '#/components/schemas/TriggerDetails' + description: >- + Per-trigger runtime information for the multi-trigger surface. Same + length and order as ``JobSettings.triggers``; ``trigger_details[i]`` + corresponds to ``triggers[i]``. Sub-fields (``state``, ``history``) + are populated independently based on the + ``GetJob.include_trigger_state`` / ``include_trigger_history`` + flags. trigger_state: $ref: '#/components/schemas/TriggerStateProto' description: State of the trigger associated with the job. @@ -16569,16 +15928,28 @@ components: description: type: string description: Description of the run + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the + supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, + ``72h``. ``NO_FLEXIBILITY`` means the run uses the default + cost-optimized performance level without additional cost-saving + optimizations. effective_performance_target: $ref: '#/components/schemas/PerformanceTarget' description: >- The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported - by the job type. - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast + by the job type. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized - cluster performance. + cluster performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: Enables + lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. effective_usage_policy_id: type: string description: >- @@ -16596,10 +15967,8 @@ components: $ref: '#/components/schemas/JobEnvironmentVariables' description: >- Snapshot of ``JobSettings.environment_variables`` as it was at run - launch — the full list of named env-var profiles the job defined. - Per-profile resolved contents are not preserved here; only the - customer-defined ``variables`` and ``files`` paths. To find which - profile a given task ran with, look at + launch — the full list of named environment-variable entries the job + defined. To find which entry a given task ran with, look at ``RunTaskSettings.environment_variables_key``. execution_duration: type: integer @@ -16747,11 +16116,6 @@ components: created. Identifies a specific snapshot of the deployment in the Deployment Metadata service. Only set for job runs of jobs with a ``BUNDLE`` deployment. - CatalogTool: - type: object - properties: - name: - type: string CleanRoomTaskRunState: type: object properties: @@ -16806,11 +16170,6 @@ components: description: >- Information on how to access the output schema for the clean room run - shared_output_schema_info: - $ref: '#/components/schemas/OutputSchemaInfo' - description: >- - Information on how to access the shared output schema for the clean - room run ClusterInstance: type: object properties: @@ -16879,6 +16238,13 @@ components: multiple of the per-node accelerator count encoded in ``accelerator_type``. For example, ``GPU_8xH100`` with ``accelerator_count: 16`` allocates 2 nodes (8 GPUs per node). + provisioned_capacity_id: + type: string + description: >- + Optional ID of a pre-provisioned accelerator capacity reservation to + run this AI Runtime workload on. When set, the workload is scheduled + onto the referenced reserved capacity instead of the on-demand + capacity shared among all Databricks customers. required: - accelerator_type - accelerator_count @@ -16920,6 +16286,32 @@ components: description: >- Indicate whether the continuous job is applying task level retries or not. Defaults to NEVER. + ContinuousTriggerConfiguration: + type: object + properties: + maintenance_window: + $ref: '#/components/schemas/MaintenanceWindow' + description: >- + Defines when platform-initiated maintenance may run for this + trigger. If unspecified, maintenance may run at any time. + task_retry_mode: + $ref: '#/components/schemas/TaskRetryMode' + description: >- + Whether the continuous job applies task-level retries. Defaults to + NEVER. + description: >- + Continuous trigger. Stripped-down counterpart to ``ContinuousSettings``: + ``pause_status`` is + owned by the enclosing ``TriggerConfiguration`` and intentionally omitted here. + ContinuousTriggerState: + type: object + properties: + consecutive_failures: + type: integer + is_backing_off: + type: boolean + next_attempt_ms: + type: integer CreateResponse: type: object properties: @@ -16951,6 +16343,31 @@ components: required: - quartz_cron_expression - timezone_id + CronTriggerConfiguration: + type: object + properties: + quartz_cron_expression: + type: string + description: >- + A Cron expression using Quartz syntax that describes the schedule + for this trigger. See `Cron Trigger + `__ + for details. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with respect to this + timezone. See `Java TimeZone + `__ + for details. + required: + - quartz_cron_expression + - timezone_id + description: >- + Cron schedule trigger. Stripped-down counterpart to ``CronSchedule``: + ``pause_status`` and + ``sql_condition`` are owned by the enclosing ``TriggerConfiguration`` and intentionally omitted + here. DashboardPageSnapshot: type: object properties: @@ -16999,11 +16416,6 @@ components: type: array items: $ref: '#/components/schemas/DashboardPageSnapshot' - DashboardTool: - type: object - properties: - dashboard_id: - type: string DbtCloudJobRunStep: type: object properties: @@ -17170,26 +16582,20 @@ components: DeploymentSpec: type: object properties: + compute: + $ref: '#/components/schemas/ComputeSpec' + description: Compute resources allocated to each node in this deployment. command_path: type: string description: >- Workspace path of the script to run on each node in this deployment. Upload the script to this path and supply the path here. When the task runs, the file at this path is run on each node; if it fails, - the task fails with its exit code. Example script contents: Plain - Python: python train.py --epochs 10 Multi-GPU via accelerate: - accelerate launch train.py --config config.yaml Distributed via - torchrun: torchrun --nproc_per_node=8 train.py - compute: - $ref: '#/components/schemas/ComputeSpec' - description: Compute resources allocated to each node in this deployment. - docker_image_url: - type: string - description: >- - Optional Docker image URL for a custom container image. When set, - the task runs on the specified container image instead of the - default Databricks client image. Format: - ``{organization}/{repository}:{tag}`` + the task fails with its exit code. Example script contents: .. + code-block:: bash # Plain Python: python train.py --epochs 10 # + Multi-GPU via accelerate: accelerate launch train.py --config + config.yaml # Distributed via torchrun: torchrun --nproc_per_node=8 + train.py name: type: string description: >- @@ -17198,7 +16604,6 @@ components: display. Distinct names are recommended so deployments can be told apart, but uniqueness is not enforced. required: - - command_path - compute description: >- DeploymentSpec: configuration for one deployment within an @@ -17362,51 +16767,17 @@ components: dl_runtime_image: type: string description: Runtime image - client_version: - type: string - description: >- - Version of the client (e.g., sgcli wheel) that submitted this task. - Used by handlers to gate behavior or reject incompatible versions. - code_source_tar_path: - type: string - description: >- - Optional path to a tarball containing the user's workspace contents. - When set, the entry script extracts the tarball into the working - directory before running the training script, so the training script - can import sibling modules and read packaged data files. Must be a - workspace path (e.g. ``/Workspace/Users/...``) or volume; ``dbfs:/`` - is not supported. command: type: string description: Command launcher to run the actual script, e.g. bash, python etc. compute: $ref: '#/components/schemas/ComputeConfig' - docker_image_url: - type: string - description: >- - Optional custom Docker container image URL for running the training - script. Format: organization/repository:tag (e.g., - "pytorch/pytorch:2.0.1") mlflow_experiment_name: type: string description: >- Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. - mlflow_run_name: - type: string - description: >- - Optional name to assign to the MLflow run created for this task. If - unset, MLflow auto-generates a name. Used alongside - ``mlflow_experiment_name`` to identify the run in the MLflow UI. - requirements_yaml_path: - type: string - description: >- - Optional path to a requirements.yaml file describing pip - dependencies to install before running the training script. Consumed - by the entry script; format matches the runtime requirements.yaml - convention used by sgcli. Must be a workspace path (e.g. - ``/Workspace/Users/...``) or volume; ``dbfs:/`` is not supported. source: $ref: '#/components/schemas/Source' description: >- @@ -17443,56 +16814,8 @@ components: DEPRECATED — use ``AiRuntimeTask`` for all new BYOT multi-node GPU workloads (see ai_runtime_task.proto). ``AiRuntimeTask`` is the only supported BYOT task type for new - workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility - and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). - GenieCodeApi: - type: object - properties: {} - description: >- - Marks the agentic task as a Genie Code conversation. The user query is - carried in - ``AgenticTask.input``; this message is a discriminator-only variant in ``AgenticTask.agent`` and - currently has no per-conversation configuration of its own. - GenieCodeOutput: - type: object - properties: - thread_id: - type: string - description: >- - Identifier of the Genie Code conversation thread for this run. In - Genie Code, threads are backed by workspace notebooks, so this value - also identifies the notebook a UI can deep-link to for the - conversation transcript. - description: >- - Output specific to the ``GenieCodeApi`` execution path of an agentic - task. - GenieSpaceTool: - type: object - properties: - space_id: - type: string - GenieTask: - type: object - properties: - configuration_id: - type: string - description: Required. Resource name of the agent task configuration to run. - required: - - configuration_id - description: >- - GenieTask runs a Genie or Genie Code agent task. The job task is a thin - reference to a - separately stored agent task configuration; all agent configuration (prompt, MCP connections, - referenced assets) lives on that object. - GenieTaskOutput: - type: object - properties: - conversation_id: - type: string - description: >- - The conversation ID of the agent run, used to retrieve the full - conversation history and results. - description: GenieTaskOutput is the output produced by a single Genie task run. + workloads; this proto is retained only for AIR CLI (fka SGCLI) pywheel backwards compatibility + and will be removed once the pywheel → databricks-cli migration completes (post- PuPr). GetJobPermissionLevelsResponse: type: object properties: @@ -17575,50 +16898,6 @@ components: Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, ``git_source`` must be defined on the job. - IncrementalRefreshConfig: - type: object - properties: - archive_window_granularity: - $ref: '#/components/schemas/RefreshGranularity' - description: 'Granularity for the archive window. Default: MONTH' - archive_window_periods: - type: integer - description: >- - Number of periods in the archive window (total data retained). Must - be greater than the refresh window when using the same granularity. - Default: 3 (with YEAR granularity = 3 years) - detect_data_changes: - type: boolean - description: >- - If true, Power BI will check whether data has changed in each - partition before reimporting. Partitions with unchanged data are - skipped, reducing refresh cost further. Uses MAX(datetime_column) as - the change detector. - mode: - $ref: '#/components/schemas/RefreshPolicyMode' - description: >- - The refresh policy mode. Hybrid adds a real-time DirectQuery - partition for the most recent data; Import uses only batch-imported - partitions. Default: HYBRID - only_refresh_complete_periods: - type: boolean - description: >- - If true, only refresh complete periods (e.g., skip today's partial - data). - refresh_window_granularity: - $ref: '#/components/schemas/RefreshGranularity' - description: 'Granularity for the refresh window. Default: DAY' - refresh_window_periods: - type: integer - description: >- - Number of periods in the rolling refresh window. Partitions within - this window are re-imported on each refresh. Default: 1 - description: >- - Configuration for Power BI incremental refresh applied to all IMPORT - mode tables. When set, - IMPORT tables with incremental_refresh_datetime_column will use date-based partitioning for - incremental imports instead of full refreshes. The refresh windows and mode are shared across - all tables; the partition column is specified per-table on PowerBiTable. Job: type: object properties: @@ -17659,12 +16938,6 @@ components: next_page_token: type: string description: A token that can be used to list the next page of array properties. - path: - type: string - description: >- - Path of the job object in workspace file tree, including file - extension. If absent, the job doesn't have a workspace object. - Example: /Workspace/user@example.com/my_project/my_job.job.json run_as_user_name: type: string description: >- @@ -17680,6 +16953,17 @@ components: description: >- Settings for this job and all of its runs. These settings can be updated using the ``resetJob`` method. + trigger_details: + type: array + items: + $ref: '#/components/schemas/TriggerDetails' + description: >- + Per-trigger runtime information for the multi-trigger surface. Same + length and order as ``JobSettings.triggers``; ``trigger_details[i]`` + corresponds to ``triggers[i]``. Sub-fields (``state``, ``history``) + are populated independently based on the + ``GetJob.include_trigger_state`` / ``include_trigger_history`` + flags. trigger_state: $ref: '#/components/schemas/TriggerStateProto' description: State of the trigger associated with the job. @@ -17735,7 +17019,6 @@ components: tasks bound to this cluster. required: - job_cluster_key - - new_cluster JobCompliance: type: object properties: @@ -17866,6 +17149,19 @@ components: Identifier for this entry. Must be unique within ``JobSettings.environment_variables``. Tasks reference it from ``TaskSettings.environment_variables_key``. + spec: + $ref: '#/components/schemas/JobEnvironmentVariablesSpec' + description: The environment variable specification. + required: + - environment_variables_key + description: >- + A named environment-variable entry, defined once at the job level and + referenced by key from one + or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via + ``TaskSettings.environment_variables_key``. + JobEnvironmentVariablesSpec: + type: object + properties: files: type: array items: @@ -17874,52 +17170,32 @@ components: Workspace (``/Workspace/...``) or UC Volumes (``/Volumes/...``) paths to ``.env`` files. Maximum 5 files. Files are read, parsed, and merged at task execution time, not at job creation or update API - call time. File format: each line must be exactly ``KEY=VALUE``. - Keys must match the same regex as inlined variable names - (``^[A-Za-z_][A-Za-z0-9_]*$``); the value continues to the end of - the line. No other syntax is supported — no comments, no quoted - values, no escape sequences, no variable interpolation. Any line - that does not match the ``KEY=VALUE`` shape fails the run. Size - limits: maximum 1,048,576 bytes (1 MiB) per file on disk; maximum - 131,072 bytes (128 KiB) per ``KEY=VALUE`` line combined. Caps are - enforced at read time in jobs-runner — files exceeding the per-file - cap, or lines exceeding the per-line cap, fail the run. On a + call time. File format: each line containing a variable must be + exactly ``KEY=VALUE``. Empty and whitespace-only lines, and lines + beginning with ``#``, are ignored. Keys must match the same regex as + inlined variable names (``^[A-Za-z_][A-Za-z0-9_]*$``); the value + continues to the end of the line. No other syntax is supported — no + inline comments, no quoted values, no escape sequences, no variable + interpolation. Any other line that does not match the ``KEY=VALUE`` + shape fails the run. Size limits: maximum 32,768 bytes (32 KiB) per + file on disk; maximum 1,024 bytes (1 KiB) per ``KEY=VALUE`` line + combined. Files or lines exceeding these limits fail the run. On a duplicate key, the later file wins; ``variables`` override values - from any file. Values may contain {{secrets/scope/key}} references; - those are resolved at task execution time and never persisted in - resolved form. Do not use these files to store raw secret values; - consult `secret management - `__ for the - right way to pass sensitive values. + from any file. variables: type: object description: >- - Environment variables specified directly as key/value pairs (as - opposed to ``files``, which are read from ``.env`` file paths). - Maximum 100 entries. Each key must match - ``^[A-Za-z_][A-Za-z0-9_]*$`` and be 1 to 256 characters long. Each - value is up to 512 characters; larger values should be moved into a - ``.env`` file referenced from ``files``. On a duplicate key, - ``variables`` override values from any file in ``files``. Values may - contain {{secrets/scope/key}} references; those are resolved at task - execution time and never persisted in resolved form. Do not use this - field to store a raw secret value; consult `secret management - `__ for the - right way to pass sensitive values. + Environment variables specified directly as key/value pairs. Maximum + 20 entries. Each key must be 1 to 256 characters and match + ``^[A-Za-z_][A-Za-z0-9_]*$``: it must start with an ASCII letter or + underscore and contain only ASCII letters, digits, and underscores. + Each value can be any Unicode string of up to 512 characters, + including an empty string. description: >- - A named environment-variable entry, defined once at the job level and - referenced by key from one - or more tasks. Entries live on ``JobSettings.environment_variables``, and tasks select one via - ``TaskSettings.environment_variables_key``. - - Precedence within a single entry (later overrides earlier on duplicate keys): - - files (merged in submitted order; later file in the list wins) └─▶ variables (inline k/v - override file contents) └─▶ runtime (os.environ / sys.env — overrides all, - classic-parity) - - Resolved values are never persisted: ``{{secrets/scope/key}}`` references in ``variables`` or in - ``files`` contents are stored verbatim and resolved at task execution time on the DP . + The environment variables and files associated with a job environment + variable entry. Runtime + environment variables override inline ``variables``, which override values from ``files``, on + duplicate keys. JobNotificationSettings: type: object properties: @@ -17987,8 +17263,10 @@ components: group_name: type: string description: >- - Group name of an account group assigned to the workspace. Setting - this field requires being a member of the group. + Group name of an account group assigned to the workspace. When set, + all tasks run as the group and the group's permissions are used for + data access. Setting this field requires being a member of the + group, or having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -18000,12 +17278,12 @@ components: The email of an active workspace user. Non-admin users can only set this field to their own email. description: >- - Write-only setting. Specifies the user or service principal that the job - runs as. If not + Write-only setting. Specifies the user, service principal, or group that + the job runs as. If not specified, the job runs as the user who created the job. - Either ``user_name`` or ``service_principal_name`` should be specified. If not, an error is - thrown. + One of ``user_name``, ``service_principal_name``, or ``group_name`` should be specified. If not, + an error is thrown. JobSettings: type: object properties: @@ -18016,7 +17294,9 @@ components: description: >- An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only - one of ``schedule`` and ``continuous`` can be used. + one of ``schedule`` and ``continuous`` can be used. Pipelines + started by a continuous job also run continuously, regardless of + their own pipeline mode setting. deployment: $ref: '#/components/schemas/JobDeployment' description: Deployment information for jobs managed by external sources. @@ -18025,6 +17305,16 @@ components: description: >- An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding. + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the + supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, + ``72h``. ``NO_FLEXIBILITY`` means the run uses the default + cost-optimized performance level without additional cost-saving + optimizations. edit_mode: $ref: '#/components/schemas/JobEditMode' description: >- @@ -18042,21 +17332,24 @@ components: $ref: '#/components/schemas/JobEnvironmentVariables' description: >- Named environment-variable entries that tasks can reference by key - from ``TaskSettings.environment_variables_key``. Each entry holds - inline ``variables`` plus optional ``.env`` ``files``. Maximum 10 - entries per job. Entries are independent of one another — there is - no cross-entry merging. + from ``TaskSettings.environment_variables_key``. Each entry's + ``spec`` holds inline ``variables`` and optional ``.env`` ``files``. + Maximum 10 entries per job. A task can reference at most one entry + from this list. environments: type: array items: $ref: '#/components/schemas/JobEnvironment' description: >- A list of task execution environment specifications that can be - referenced by serverless tasks of this job. For serverless notebook - tasks, if the environment_key is not specified, the notebook + referenced by tasks that use serverless compute or a compute + resource that uses Environments mode. For notebook tasks that use + serverless compute or a compute resource that uses Environments + mode, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the notebook environment. For other - serverless tasks, the task environment is required to be specified + tasks that use serverless compute or a compute resource that uses + Environments mode, the task environment is required to be specified using environment_key in the task settings. format: $ref: '#/components/schemas/Format' @@ -18127,10 +17420,12 @@ components: The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run. The performance target does not apply to tasks that run on Serverless - GPU compute. - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast - startup and execution times through rapid scaling and optimized - cluster performance. + GPU compute. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup + and execution times through rapid scaling and optimized cluster + performance. - ``STANDARD``: Enables cost-efficient execution of + serverless workloads. - ``COST_OPTIMIZED``: Enables lower job costs + by optimizing compute for your selected target duration time. Must + provide a duration target. queue: $ref: '#/components/schemas/QueueSettings' description: The queue settings of the job. @@ -18178,6 +17473,15 @@ components: The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to ``runNow``. + triggers: + type: array + items: + $ref: '#/components/schemas/TriggerConfiguration' + description: >- + List of triggers attached to this job. A run starts when any active + trigger evaluates to true. Cannot be set in the same request as the + legacy ``schedule``, ``trigger``, or ``continuous`` fields. Gated + behind the "Multiple Triggers" feature preview. usage_policy_id: type: string description: >- @@ -18240,11 +17544,6 @@ components: items: $ref: '#/components/schemas/JobsHealthRule' description: An optional set of health rules that can be defined for this job. - KnowledgeAssistantTool: - type: object - properties: - knowledge_assistant_id: - type: string ListJobComplianceForPolicyResponse: type: object properties: @@ -18380,6 +17679,13 @@ components: is 60 seconds. required: - condition + ModelTriggerState: + type: object + properties: {} + description: >- + Runtime state for a model trigger. Currently empty because model + triggers do not expose any + trigger-specific runtime state. NotebookOutput: type: object properties: @@ -18444,6 +17750,37 @@ components: Stores the catalog name, schema name, and the output schema expiration time for the clean room run. + PerTriggerState: + type: object + properties: + continuous: + $ref: '#/components/schemas/ContinuousTriggerState' + file_arrival: + $ref: '#/components/schemas/FileArrivalTriggerState' + model: + $ref: '#/components/schemas/ModelTriggerState' + pause_status: + $ref: '#/components/schemas/PauseStatus' + description: >- + Whether this trigger is paused or not. Mirrors the configured + pause_status. + periodic: + $ref: '#/components/schemas/PeriodicTriggerState' + schedule: + $ref: '#/components/schemas/ScheduleTriggerState' + sql_condition: + $ref: '#/components/schemas/SqlConditionState' + description: >- + State for SQL condition evaluation, can coexist with other trigger + states. + table_update: + $ref: '#/components/schemas/TableTriggerState' + description: >- + Per-trigger runtime state for the multi-trigger surface. Mirrors + ``TriggerConfiguration``'s + trigger-type variants 1:1; each entry sets exactly one variant matching the corresponding + trigger's type. Variants with no runtime state today (``schedule``, ``model``) are emitted as + empty messages. PeriodicTriggerConfiguration: type: object properties: @@ -18455,6 +17792,11 @@ components: required: - interval - unit + PeriodicTriggerState: + type: object + properties: + next_run_time: + type: integer PipelineParams: type: object properties: @@ -18549,13 +17891,6 @@ components: properties: catalog: type: string - incremental_refresh_datetime_column: - type: string - description: >- - The datetime column used for incremental refresh partitioning on - this table. e.g., "order_date", "updated_at" Only applicable when - the task has incremental_refresh_config set and this table uses - IMPORT storage mode. name: type: string description: The table name in Databricks @@ -18565,24 +17900,11 @@ components: storage_mode: $ref: '#/components/schemas/StorageMode' description: The Power BI storage mode of the table - table_type: - $ref: '#/components/schemas/PowerBiTableTableType' - description: >- - The Unity Catalog table type of this table. When set, the server - trusts it to classify the table during metric-view filtering and - skips the server-side lookup. When unset, the server resolves the - type on its own. PowerBiTask: type: object properties: connection_resource_name: type: string - incremental_refresh_config: - $ref: '#/components/schemas/IncrementalRefreshConfig' - description: >- - Incremental refresh policy applied to all IMPORT mode tables in the - model. Windows and mode are shared; partition columns are set - per-table on PowerBiTable. power_bi_model: $ref: '#/components/schemas/PowerBiModel' description: The semantic model to update @@ -18757,16 +18079,8 @@ components: ResolvedValues: type: object properties: - agentic_task: - $ref: '#/components/schemas/ResolvedValuesAgenticTaskResolvedValues' ai_runtime_task: $ref: '#/components/schemas/ResolvedValuesAiRuntimeTaskResolvedValues' - description: >- - Resolved values for an AI Runtime task — env_vars with - ``{{tasks..values.}}`` references substituted to concrete - values before submission to the training service. - alert_task: - $ref: '#/components/schemas/ResolvedValuesAlertTaskResolvedValues' condition_task: $ref: '#/components/schemas/ResolvedConditionTaskValues' dbt_task: @@ -18789,17 +18103,6 @@ components: $ref: '#/components/schemas/ResolvedStringParamsValues' sql_task: $ref: '#/components/schemas/ResolvedParamPairValues' - ResolvedValuesAgenticTaskResolvedValues: - type: object - properties: - input: - type: string - description: The fully-resolved ``input`` prompt sent to the agent. - description: >- - Resolved values for an agentic task: the ``input`` prompt with parameter - references such as - ``{{tasks..values.}}`` replaced by the concrete values produced by upstream - tasks. ResolvedValuesAiRuntimeTaskResolvedValues: type: object properties: {} @@ -18807,11 +18110,6 @@ components: Resolved values for an AiRuntimeTask after dynamic-value substitution, so Jobs can expand ``{{tasks..values.}}`` references before submission. - ResolvedValuesAlertTaskResolvedValues: - type: object - properties: - parameters: - type: object Run: type: object properties: @@ -18861,16 +18159,28 @@ components: description: type: string description: Description of the run + duration_target: + type: string + description: >- + The window the run aims to finish within, in hours, for a + Cost-optimized serverless run. Required only when + ``performance_target`` is ``COST_OPTIMIZED``. Must be one of the + supported values: ``NO_FLEXIBILITY``, ``4h``, ``12h``, ``24h``, + ``72h``. ``NO_FLEXIBILITY`` means the run uses the default + cost-optimized performance level without additional cost-saving + optimizations. effective_performance_target: $ref: '#/components/schemas/PerformanceTarget' description: >- The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported - by the job type. - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast + by the job type. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized - cluster performance. + cluster performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: Enables + lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. effective_usage_policy_id: type: string description: >- @@ -18888,10 +18198,8 @@ components: $ref: '#/components/schemas/JobEnvironmentVariables' description: >- Snapshot of ``JobSettings.environment_variables`` as it was at run - launch — the full list of named env-var profiles the job defined. - Per-profile resolved contents are not preserved here; only the - customer-defined ``variables`` and ``files`` paths. To find which - profile a given task ran with, look at + launch — the full list of named environment-variable entries the job + defined. To find which entry a given task ran with, look at ``RunTaskSettings.environment_variables_key``. execution_duration: type: integer @@ -19218,9 +18526,6 @@ components: RunOutput: type: object properties: - agentic_task_output: - $ref: '#/components/schemas/AgenticTaskOutput' - description: The output of an agentic task, if available ai_runtime_task_output: $ref: '#/components/schemas/AiRuntimeTaskOutput' description: >- @@ -19259,9 +18564,6 @@ components: description: >- If there was an error executing the run, this field contains any available stack traces. - genie_task_output: - $ref: '#/components/schemas/GenieTaskOutput' - description: The output of a Genie task, if available info: type: string logs: @@ -19436,9 +18738,6 @@ components: from other tasks. This field is required and must be unique within its parent job. On Update or Reset, this field is used to reference the tasks to be updated or reset. - agentic_task: - $ref: '#/components/schemas/AgenticTask' - description: Agentic Task for job-based multi-agent execution ai_runtime_task: $ref: '#/components/schemas/AiRuntimeTask' description: >- @@ -19534,10 +18833,12 @@ components: The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported - by the job type. - ``STANDARD``: Enables cost-efficient execution of - serverless workloads. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast + by the job type. - ``PERFORMANCE_OPTIMIZED``: Prioritizes fast startup and execution times through rapid scaling and optimized - cluster performance. + cluster performance. - ``STANDARD``: Enables cost-efficient + execution of serverless workloads. - ``COST_OPTIMIZED``: Enables + lower job costs by optimizing compute for your selected target + duration time. Must provide a duration target. email_notifications: $ref: '#/components/schemas/JobEmailNotifications' description: >- @@ -19554,15 +18855,17 @@ components: description: >- The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using - serverless compute. + serverless compute or a compute resource that uses Environments + mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in - ``RunSettings.environment_variables``. The selected entry's - variables and file contents are applied to this task at execution - time. Length and pattern mirror ``environment_key`` so the two - references look identical to customers reading task settings. + ``RunSettings.environment_variables`` for one-time runs or preserved + in ``Run.environment_variables`` for run snapshots. The selected + entry's variables are applied to this task at execution time. This + field supports serverless tasks using environment version 5 or + later. execution_duration: type: integer description: >- @@ -19588,9 +18891,6 @@ components: ``for_each_task`` field is present. gen_ai_compute_task: $ref: '#/components/schemas/GenAiComputeTask' - genie_task: - $ref: '#/components/schemas/GenieTask' - description: Runs a Genie or Genie Code agent task. git_source: $ref: '#/components/schemas/GitSource' description: >- @@ -19752,16 +19052,13 @@ components: required: - task_key description: Used when outputting a child run, in GetRun or ListRuns. - SchemaTool: - type: object - properties: - name: - type: string - ServingEndpointTool: + ScheduleTriggerState: type: object - properties: - name: - type: string + properties: {} + description: >- + Runtime state for a schedule trigger. Currently empty because schedule + triggers do not expose + any trigger-specific runtime state. SparkJarTask: type: object properties: @@ -19955,6 +19252,9 @@ components: dashboard_output: $ref: '#/components/schemas/SqlDashboardOutput' description: The output of a SQL dashboard task, if available. + file_output: + $ref: '#/components/schemas/SqlTaskSqlFileOutput' + description: The output of a SQL file task, if available. query_output: $ref: '#/components/schemas/SqlQueryOutput' description: The output of a SQL query task, if available. @@ -19970,7 +19270,9 @@ components: type: string output_link: type: string - description: The link to find the output results. + description: >- + Deprecated. The link to find the output results, which are only + accessible from the UI. query_text: type: string description: >- @@ -19989,6 +19291,38 @@ components: properties: lookup_key: type: string + SqlStatementQueryResult: + type: object + properties: + columns: + type: array + items: + $ref: '#/components/schemas/SqlStatementQueryResultColumn' + rows: + type: array + items: + $ref: '#/components/schemas/SqlStatementQueryResultRow' + description: The rows returned by the query. + truncated: + type: boolean + description: Whether the result set was truncated. + SqlStatementQueryResultColumn: + type: object + properties: + name: + type: string + SqlStatementQueryResultRow: + type: object + properties: + values: + type: array + items: + $ref: '#/components/schemas/SqlStatementQueryResultRowRowValue' + SqlStatementQueryResultRowRowValue: + type: object + properties: + string_value: + type: string SqlTask: type: object properties: @@ -20074,6 +19408,22 @@ components: type: string required: - query_id + SqlTaskSqlFileOutput: + type: object + properties: + query_result: + $ref: '#/components/schemas/SqlStatementQueryResult' + query_text: + type: string + description: The text of the SQL query. + sql_statements: + type: array + items: + $ref: '#/components/schemas/SqlStatementOutput' + description: Information about SQL statements executed in the run. + warehouse_id: + type: string + description: The canonical identifier of the SQL warehouse. SqlTaskSubscription: type: object properties: @@ -20097,9 +19447,6 @@ components: properties: task_key: type: string - agentic_task: - $ref: '#/components/schemas/AgenticTask' - description: Agentic Task for job-based multi-agent execution ai_runtime_task: $ref: '#/components/schemas/AiRuntimeTask' description: >- @@ -20173,15 +19520,17 @@ components: description: >- The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using - serverless compute. + serverless compute or a compute resource that uses Environments + mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in - ``RunSettings.environment_variables``. The selected entry's - variables and file contents are applied to this task at execution - time. Length and pattern mirror ``environment_key`` so the two - references look identical to customers reading task settings. + ``RunSettings.environment_variables`` for one-time runs or preserved + in ``Run.environment_variables`` for run snapshots. The selected + entry's variables are applied to this task at execution time. This + field supports serverless tasks using environment version 5 or + later. existing_cluster_id: type: string description: >- @@ -20197,9 +19546,6 @@ components: ``for_each_task`` field is present. gen_ai_compute_task: $ref: '#/components/schemas/GenAiComputeTask' - genie_task: - $ref: '#/components/schemas/GenieTask' - description: Runs a Genie or Genie Code agent task. health: $ref: '#/components/schemas/JobsHealthRules' libraries: @@ -20309,8 +19655,13 @@ components: Subscription: type: object properties: + attachment: + $ref: '#/components/schemas/SubscriptionAttachment' custom_subject: type: string + description: >- + Optional: Allows users to specify a custom subject line on the email + sent to subscribers. paused: type: boolean description: When true, the subscription will not send emails. @@ -20319,66 +19670,114 @@ components: items: $ref: '#/components/schemas/SubscriptionSubscriber' description: The list of subscribers to send the snapshot of the dashboard to. - SubscriptionSubscriber: + SubscriptionAttachment: type: object properties: - destination_id: - type: string - user_name: - type: string + data_attachment: + $ref: '#/components/schemas/SubscriptionAttachmentDataAttachment' description: >- - A snapshot of the dashboard will be sent to the user's email when - the ``user_name`` field is present. - SupervisorAgent: - type: object - properties: - agent_id: - type: string - description: Required. The ID of the supervisor agent (tile_id). - description: Configuration for a Supervisor Agent referenced by tile_id. - SupervisorAgentTool: + Optional: The configuration for the underlying data of dashboard + widgets attached as tabular data files. If not specified, no tabular + data is attached. + page_attachment: + $ref: '#/components/schemas/SubscriptionAttachmentPageAttachment' + description: >- + Optional: The selection of dashboard pages included in the attached + PDF. If not specified, only the first page is included. + description: >- + The configuration for the files attached to the dashboard snapshot + notification sent to + subscribers. ``data_attachment`` describes the underlying data of dashboard widgets attached as + data files, and ``page_attachment`` describes which dashboard pages are included in the attached + PDF. + SubscriptionAttachmentDataAttachment: type: object properties: - supervisor_agent_id: - type: string - description: Supervisor Agent ID. - description: Supervisor Agent referenced by another supervisor as a tool. - SupervisorApi: + widgets: + type: array + items: + $ref: '#/components/schemas/SubscriptionAttachmentDataAttachmentWidget' + description: >- + The widgets whose underlying data is exported. At least one widget + must be referenced. + file_format: + $ref: '#/components/schemas/SubscriptionAttachmentDataAttachmentFileFormat' + description: The file format of the exported tabular data files. + include_applied_filters: + type: boolean + description: >- + When true, the dashboard's applied filter values are included + alongside the tabular data as an additional attached file. + required: + - widgets + - file_format + description: >- + The configuration for the tabular data files attached to the dashboard + snapshot. ``widgets`` + lists the widgets whose data is exported and ``file_format`` is the output format; each + referenced widget's data is exported as a separate file. + SubscriptionAttachmentDataAttachmentWidget: type: object properties: - instructions: + page_id: type: string description: >- - Optional. System instructions that guide how the supervisor routes - queries across tools and synthesizes responses. - model: + The URL identifier of the page containing the widget. This is the + value of the ``name`` field of the corresponding entry under + ``pages`` in the serialized dashboard definition. Format: + alphanumeric, hyphen, and underscore characters allowed, max length + 63. + widget_id: type: string description: >- - Required. Databricks-provided FMAPI model, e.g. - "databricks-claude-sonnet-4-5". - tools: + The URL identifier of the widget. This is the value of the ``name`` + field of the corresponding widget under that page's ``layout`` in + the serialized dashboard definition. Format: alphanumeric, hyphen, + and underscore characters allowed, max length 63. + required: + - page_id + - widget_id + description: >- + Identifies a dashboard widget whose data to attach. ``page_id`` and + ``widget_id`` are the URL + identifiers from the dashboard's serialized definition returned by the Get dashboard API + (``serialized_dashboard``), and together they uniquely identify the widget. + SubscriptionAttachmentPageAttachment: + type: object + properties: + page_ids: type: array items: - $ref: '#/components/schemas/AgentTool' - description: Optional. The tools the inlined agent can use. + type: string + description: >- + The identifiers of the pages to include in the PDF. Only specified + when ``page_selection`` is ``PAGE_SELECTION_SUBSET``. Each value is + the identifier of a page in the dashboard's serialized definition + returned by the Get dashboard API (``serialized_dashboard``): the + value of the ``name`` field of an entry under ``pages``. Format: + alphanumeric, hyphen, and underscore characters allowed, max length + 63. + page_selection: + $ref: >- + #/components/schemas/SubscriptionAttachmentPageAttachmentPageSelection + description: >- + How the attached pages are selected. When set to + ``PAGE_SELECTION_SUBSET``, the pages to include are listed in + ``page_ids``. description: >- - Inlined Responses-API supervisor configuration. Used as a oneof variant - inside - ``AgenticTask.agent`` to define an agent without referencing a pre-registered Supervisor Agent - tile. - SupervisorOutput: + The selection of dashboard pages included in the attached PDF. + ``page_selection`` chooses + between all pages, the first page only, or an explicit subset listed in ``page_ids``. + SubscriptionSubscriber: type: object properties: - response_id: + destination_id: + type: string + user_name: type: string description: >- - The Responses-API ``response.id`` produced by the supervisor. Use - this ID with the Responses API to fetch the full structured response - (assistant messages, function calls, function-call outputs). - description: >- - Output specific to the ``SupervisorAgent`` / ``SupervisorApi`` execution - path of an agentic - task. + A snapshot of the dashboard will be sent to the user's email when + the ``user_name`` field is present. TableState: type: object properties: @@ -20389,11 +19788,6 @@ components: description: >- Full table name of the table to monitor, e.g. ``mycatalog.myschema.mytable`` - TableTool: - type: object - properties: - name: - type: string TableTriggerState: type: object properties: @@ -20434,9 +19828,6 @@ components: properties: task_key: type: string - agentic_task: - $ref: '#/components/schemas/AgenticTask' - description: Agentic Task for job-based multi-agent execution ai_runtime_task: $ref: '#/components/schemas/AiRuntimeTask' description: >- @@ -20512,15 +19903,15 @@ components: description: >- The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using - serverless compute. + serverless compute or a compute resource that uses Environments + mode. environment_variables_key: type: string description: >- Reference to a ``JobEnvironmentVariables`` entry defined in ``JobSettings.environment_variables``. The selected entry's - variables and file contents are applied to this task at execution - time. Length and pattern mirror ``environment_key`` so the two - references look identical to customers reading task settings. + variables are applied to this task at execution time. This field + supports serverless tasks using environment version 5 or later. existing_cluster_id: type: string description: >- @@ -20536,9 +19927,6 @@ components: ``for_each_task`` field is present. gen_ai_compute_task: $ref: '#/components/schemas/GenAiComputeTask' - genie_task: - $ref: '#/components/schemas/GenieTask' - description: Runs a Genie or Genie Code agent task. health: $ref: '#/components/schemas/JobsHealthRules' job_cluster_key: @@ -20751,20 +20139,6 @@ components: description: >- If true, do not send notifications to recipients specified in ``on_failure`` if the run is skipped. - TaskOutputSchema: - type: object - properties: - properties: - type: object - description: Map of property name to property definition. - description: >- - Single-layer JSON-Schema-style declaration of the structured output the - agent should produce. - TaskOutputSchemaProperty: - type: object - properties: - description: - type: string TerminationDetails: type: object properties: @@ -20777,28 +20151,86 @@ components: unstructured and the format might change. type: $ref: '#/components/schemas/TerminationTypeType' - TraceDestination: + TriggerConfiguration: type: object properties: - catalog_name: - type: string - description: Unity Catalog catalog name for the trace table. - experiment_id: - type: string - description: MLflow experiment ID where traces are written. - schema_name: - type: string - description: Unity Catalog schema name for the trace table. - table_prefix: - type: string + continuous: + $ref: '#/components/schemas/ContinuousTriggerConfiguration' + description: Continuous trigger configuration. + file_arrival: + $ref: '#/components/schemas/FileArrivalTriggerConfiguration' + description: File arrival trigger configuration. + model: + $ref: '#/components/schemas/ModelTriggerConfiguration' + description: Model trigger configuration. + pause_status: + $ref: '#/components/schemas/PauseStatus' + description: >- + Whether this trigger is paused. Defaults to UNPAUSED when unset; the + server always returns an explicit value on read. + periodic: + $ref: '#/components/schemas/PeriodicTriggerConfiguration' + description: >- + Trigger type: exactly one must be set; mutual exclusivity is + enforced in the API handler Periodic trigger configuration. + schedule: + $ref: '#/components/schemas/CronTriggerConfiguration' + description: Cron schedule trigger configuration. + sql_condition: + $ref: '#/components/schemas/SqlConditionConfiguration' + description: Optional SQL condition that gates whether this trigger fires. + table_update: + $ref: '#/components/schemas/TableUpdateTriggerConfiguration' + description: Table update trigger configuration. + description: >- + A single trigger attached to a job via ``JobSettings.triggers``. Exactly + one of the trigger-type + fields (``periodic``, ``schedule``, ``continuous``, ``file_arrival``, ``table_update``, + ``model``, ``job_completion``) must be set; mutual exclusivity is enforced in the API handler + rather than via ``oneof`` so that codegen, validation, and JSON serialization across SDKs and + Terraform behave consistently. + TriggerDetails: + type: object + properties: + history: + $ref: '#/components/schemas/TriggerHistory' + description: >- + Recent evaluation history. Populated when + ``GetJob.include_trigger_history`` is set. + state: + $ref: '#/components/schemas/PerTriggerState' description: >- - Table-name prefix under ``.``. Trace tables are - created as ``.._<...>``. + Current runtime state. Populated when + ``GetJob.include_trigger_state`` is set. description: >- - Where MLflow traces produced by an agentic task run should be persisted. - Traces are written to - the given MLflow experiment, with their source data landing in a UC table at - ``.....``. + Per-trigger runtime details returned by ``GetJob``. Same length and + order as + ``JobSettings.triggers``; sub-fields are populated independently based on the corresponding + ``GetJob.include_trigger_state`` / ``include_trigger_history`` flags. + TriggerEvaluation: + type: object + properties: + description: + type: string + run_id: + type: integer + description: >- + The ID of the run that was triggered by the trigger evaluation. Only + returned if a run was triggered. + timestamp: + type: integer + description: Timestamp at which the trigger was evaluated. + TriggerHistory: + type: object + properties: + last_failed: + $ref: '#/components/schemas/TriggerEvaluation' + last_not_triggered: + $ref: '#/components/schemas/TriggerEvaluation' + description: The last time the trigger was evaluated but did not trigger a run. + last_triggered: + $ref: '#/components/schemas/TriggerEvaluation' + description: The last time the run was triggered due to a file arrival. TriggerInfo: type: object properties: @@ -20849,26 +20281,6 @@ components: states. table: $ref: '#/components/schemas/TableTriggerState' - UcConnectionTool: - type: object - properties: - name: - type: string - UcFunctionTool: - type: object - properties: - name: - type: string - UcMcpTool: - type: object - properties: - name: - type: string - VectorSearchIndexTool: - type: object - properties: - name: - type: string ViewItem: type: object properties: @@ -20883,15 +20295,6 @@ components: type: $ref: '#/components/schemas/ViewType' description: Type of the view item. - VolumeTool: - type: object - properties: - name: - type: string - WebSearchTool: - type: object - properties: {} - description: Built-in web-search tool. No per-asset configuration today. Webhook: type: object properties: @@ -20967,6 +20370,17 @@ components: properties: message: type: string + AiRuntimeTaskPriorityClass: + type: string + x-enum: + - BEST_EFFORT + - CRITICAL + - NORMAL + description: >- + Scheduling priority class for a workload — its priority and + preemptability when the scheduler + + ranks pending work. AlertEvaluationState: type: string x-enum: @@ -21475,23 +20889,6 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - PowerBiTableTableType: - type: string - x-enum: - - EXTERNAL - - EXTERNAL_SHALLOW_CLONE - - FOREIGN - - MANAGED - - MANAGED_SHALLOW_CLONE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - VIEW - description: >- - The Unity Catalog table type of a table. Values mirror the Unity Catalog - TableType enum so - - classification stays aligned across the two APIs. QueueDetailsCodeCode: type: string x-enum: @@ -21511,20 +20908,6 @@ components: - ``ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED``: The run was queued due to reaching the workspace limit of active run job tasks. - RefreshGranularity: - type: string - x-enum: - - REFRESH_GRANULARITY_DAY - - REFRESH_GRANULARITY_MONTH - - REFRESH_GRANULARITY_QUARTER - - REFRESH_GRANULARITY_YEAR - description: Granularity for incremental refresh windows. - RefreshPolicyMode: - type: string - x-enum: - - REFRESH_POLICY_MODE_HYBRID - - REFRESH_POLICY_MODE_IMPORT_ONLY - description: The refresh policy mode for incremental refresh. RepairHistoryItemType: type: string x-enum: @@ -21815,6 +21198,23 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + SubscriptionAttachmentDataAttachmentFileFormat: + type: string + x-enum: + - FILE_FORMAT_CSV + - FILE_FORMAT_EXCEL + - FILE_FORMAT_TSV + description: >- + The output format of an exported tabular data file. Must be set to a + value other than + + ``FILE_FORMAT_UNSPECIFIED``. + SubscriptionAttachmentPageAttachmentPageSelection: + type: string + x-enum: + - PAGE_SELECTION_ALL + - PAGE_SELECTION_SUBSET + description: Determines which dashboard pages are attached to the notification. TaskRetryMode: type: string x-enum: @@ -21839,7 +21239,6 @@ components: - CLOUD_FAILURE - CLUSTER_ERROR - CLUSTER_REQUEST_LIMIT_EXCEEDED - - CLUSTER_TERMINATED_BY_USER - DISABLED - DRIVER_ERROR - FEATURE_DISABLED @@ -22004,6 +21403,9 @@ components: restart a continuous job run. - ``MODEL``: Indicates a run that is triggered by a model update. + + - ``JOB_COMPLETION``: Indicates a run that is triggered by an upstream + job completion. ViewType: type: string x-enum: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/knowledgeassistants.yaml b/providers/src/databricks_workspace/v00.00.00000/services/knowledgeassistants.yaml new file mode 100644 index 00000000..f5b866c1 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/knowledgeassistants.yaml @@ -0,0 +1,2254 @@ +openapi: 3.0.0 +info: + title: Databricks Knowledgeassistants API (workspace) + description: >- + OpenAPI specification for the Databricks knowledgeassistants service + (workspace-level APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.knowledgeassistants +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/2.1/knowledge-assistants/{knowledge_assistant_id}/examples: + post: + operationId: knowledge_assistants_create_example + summary: Creates an example for a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Creates an example for a Knowledge Assistant. + + :param parent: str + Parent resource where this example will be created. Format: + knowledge-assistants/{knowledge_assistant_id} + :param example: :class:`Example` + The example to create under the parent Knowledge Assistant. + + :returns: :class:`Example` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `parent` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). Parent resource + where this example will be created. Format: + knowledge-assistants/{knowledge_assistant_id} + requestBody: + content: + application/json: + schema: + type: object + properties: + question: + type: string + description: The example question. + create_time: + type: string + format: date-time + description: Timestamp when this example was created. + example_id: + type: string + description: The universally unique identifier (UUID) of the example. + guidelines: + type: array + items: + type: string + description: >- + Guidelines for answering the question. Optional — examples + may be created with just a question; the front-end form does + not require guidelines. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + update_time: + type: string + format: date-time + description: Timestamp when this example was last updated. + required: + - question + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Example' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_list_examples + summary: Lists examples under a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Lists examples under a Knowledge Assistant. + + :param parent: str + Parent resource to list from. Format: knowledge-assistants/{knowledge_assistant_id} + :param page_size: int (optional) + The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The + maximum value is 100; values above 100 will be coerced to 100. + :param page_token: str (optional) + A page token, received from a previous ``ListExamples`` call. Provide this to retrieve the + subsequent page. If unspecified, the first page will be returned. + + :returns: Iterator over :class:`Example` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `parent` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). Parent resource + to list from. Format: knowledge-assistants/{knowledge_assistant_id} + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + The maximum number of examples to return. If unspecified, at most + 100 examples will be returned. The maximum value is 100; values + above 100 will be coerced to 100. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + A page token, received from a previous ``ListExamples`` call. + Provide this to retrieve the subsequent page. If unspecified, the + first page will be returned. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListExamplesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants: + post: + operationId: knowledge_assistants_create_knowledge_assistant + summary: Creates a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Creates a Knowledge Assistant. + + :param knowledge_assistant: :class:`KnowledgeAssistant` + The Knowledge Assistant to create. + + :returns: :class:`KnowledgeAssistant` + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + The display name of the Knowledge Assistant, unique at + workspace level. Required when creating a Knowledge + Assistant. When updating a Knowledge Assistant, optional + unless included in update_mask. + description: + type: string + description: >- + Description of what this agent can do (user-facing). + Required when creating a Knowledge Assistant. When updating + a Knowledge Assistant, optional unless included in + update_mask. + create_time: + type: string + format: date-time + description: Creation timestamp. + creator: + type: string + description: The creator of the Knowledge Assistant. + endpoint_name: + type: string + description: The name of the knowledge assistant agent endpoint. + error_info: + type: string + description: >- + Error details when the Knowledge Assistant is in FAILED + state. + experiment_id: + type: string + description: The MLflow experiment ID. + id: + type: string + description: 'Deprecated: use knowledge_assistant_id instead.' + instructions: + type: string + description: >- + Additional global instructions on how the agent should + generate answers. Optional on create and update. When + updating a Knowledge Assistant, include this field in + update_mask to modify it. + name: + type: string + description: >- + The resource name of the Knowledge Assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + state: + type: string + x-enum: + - ACTIVE + - CREATING + - FAILED + description: >- + State of the Knowledge Assistant. Not returned in List + responses. + required: + - display_name + - description + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistant' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_list_knowledge_assistants + summary: List Knowledge Assistants + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + List Knowledge Assistants + + :param page_size: int (optional) + The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge + assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100. + :param page_token: str (optional) + A page token, received from a previous ``ListKnowledgeAssistants`` call. Provide this to retrieve + the subsequent page. If unspecified, the first page will be returned. + + :returns: Iterator over :class:`KnowledgeAssistant` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + The maximum number of knowledge assistants to return. If + unspecified, at most 100 knowledge assistants will be returned. The + maximum value is 100; values above 100 will be coerced to 100. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + A page token, received from a previous ``ListKnowledgeAssistants`` + call. Provide this to retrieve the subsequent page. If unspecified, + the first page will be returned. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListKnowledgeAssistantsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants/{knowledge_assistant_id}/knowledge-sources: + post: + operationId: knowledge_assistants_create_knowledge_source + summary: Creates a Knowledge Source under a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Creates a Knowledge Source under a Knowledge Assistant. + + :param parent: str + Parent resource where this source will be created. Format: + knowledge-assistants/{knowledge_assistant_id} + :param knowledge_source: :class:`KnowledgeSource` + + :returns: :class:`KnowledgeSource` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `parent` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). Parent resource + where this source will be created. Format: + knowledge-assistants/{knowledge_assistant_id} + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + Human-readable display name of the knowledge source. + Required when creating a Knowledge Source. When updating a + Knowledge Source, optional unless included in update_mask. + description: + type: string + description: >- + Description of the knowledge source. Required when creating + a Knowledge Source. When updating a Knowledge Source, + optional unless included in update_mask. + source_type: + type: string + description: >- + The type of the source: "index", "files", or "file_table". + Required when creating a Knowledge Source. When updating a + Knowledge Source, this field is ignored. + create_time: + type: string + format: date-time + description: Timestamp when this knowledge source was created. + file_table: + type: object + properties: + table_name: + type: string + description: >- + Full UC name of the table, in the format of + {CATALOG}.{SCHEMA}.{TABLE_NAME}. + file_col: + type: string + description: >- + The name of the column containing BINARY file content to + be indexed. + required: + - table_name + - file_col + description: FileTableSpec specifies a file table source configuration. + files: + type: object + properties: + path: + type: string + description: A UC volume path that includes a list of files. + required: + - path + description: FilesSpec specifies a files source configuration. + id: + type: string + index: + type: object + properties: + index_name: + type: string + description: >- + Full UC name of the vector search index, in the format + of {CATALOG}.{SCHEMA}.{INDEX_NAME}. + text_col: + type: string + description: >- + The column that includes the document text for + retrieval. + doc_uri_col: + type: string + description: >- + The column that specifies a link or reference to where + the information came from. + required: + - index_name + - text_col + - doc_uri_col + description: >- + IndexSpec specifies a vector search index source + configuration. + knowledge_cutoff_time: + type: string + format: date-time + description: >- + Timestamp representing the cutoff before which content in + this knowledge source is being ingested. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + state: + type: string + x-enum: + - FAILED_UPDATE + - UPDATED + - UPDATING + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members + they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + required: + - display_name + - description + - source_type + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeSource' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_list_knowledge_sources + summary: Lists Knowledge Sources under a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Lists Knowledge Sources under a Knowledge Assistant. + + :param parent: str + Parent resource to list from. Format: knowledge-assistants/{knowledge_assistant_id} + :param page_size: int (optional) + :param page_token: str (optional) + + :returns: Iterator over :class:`KnowledgeSource` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `parent` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). Parent resource + to list from. Format: knowledge-assistants/{knowledge_assistant_id} + - name: page_size + in: query + required: false + schema: + type: integer + - name: page_token + in: query + required: false + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListKnowledgeSourcesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}: + delete: + operationId: knowledge_assistants_delete_example + summary: Deletes an example from a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Deletes an example from a Knowledge Assistant. + + :param name: str + The resource name of the example to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_get_example + summary: Gets an example from a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Gets an example from a Knowledge Assistant. + + :param name: str + The resource name of the example. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + + :returns: :class:`Example` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Example' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + patch: + operationId: knowledge_assistants_update_example + summary: Updates an example in a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Updates an example in a Knowledge Assistant. + + :param name: str + The resource name of the example to update. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + :param example: :class:`Example` + :param update_mask: FieldMask + Comma-delimited list of fields to update on the example. Allowed values: ``question``, + ``guidelines``. Examples: + + - ``question`` + - ``question,guidelines`` + + :returns: :class:`Example` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example to update. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}`). + The resource name of the example to update. Format: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Comma-delimited list of fields to update on the example. Allowed + values: ``question``, ``guidelines``. Examples: - ``question`` - + ``question,guidelines`` + requestBody: + content: + application/json: + schema: + type: object + properties: + question: + type: string + description: The example question. + create_time: + type: string + format: date-time + description: Timestamp when this example was created. + example_id: + type: string + description: The universally unique identifier (UUID) of the example. + guidelines: + type: array + items: + type: string + description: >- + Guidelines for answering the question. Optional — examples + may be created with just a question; the front-end form does + not require guidelines. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + update_time: + type: string + format: date-time + description: Timestamp when this example was last updated. + required: + - question + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Example' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants/{knowledge_assistant_id}: + delete: + operationId: knowledge_assistants_delete_knowledge_assistant + summary: Deletes a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Deletes a Knowledge Assistant. + + :param name: str + The resource name of the knowledge assistant to be deleted. Format: + knowledge-assistants/{knowledge_assistant_id} + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). The resource name + of the knowledge assistant to be deleted. Format: + knowledge-assistants/{knowledge_assistant_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_get_knowledge_assistant + summary: Gets a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Gets a Knowledge Assistant. + + :param name: str + The resource name of the knowledge assistant. Format: knowledge-assistants/{knowledge_assistant_id} + + :returns: :class:`KnowledgeAssistant` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). The resource name + of the knowledge assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistant' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + patch: + operationId: knowledge_assistants_update_knowledge_assistant + summary: Updates a Knowledge Assistant. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Updates a Knowledge Assistant. + + :param name: str + The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id} + :param knowledge_assistant: :class:`KnowledgeAssistant` + The Knowledge Assistant update payload. Only fields listed in update_mask are updated. REQUIRED + annotations on Knowledge Assistant fields describe create-time requirements and do not mean all + those fields are required for update. + :param update_mask: FieldMask + Comma-delimited list of fields to update on the Knowledge Assistant. Allowed values: + ``display_name``, ``description``, ``instructions``. Examples: + + - ``display_name`` + - ``description,instructions`` + + :returns: :class:`KnowledgeAssistant` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). The resource name + of the Knowledge Assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Comma-delimited list of fields to update on the Knowledge Assistant. + Allowed values: ``display_name``, ``description``, ``instructions``. + Examples: - ``display_name`` - ``description,instructions`` + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + The display name of the Knowledge Assistant, unique at + workspace level. Required when creating a Knowledge + Assistant. When updating a Knowledge Assistant, optional + unless included in update_mask. + description: + type: string + description: >- + Description of what this agent can do (user-facing). + Required when creating a Knowledge Assistant. When updating + a Knowledge Assistant, optional unless included in + update_mask. + create_time: + type: string + format: date-time + description: Creation timestamp. + creator: + type: string + description: The creator of the Knowledge Assistant. + endpoint_name: + type: string + description: The name of the knowledge assistant agent endpoint. + error_info: + type: string + description: >- + Error details when the Knowledge Assistant is in FAILED + state. + experiment_id: + type: string + description: The MLflow experiment ID. + id: + type: string + description: 'Deprecated: use knowledge_assistant_id instead.' + instructions: + type: string + description: >- + Additional global instructions on how the agent should + generate answers. Optional on create and update. When + updating a Knowledge Assistant, include this field in + update_mask to modify it. + name: + type: string + description: >- + The resource name of the Knowledge Assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + state: + type: string + x-enum: + - ACTIVE + - CREATING + - FAILED + description: >- + State of the Knowledge Assistant. Not returned in List + responses. + required: + - display_name + - description + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistant' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}: + delete: + operationId: knowledge_assistants_delete_knowledge_source + summary: Deletes a Knowledge Source. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Deletes a Knowledge Source. + + :param name: str + The resource name of the Knowledge Source to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + - name: knowledge_source_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_source_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source to delete. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + get: + operationId: knowledge_assistants_get_knowledge_source + summary: Gets a Knowledge Source. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Gets a Knowledge Source. + + :param name: str + The resource name of the Knowledge Source. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + + :returns: :class:`KnowledgeSource` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + - name: knowledge_source_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_source_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeSource' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + patch: + operationId: knowledge_assistants_update_knowledge_source + summary: Updates a Knowledge Source. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Updates a Knowledge Source. + + :param name: str + The resource name of the Knowledge Source to update. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + :param knowledge_source: :class:`KnowledgeSource` + The Knowledge Source update payload. Only fields listed in update_mask are updated. REQUIRED + annotations on Knowledge Source fields describe create-time requirements and do not mean all those + fields are required for update. + :param update_mask: FieldMask + Comma-delimited list of fields to update on the Knowledge Source. Allowed values: ``display_name``, + ``description``. Examples: + + - ``display_name`` + - ``display_name,description`` + + :returns: :class:`KnowledgeSource` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source to update. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + - name: knowledge_source_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_source_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}`). + The resource name of the Knowledge Source to update. Format: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Comma-delimited list of fields to update on the Knowledge Source. + Allowed values: ``display_name``, ``description``. Examples: - + ``display_name`` - ``display_name,description`` + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + description: >- + Human-readable display name of the knowledge source. + Required when creating a Knowledge Source. When updating a + Knowledge Source, optional unless included in update_mask. + description: + type: string + description: >- + Description of the knowledge source. Required when creating + a Knowledge Source. When updating a Knowledge Source, + optional unless included in update_mask. + source_type: + type: string + description: >- + The type of the source: "index", "files", or "file_table". + Required when creating a Knowledge Source. When updating a + Knowledge Source, this field is ignored. + create_time: + type: string + format: date-time + description: Timestamp when this knowledge source was created. + file_table: + type: object + properties: + table_name: + type: string + description: >- + Full UC name of the table, in the format of + {CATALOG}.{SCHEMA}.{TABLE_NAME}. + file_col: + type: string + description: >- + The name of the column containing BINARY file content to + be indexed. + required: + - table_name + - file_col + description: FileTableSpec specifies a file table source configuration. + files: + type: object + properties: + path: + type: string + description: A UC volume path that includes a list of files. + required: + - path + description: FilesSpec specifies a files source configuration. + id: + type: string + index: + type: object + properties: + index_name: + type: string + description: >- + Full UC name of the vector search index, in the format + of {CATALOG}.{SCHEMA}.{INDEX_NAME}. + text_col: + type: string + description: >- + The column that includes the document text for + retrieval. + doc_uri_col: + type: string + description: >- + The column that specifies a link or reference to where + the information came from. + required: + - index_name + - text_col + - doc_uri_col + description: >- + IndexSpec specifies a vector search index source + configuration. + knowledge_cutoff_time: + type: string + format: date-time + description: >- + Timestamp representing the cutoff before which content in + this knowledge source is being ingested. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + state: + type: string + x-enum: + - FAILED_UPDATE + - UPDATED + - UPDATING + description: >- + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members + they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can have + their own + + attributes -- see the documentation for details. + required: + - display_name + - description + - source_type + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeSource' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}/permissionLevels: + get: + operationId: knowledge_assistants_get_permission_levels + summary: Gets the permission levels that a user can have on an object. + tags: + - knowledgeassistants + - knowledge_assistants + description: |- + Gets the permission levels that a user can have on an object. + + :param knowledge_assistant_id: str + The knowledge assistant for which to get or manage permissions. + + :returns: :class:`GetKnowledgeAssistantPermissionLevelsResponse` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: The knowledge assistant for which to get or manage permissions. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/GetKnowledgeAssistantPermissionLevelsResponse + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}: + get: + operationId: knowledge_assistants_get_permissions + summary: >- + Gets the permissions of a knowledge assistant. Knowledge assistants can + inherit permissions from their + tags: + - knowledgeassistants + - knowledge_assistants + description: >- + Gets the permissions of a knowledge assistant. Knowledge assistants can + inherit permissions from their + + root object. + + + :param knowledge_assistant_id: str + The knowledge assistant for which to get or manage permissions. + + :returns: :class:`KnowledgeAssistantPermissions` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: The knowledge assistant for which to get or manage permissions. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistantPermissions' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + put: + operationId: knowledge_assistants_set_permissions + summary: >- + Sets permissions on an object, replacing existing permissions if they + exist. Deletes all direct + tags: + - knowledgeassistants + - knowledge_assistants + description: >- + Sets permissions on an object, replacing existing permissions if they + exist. Deletes all direct + + permissions if none are specified. Objects can inherit permissions from + their root object. + + + :param knowledge_assistant_id: str + The knowledge assistant for which to get or manage permissions. + :param access_control_list: + List[:class:`KnowledgeAssistantAccessControlRequest`] (optional) + + + :returns: :class:`KnowledgeAssistantPermissions` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: The knowledge assistant for which to get or manage permissions. + requestBody: + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: array + items: + type: object + properties: + group_name: + type: string + permission_level: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + description: Permission level + service_principal_name: + type: string + description: application ID of a service principal + user_name: + type: string + description: name of the user + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistantPermissions' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + patch: + operationId: knowledge_assistants_update_permissions + summary: >- + Updates the permissions on a knowledge assistant. Knowledge assistants + can inherit permissions from + tags: + - knowledgeassistants + - knowledge_assistants + description: >- + Updates the permissions on a knowledge assistant. Knowledge assistants + can inherit permissions from + + their root object. + + + :param knowledge_assistant_id: str + The knowledge assistant for which to get or manage permissions. + :param access_control_list: + List[:class:`KnowledgeAssistantAccessControlRequest`] (optional) + + + :returns: :class:`KnowledgeAssistantPermissions` + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: The knowledge assistant for which to get or manage permissions. + requestBody: + content: + application/json: + schema: + type: object + properties: + access_control_list: + type: array + items: + type: object + properties: + group_name: + type: string + permission_level: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + description: Permission level + service_principal_name: + type: string + description: application ID of a service principal + user_name: + type: string + description: name of the user + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/KnowledgeAssistantPermissions' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI + /api/2.1/knowledge-assistants/{knowledge_assistant_id}/knowledge-sources:sync: + post: + operationId: knowledge_assistants_sync_knowledge_sources + summary: >- + Sync all non-index Knowledge Sources for a Knowledge Assistant (index + sources do not require sync) + tags: + - knowledgeassistants + - knowledge_assistants + description: >- + Sync all non-index Knowledge Sources for a Knowledge Assistant (index + sources do not require sync) + + + :param name: str + The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id} + parameters: + - name: knowledge_assistant_id + in: path + required: true + schema: + type: string + description: >- + The `knowledge_assistant_id` segment of the `name` resource name + (`knowledge-assistants/{knowledge_assistant_id}`). The resource name + of the Knowledge Assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: KnowledgeAssistantsAPI +components: + schemas: + Example: + type: object + properties: + question: + type: string + description: The example question. + create_time: + type: string + format: date-time + description: Timestamp when this example was created. + example_id: + type: string + description: The universally unique identifier (UUID) of the example. + guidelines: + type: array + items: + type: string + description: >- + Guidelines for answering the question. Optional — examples may be + created with just a question; the front-end form does not require + guidelines. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + update_time: + type: string + format: date-time + description: Timestamp when this example was last updated. + required: + - question + description: >- + An example associated with a Knowledge Assistant. Contains a question + and guidelines for how the + assistant should respond. + FileTableSpec: + type: object + properties: + table_name: + type: string + description: >- + Full UC name of the table, in the format of + {CATALOG}.{SCHEMA}.{TABLE_NAME}. + file_col: + type: string + description: The name of the column containing BINARY file content to be indexed. + required: + - table_name + - file_col + description: FileTableSpec specifies a file table source configuration. + FilesSpec: + type: object + properties: + path: + type: string + description: A UC volume path that includes a list of files. + required: + - path + description: FilesSpec specifies a files source configuration. + GetKnowledgeAssistantPermissionLevelsResponse: + type: object + properties: + permission_levels: + type: array + items: + $ref: '#/components/schemas/KnowledgeAssistantPermissionsDescription' + IndexSpec: + type: object + properties: + index_name: + type: string + description: >- + Full UC name of the vector search index, in the format of + {CATALOG}.{SCHEMA}.{INDEX_NAME}. + text_col: + type: string + description: The column that includes the document text for retrieval. + doc_uri_col: + type: string + description: >- + The column that specifies a link or reference to where the + information came from. + required: + - index_name + - text_col + - doc_uri_col + description: IndexSpec specifies a vector search index source configuration. + KnowledgeAssistant: + type: object + properties: + display_name: + type: string + description: >- + The display name of the Knowledge Assistant, unique at workspace + level. Required when creating a Knowledge Assistant. When updating a + Knowledge Assistant, optional unless included in update_mask. + description: + type: string + description: >- + Description of what this agent can do (user-facing). Required when + creating a Knowledge Assistant. When updating a Knowledge Assistant, + optional unless included in update_mask. + create_time: + type: string + format: date-time + description: Creation timestamp. + creator: + type: string + description: The creator of the Knowledge Assistant. + endpoint_name: + type: string + description: The name of the knowledge assistant agent endpoint. + error_info: + type: string + description: Error details when the Knowledge Assistant is in FAILED state. + experiment_id: + type: string + description: The MLflow experiment ID. + id: + type: string + description: 'Deprecated: use knowledge_assistant_id instead.' + instructions: + type: string + description: >- + Additional global instructions on how the agent should generate + answers. Optional on create and update. When updating a Knowledge + Assistant, include this field in update_mask to modify it. + name: + type: string + description: >- + The resource name of the Knowledge Assistant. Format: + knowledge-assistants/{knowledge_assistant_id} + state: + $ref: '#/components/schemas/KnowledgeAssistantState' + description: State of the Knowledge Assistant. Not returned in List responses. + required: + - display_name + - description + description: >- + Entity message that represents a knowledge assistant. Note: REQUIRED + annotations below represent + create-time requirements. For updates, required fields are determined by the update mask. + KnowledgeAssistantAccessControlRequest: + type: object + properties: + group_name: + type: string + permission_level: + $ref: '#/components/schemas/KnowledgeAssistantPermissionLevel' + service_principal_name: + type: string + description: application ID of a service principal + user_name: + type: string + description: name of the user + KnowledgeAssistantAccessControlResponse: + type: object + properties: + all_permissions: + type: array + items: + $ref: '#/components/schemas/KnowledgeAssistantPermission' + display_name: + type: string + description: Display name of the user or service principal. + group_name: + type: string + description: name of the group + service_principal_name: + type: string + description: Name of the service principal. + user_name: + type: string + description: name of the user + KnowledgeAssistantPermission: + type: object + properties: + inherited: + type: boolean + inherited_from_object: + type: array + items: + type: string + permission_level: + $ref: '#/components/schemas/KnowledgeAssistantPermissionLevel' + KnowledgeAssistantPermissions: + type: object + properties: + access_control_list: + type: array + items: + $ref: '#/components/schemas/KnowledgeAssistantAccessControlResponse' + object_id: + type: string + object_type: + type: string + KnowledgeAssistantPermissionsDescription: + type: object + properties: + description: + type: string + permission_level: + $ref: '#/components/schemas/KnowledgeAssistantPermissionLevel' + KnowledgeSource: + type: object + properties: + display_name: + type: string + description: >- + Human-readable display name of the knowledge source. Required when + creating a Knowledge Source. When updating a Knowledge Source, + optional unless included in update_mask. + description: + type: string + description: >- + Description of the knowledge source. Required when creating a + Knowledge Source. When updating a Knowledge Source, optional unless + included in update_mask. + source_type: + type: string + description: >- + The type of the source: "index", "files", or "file_table". Required + when creating a Knowledge Source. When updating a Knowledge Source, + this field is ignored. + create_time: + type: string + format: date-time + description: Timestamp when this knowledge source was created. + file_table: + $ref: '#/components/schemas/FileTableSpec' + files: + $ref: '#/components/schemas/FilesSpec' + id: + type: string + index: + $ref: '#/components/schemas/IndexSpec' + knowledge_cutoff_time: + type: string + format: date-time + description: >- + Timestamp representing the cutoff before which content in this + knowledge source is being ingested. + name: + type: string + description: >- + Full resource name: + knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + state: + $ref: '#/components/schemas/KnowledgeSourceState' + required: + - display_name + - description + - source_type + description: >- + KnowledgeSource represents a source of knowledge for the + KnowledgeAssistant. Used in + create/update requests and returned in Get/List responses. Note: REQUIRED annotations below + represent create-time requirements. For updates, required fields are determined by the update + mask. + ListExamplesResponse: + type: object + properties: + examples: + type: array + items: + $ref: '#/components/schemas/Example' + next_page_token: + type: string + description: A list of Knowledge Assistant examples. + ListKnowledgeAssistantsResponse: + type: object + properties: + knowledge_assistants: + type: array + items: + $ref: '#/components/schemas/KnowledgeAssistant' + next_page_token: + type: string + description: >- + A token that can be sent as ``page_token`` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + description: A list of Knowledge Assistants. + ListKnowledgeSourcesResponse: + type: object + properties: + knowledge_sources: + type: array + items: + $ref: '#/components/schemas/KnowledgeSource' + next_page_token: + type: string + KnowledgeAssistantPermissionLevel: + type: string + x-enum: + - CAN_MANAGE + - CAN_QUERY + description: Permission level + KnowledgeAssistantState: + type: string + x-enum: + - ACTIVE + - CREATING + - FAILED + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + KnowledgeSourceState: + type: string + x-enum: + - FAILED_UPDATE + - UPDATED + - UPDATING + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + x-stackQL-resources: + examples: + id: databricks_workspace.knowledgeassistants.examples + name: examples + title: Examples + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1examples/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1examples/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.examples + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1examples~1{example_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1examples~1{example_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1examples~1{example_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/examples/methods/get' + - $ref: '#/components/x-stackQL-resources/examples/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/examples/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/examples/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/examples/methods/delete' + replace: [] + knowledge_assistants: + id: databricks_workspace.knowledgeassistants.knowledge_assistants + name: knowledge_assistants + title: Knowledge Assistants + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.1~1knowledge-assistants/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.1~1knowledge-assistants/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.knowledge_assistants + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/knowledge_assistants/methods/get' + - $ref: '#/components/x-stackQL-resources/knowledge_assistants/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistants/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistants/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistants/methods/delete + replace: [] + knowledge_sources: + id: databricks_workspace.knowledgeassistants.knowledge_sources + name: knowledge_sources + title: Knowledge Sources + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.knowledge_sources + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources~1{knowledge_source_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources~1{knowledge_source_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources~1{knowledge_source_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sync: + operation: + $ref: >- + #/paths/~1api~12.1~1knowledge-assistants~1{knowledge_assistant_id}~1knowledge-sources:sync/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/knowledge_sources/methods/get' + - $ref: '#/components/x-stackQL-resources/knowledge_sources/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/knowledge_sources/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/knowledge_sources/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/knowledge_sources/methods/delete' + replace: [] + knowledge_assistant_permission_levels: + id: >- + databricks_workspace.knowledgeassistants.knowledge_assistant_permission_levels + name: knowledge_assistant_permission_levels + title: Knowledge Assistant Permission Levels + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1permissions~1knowledge-assistants~1{knowledge_assistant_id}~1permissionLevels/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistant_permission_levels/methods/get + insert: [] + update: [] + delete: [] + replace: [] + knowledge_assistant_permissions: + id: databricks_workspace.knowledgeassistants.knowledge_assistant_permissions + name: knowledge_assistant_permissions + title: Knowledge Assistant Permissions + methods: + get: + operation: + $ref: >- + #/paths/~1api~12.0~1permissions~1knowledge-assistants~1{knowledge_assistant_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + set: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1permissions~1knowledge-assistants~1{knowledge_assistant_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1permissions~1knowledge-assistants~1{knowledge_assistant_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistant_permissions/methods/get + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistant_permissions/methods/update + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/knowledge_assistant_permissions/methods/set +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml index 4829b2be..a0377c82 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml @@ -6,14 +6,31 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.marketplace servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.1/marketplace-consumer/listings/{listing_id}/content: get: @@ -137,26 +154,17 @@ paths: tags: - marketplace - consumer_installations - description: >- + description: |- Install payload associated with a Databricks Marketplace listing. - :param listing_id: str - :param accepted_consumer_terms: :class:`ConsumerTerms` (optional) - :param catalog_name: str (optional) - - :param mcp_connection_detail: :class:`InstallListingMcpConnectionDetail` - (optional) - :param recipient_type: :class:`DeltaSharingRecipientType` (optional) - :param repo_detail: :class:`RepoInstallation` (optional) for git repo installations :param share_name: str (optional) - :returns: :class:`Installation` parameters: - name: listing_id @@ -179,65 +187,6 @@ paths: - version catalog_name: type: string - mcp_connection_detail: - type: object - properties: - connection_name: - type: string - description: >- - Name of the Unity Catalog connection to create for the - MCP server. - base_path: - type: string - description: >- - Optional override of the MCP server base path. Defaults - to the base path on the listing. - bearer_token: - type: string - description: >- - Bearer token supplied by the consumer, for bearer-token - authentication. - catalog: - type: string - description: >- - Catalog the MCP service (and its schema-scoped UC - connection) is created under. The consumer must hold the - privileges to create a service and connection in this - catalog/schema. - host: - type: string - description: >- - Optional override of the MCP server host. Defaults to - the host configured on the listing. - oauth_credentials: - type: object - properties: - client_id: - type: string - description: >- - OAuth client id. Identifies the credential; not the - secret itself. - client_secret: - type: string - description: OAuth client secret supplied by the consumer. - required: - - client_id - - client_secret - description: >- - OAuth client credentials supplied by the consumer, for - OAuth (U2M/M2M) authentication. - schema: - type: string - description: >- - Schema (within ``catalog``) the MCP service and its UC - connection are created under. - required: - - connection_name - description: >- - Consumer-supplied details for creating the Unity Catalog - HTTP connection when installing an MCP - listing. Values the provider configures on the listing (port, credential type, OAuth - token/authorization endpoints, scope, exchange method) are not repeated here. recipient_type: type: string x-enum: @@ -2427,11 +2376,8 @@ paths: type: string x-enum: - APP - - COMMIT_DRAWDOWN_REQUEST_ATTACHMENT - - EMBEDDED_MARKDOWN - EMBEDDED_NOTEBOOK - PROVIDER_ICON - - SCREENSHOT description: >- Create a collection of name/value pairs. @@ -2732,7 +2678,6 @@ paths: - LOOKUP_TABLES - MANUFACTURING - MEDIA - - OPEN_SOURCE - OTHER - PUBLIC_SECTOR - RETAIL @@ -3220,11 +3165,8 @@ paths: type: string x-enum: - APP - - COMMIT_DRAWDOWN_REQUEST_ATTACHMENT - - EMBEDDED_MARKDOWN - EMBEDDED_NOTEBOOK - PROVIDER_ICON - - SCREENSHOT description: >- Create a collection of name/value pairs. @@ -3284,7 +3226,6 @@ paths: status: type: string x-enum: - - FILE_STATUS_COMMIT_DRAWDOWN - FILE_STATUS_PUBLISHED - FILE_STATUS_SANITIZATION_FAILED - FILE_STATUS_SANITIZING @@ -3737,7 +3678,6 @@ paths: - LOOKUP_TABLES - MANUFACTURING - MEDIA - - OPEN_SOURCE - OTHER - PUBLIC_SECTOR - RETAIL @@ -4225,11 +4165,8 @@ paths: type: string x-enum: - APP - - COMMIT_DRAWDOWN_REQUEST_ATTACHMENT - - EMBEDDED_MARKDOWN - EMBEDDED_NOTEBOOK - PROVIDER_ICON - - SCREENSHOT description: >- Create a collection of name/value pairs. @@ -4289,7 +4226,6 @@ paths: status: type: string x-enum: - - FILE_STATUS_COMMIT_DRAWDOWN - FILE_STATUS_PUBLISHED - FILE_STATUS_SANITIZATION_FAILED - FILE_STATUS_SANITIZING @@ -5541,64 +5477,6 @@ components: properties: provider: $ref: '#/components/schemas/ProviderInfo' - InstallListingMcpConnectionDetail: - type: object - properties: - connection_name: - type: string - description: Name of the Unity Catalog connection to create for the MCP server. - base_path: - type: string - description: >- - Optional override of the MCP server base path. Defaults to the base - path on the listing. - bearer_token: - type: string - description: >- - Bearer token supplied by the consumer, for bearer-token - authentication. - catalog: - type: string - description: >- - Catalog the MCP service (and its schema-scoped UC connection) is - created under. The consumer must hold the privileges to create a - service and connection in this catalog/schema. - host: - type: string - description: >- - Optional override of the MCP server host. Defaults to the host - configured on the listing. - oauth_credentials: - $ref: >- - #/components/schemas/InstallListingMcpConnectionDetailOauthCredentials - description: >- - OAuth client credentials supplied by the consumer, for OAuth - (U2M/M2M) authentication. - schema: - type: string - description: >- - Schema (within ``catalog``) the MCP service and its UC connection - are created under. - required: - - connection_name - description: >- - Consumer-supplied details for creating the Unity Catalog HTTP connection - when installing an MCP - listing. Values the provider configures on the listing (port, credential type, OAuth - token/authorization endpoints, scope, exchange method) are not repeated here. - InstallListingMcpConnectionDetailOauthCredentials: - type: object - properties: - client_id: - type: string - description: OAuth client id. Identifies the credential; not the secret itself. - client_secret: - type: string - description: OAuth client secret supplied by the consumer. - required: - - client_id - - client_secret - description: OAuth client credentials supplied by the consumer for an MCP connection. Installation: type: object properties: @@ -6206,7 +6084,6 @@ components: - LOOKUP_TABLES - MANUFACTURING - MEDIA - - OPEN_SOURCE - OTHER - PUBLIC_SECTOR - RETAIL @@ -6472,7 +6349,6 @@ components: FileStatus: type: string x-enum: - - FILE_STATUS_COMMIT_DRAWDOWN - FILE_STATUS_PUBLISHED - FILE_STATUS_SANITIZATION_FAILED - FILE_STATUS_SANITIZING @@ -6736,11 +6612,8 @@ components: type: string x-enum: - APP - - COMMIT_DRAWDOWN_REQUEST_ATTACHMENT - - EMBEDDED_MARKDOWN - EMBEDDED_NOTEBOOK - PROVIDER_ICON - - SCREENSHOT description: |- Create a collection of name/value pairs. diff --git a/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml b/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml index 1d57a795..a10ed977 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml @@ -6,14 +6,31 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.ml servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/mlflow/experiments/create: post: @@ -157,6 +174,160 @@ paths: message: type: string x-stackql-sdk-source: ExperimentsAPI + /api/2.0/mlflow/experiments/{experiment}/issues: + post: + operationId: experiments_create_issue + summary: Creates an issue in an experiment. + tags: + - ml + - experiments + description: |- + Creates an issue in an experiment. + + :param parent: str + experiments/{experiment} + :param issue: :class:`Issue` + Output-only fields are ignored. + :param issue_id: str (optional) + Optional client-chosen ID: iss- followed by 32 lowercase hex digits. A retry with the same ID fails + with ALREADY_EXISTS rather than making a duplicate. The server generates one if unset. + + :returns: :class:`Issue` + parameters: + - name: experiment + in: path + required: true + schema: + type: string + description: >- + The `experiment` segment of the `parent` resource name + (`experiments/{experiment}`). experiments/{experiment} + - name: issue_id + in: query + required: false + schema: + type: string + description: >- + Optional client-chosen ID: iss- followed by 32 lowercase hex digits. + A retry with the same ID fails with ALREADY_EXISTS rather than + making a duplicate. The server generates one if unset. + requestBody: + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: Non-empty, at most 250 UTF-8 bytes. + severity: + type: string + x-enum: + - HIGH + - LOW + - MEDIUM + description: >- + Cannot be cleared: an Issue without a severity would match + no severity filter. + categories: + type: array + items: + type: string + description: >- + At most 10 values of at most 64 UTF-8 bytes each, unique + case-insensitively. Leading and trailing whitespace is + trimmed. + create_time: + type: string + format: date-time + description: When the Issue was created. + created_by: + type: string + description: >- + The email of the user whose request created the Issue. + source_type tells whether issue detection created it. + description: + type: string + description: Markdown, at most 32 KiB. + issue_id: + type: string + description: >- + The last segment of ``name``. Issue assessments on traces + reference the Issue by this ID. + last_seen_time: + type: string + format: date-time + description: >- + The request time of the latest trace the Issue affects. + Required, and can't be cleared, unless source_type is + MANUAL. A MANUAL Issue without one returns its create_time. + last_updated_by: + type: string + description: The email of the user whose request last updated the Issue. + metadata: + type: object + description: >- + Additional details about the Issue, such as how issue + detection observed it. Not a stable contract: keys and + values can change without notice, so clients must tolerate + unknown and missing keys. At most 20 entries, with keys of + at most 64 UTF-8 bytes. + name: + type: string + description: experiments/{experiment}/issues/{issue} + source_id: + type: string + description: >- + Set once at create. For ADHOC_RUN and SCHEDULED_RUN, the ID + of the issue detection run in the same experiment that + created the Issue. Absent for MANUAL. + source_type: + type: string + x-enum: + - ADHOC_RUN + - MANUAL + - SCHEDULED_RUN + - SINGLE_TRACE_ANALYSIS + description: Set once at create. Defaults to MANUAL. + status: + type: string + x-enum: + - PENDING + - REJECTED + - RESOLVED + description: Defaults to PENDING on create, and can't be cleared. + tags: + type: object + description: >- + Caller-owned; the server never writes system values here. At + most 10 entries. Keys match ^[A-Za-z0-9_.:/-]+$ and are at + most 128 UTF-8 bytes; values are at most 256 UTF-8 bytes. + update_time: + type: string + format: date-time + description: When the Issue was last updated. + required: + - title + - severity + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Issue' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: ExperimentsAPI /api/2.0/mlflow/logged-models: post: operationId: experiments_create_logged_model @@ -606,10 +777,10 @@ paths: Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at - most max_runs per request. To call this API from a Databricks Notebook - in Python, you can use the + most max_runs per request. See the cloud-specific MLflow runs + documentation for a Python client - client code snippet on + example. :param experiment_id: str @@ -897,36 +1068,117 @@ paths: message: type: string x-stackql-sdk-source: ExperimentsAPI - /api/2.0/mlflow/logged-models:batchGet: + /api/2.0/mlflow/experiments/{experiment}/issues/{issue}: get: - operationId: experiments_get_logged_models - summary: Batch endpoint for getting logged models from a list of model IDs + operationId: experiments_get_issue + summary: Gets an issue. tags: - ml - experiments description: |- - Batch endpoint for getting logged models from a list of model IDs + Gets an issue. - :param model_ids: List[str] (optional) - The IDs of the logged models to retrieve. Max threshold is 100. + :param name: str + experiments/{experiment}/issues/{issue} + + :returns: :class:`Issue` + parameters: + - name: experiment + in: path + required: true + schema: + type: string + description: >- + The `experiment` segment of the `name` resource name + (`experiments/{experiment}/issues/{issue}`). + experiments/{experiment}/issues/{issue} + - name: issue + in: path + required: true + schema: + type: string + description: >- + The `issue` segment of the `name` resource name + (`experiments/{experiment}/issues/{issue}`). + experiments/{experiment}/issues/{issue} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Issue' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: ExperimentsAPI + patch: + operationId: experiments_update_issue + summary: Updates the fields of an issue named in ``update_mask``. + tags: + - ml + - experiments + description: |- + Updates the fields of an issue named in ``update_mask``. - :returns: :class:`GetLoggedModelsRequestResponse` + :param name: str + experiments/{experiment}/issues/{issue} + :param issue: :class:`Issue` + ``issue.name`` identifies the target. + :param update_mask: FieldMask + Accepts title, description, status, severity, categories, tags, last_seen_time, and metadata.. + A path with an empty value clears the field, except that title, status, and severity can't be + cleared, and last_seen_time can be cleared only when source_type is MANUAL. categories and tags are + replaced whole. metadata is updated per key: a metadata. path sets that key from + issue.metadata, or removes it when issue.metadata lacks it, and leaves the other keys alone. A bare + metadata path is rejected. + + :returns: :class:`Issue` parameters: - - name: model_ids + - name: experiment + in: path + required: true + schema: + type: string + description: >- + The `experiment` segment of the `name` resource name + (`experiments/{experiment}/issues/{issue}`). + experiments/{experiment}/issues/{issue} + - name: issue + in: path + required: true + schema: + $ref: '#/components/schemas/Issue' + description: '``issue.name`` identifies the target.' + - name: update_mask in: query - required: false + required: true schema: - type: array - items: - type: string - description: The IDs of the logged models to retrieve. Max threshold is 100. + type: object + description: >- + Accepts title, description, status, severity, categories, tags, + last_seen_time, and metadata.. A path with an empty value + clears the field, except that title, status, and severity can't be + cleared, and last_seen_time can be cleared only when source_type is + MANUAL. categories and tags are replaced whole. metadata is updated + per key: a metadata. path sets that key from issue.metadata, or + removes it when issue.metadata lacks it, and leaves the other keys + alone. A bare metadata path is rejected. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/GetLoggedModelsRequestResponse' + $ref: '#/components/schemas/Issue' default: description: Error response content: @@ -2157,10 +2409,10 @@ paths: Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores - at most max_runs per request. To call this API from a Databricks - Notebook in Python, you can use the + at most max_runs per request. See the cloud-specific MLflow runs + documentation for a Python client - client code snippet on + example. :param experiment_id: str @@ -2296,6 +2548,162 @@ paths: message: type: string x-stackql-sdk-source: ExperimentsAPI + /api/2.0/mlflow/experiments/{experiment}/issues:search: + post: + operationId: experiments_search_issues + summary: Searches the issues in an experiment, filtered and sorted. + tags: + - ml + - experiments + description: |- + Searches the issues in an experiment, filtered and sorted. + + :param parent: str + experiments/{experiment} + :param categories: List[str] (optional) + Matches Issues with any of these categories, case-insensitively. + :param page_size: int (optional) + Defaults to 20; values above 100 are clamped. + :param page_token: str (optional) + Expires after 15 minutes. Every other argument except ``view`` must match the request that returned + the token. + :param query: str (optional) + Case-insensitive substring match on title. + :param severities: List[:class:`IssueSeverity`] (optional) + Matches Issues with any of these severities. + :param sort_key: :class:`IssueSortKey` (optional) + Defaults to SEVERITY. + :param sort_order: :class:`SortOrder` (optional) + Defaults to DESCENDING. + :param statuses: List[:class:`IssueStatus`] (optional) + Matches Issues with any of these statuses. Different filters AND together, and an empty filter + matches every Issue. + :param tag_filters: List[:class:`IssueTagFilter`] (optional) + Matches Issues that satisfy every filter. At most 10 filters of 20 values each. + :param view: :class:`IssueView` (optional) + Defaults to BASIC. + + :returns: Iterator over :class:`Issue` + parameters: + - name: experiment + in: path + required: true + schema: + type: string + description: >- + The `experiment` segment of the `parent` resource name + (`experiments/{experiment}`). experiments/{experiment} + requestBody: + content: + application/json: + schema: + type: object + properties: + categories: + type: array + items: + type: string + description: >- + Matches Issues with any of these categories, + case-insensitively. + page_size: + type: integer + description: Defaults to 20; values above 100 are clamped. + page_token: + type: string + description: >- + Expires after 15 minutes. Every other argument except + ``view`` must match the request that returned the token. + query: + type: string + description: Case-insensitive substring match on title. + severities: + type: array + items: + type: string + x-enum: + - HIGH + - LOW + - MEDIUM + description: How serious an Issue is, ordered LOW < MEDIUM < HIGH. + description: Matches Issues with any of these severities. + sort_key: + type: string + x-enum: + - CREATE_TIME + - LAST_SEEN_TIME + - SEVERITY + - UPDATE_TIME + description: Defaults to SEVERITY. + sort_order: + type: string + x-enum: + - ASCENDING + - DESCENDING + description: Defaults to DESCENDING. + statuses: + type: array + items: + type: string + x-enum: + - PENDING + - REJECTED + - RESOLVED + description: >- + The triage status of an Issue: PENDING means open and + awaiting triage, RESOLVED means judged + + real and addressed, and REJECTED means judged not to be an + issue. + description: >- + Matches Issues with any of these statuses. Different filters + AND together, and an empty filter matches every Issue. + tag_filters: + type: array + items: + type: object + properties: + key: + type: string + description: Matched exactly. + values: + type: array + items: + type: string + description: >- + Matched exactly, and ORed together. Empty matches any + Issue carrying the key. + required: + - key + description: One predicate over Issue.tags. + description: >- + Matches Issues that satisfy every filter. At most 10 filters + of 20 values each. + view: + type: string + x-enum: + - BASIC + - FULL + description: Defaults to BASIC. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SearchIssuesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: ExperimentsAPI /api/2.0/mlflow/logged-models/search: post: operationId: experiments_search_logged_models @@ -2832,6 +3240,108 @@ paths: message: type: string x-stackql-sdk-source: ExperimentsAPI + /api/2.0/feature-engineering/features:backfill: + post: + operationId: feature_engineering_backfill_features + summary: Backfill features. + tags: + - ml + - feature_engineering + description: |- + Backfill features. + + :param feature_full_names: List[str] + Full names of the features to backfill. + :param backfill_ranges: List[:class:`BackfillRange`] + Output ranges to backfill. + :param budget_policy_id: str (optional) + The budget policy ID, in UUID format, used to attribute the serverless compute cost of this + backfill. If not specified, a default budget policy may be applied. + :param request_id: str (optional) + Idempotency token for the request. + :param tags: Dict[str,str] (optional) + Custom tags to associate with this backfill. They are applied to the backfill job and forwarded to + the underlying compute as Databricks resource tags, so backfill cost can be attributed in the + billing system tables. These tags apply only to the backfill compute; they are not applied to the + Unity Catalog Feature resources themselves, whose tags are managed separately through the Unity + Catalog tagging API. A maximum of 25 tags is supported; keys and values are subject to the same + limitations as Databricks resource tags. + + :returns: :class:`Operation` + requestBody: + content: + application/json: + schema: + type: object + properties: + feature_full_names: + type: array + items: + type: string + description: Full names of the features to backfill. + backfill_ranges: + type: array + items: + type: object + properties: + end_time: + type: string + format: date-time + description: >- + End of the backfill range, exclusive. If unset, + defaults to the current time. + start_time: + type: string + format: date-time + description: >- + Start of the backfill range, inclusive. If unset, + defaults to the earliest source timestamp of the + feature. + description: A time range for a backfill. + description: Output ranges to backfill. + budget_policy_id: + type: string + description: >- + The budget policy ID, in UUID format, used to attribute the + serverless compute cost of this backfill. If not specified, + a default budget policy may be applied. + request_id: + type: string + description: Idempotency token for the request. + tags: + type: object + description: >- + Custom tags to associate with this backfill. They are + applied to the backfill job and forwarded to the underlying + compute as Databricks resource tags, so backfill cost can be + attributed in the billing system tables. These tags apply + only to the backfill compute; they are not applied to the + Unity Catalog Feature resources themselves, whose tags are + managed separately through the Unity Catalog tagging API. A + maximum of 25 tags is supported; keys and values are subject + to the same limitations as Databricks resource tags. + required: + - feature_full_names + - backfill_ranges + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI /api/2.0/feature-engineering/materialized-features:batchCreate: post: operationId: feature_engineering_batch_create_materialized_features @@ -2863,23 +3373,45 @@ paths: feature_name: type: string description: The full name of the feature in Unity Catalog. - cron_schedule: + budget_policy_id: type: string description: >- - The quartz cron expression that defines the - schedule of the materialization pipeline. The - schedule is evaluated in the UTC timezone. Hidden - from GraphQL: superseded by the ``trigger`` oneof - (cron_schedule_trigger), so not exposed to Catalog - Explorer. - cron_schedule_trigger: + The ID of the budget policy used to attribute the + serverless compute cost of this materialization. + If not specified, a default budget policy may be + applied. + cron_schedule: + type: string + cron_schedule_trigger: type: object properties: cron_expression: type: string description: >- The cron expression defining the schedule - (e.g., "0 0 * * *" for daily at midnight). + (e.g., "0 0 * * *" for daily at midnight). The + schedule is interpreted in timezone_id + (defaults to UTC). Required when mode is + MANUAL (or unset). Left empty when mode is + DERIVED, where the service computes it + (aligned to UTC) from the features' window + timing and fills it in on the response. + mode: + type: string + x-enum: + - DERIVED + - MANUAL + description: >- + How the schedule is determined. Defaults to + MANUAL when unset. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved + with respect to this timezone. Defaults to UTC + when omitted. Can only be configured for + MANUAL schedules; DERIVED schedules are always + aligned to UTC. description: >- A cron-based schedule trigger for the materialization pipeline. @@ -2888,17 +3420,105 @@ paths: description: >- True if this is an online materialized feature. False if it is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. + This is present for both batch and streaming + features. last_materialization_time: type: string description: >- The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this + materialized feature. Format: + operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature + was created for, through DABs or direct-engine + creation. Unset for a materialized feature that + was not created as part of a set. materialized_feature_id: type: string description: >- Server-assigned unique identifier for the materialized feature. + notifications: + type: object + properties: + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, + or a generic webhook) to notify. Not + supported for streaming materialized + features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final + attempt of a run fails. If false or unset, + notify on every failed attempt, including + attempts that will be retried. Batch + materialization does not retry failures + that need a fix on your side, such as + missing permissions or invalid + configuration, so the first attempt is the + final one. Other batch failures are + retried up to twice. Streaming + materialization restarts a failed update + indefinitely unless the error cannot be + retried. With this set, a streaming + materialized feature notifies only on + errors that cannot be retried, and never + on failures that are restarted. + description: >- + Who to notify when a run fails, and on which + attempts. + on_success: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, + or a generic webhook) to notify. Not + supported for streaming materialized + features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Who to notify when a run succeeds. + description: >- + Notification configuration around the + materialization job or pipeline lifecycle. They + are applied to every job and pipeline that + materializes this feature. Features which are + materialized in the same pipeline will share the + same notification. offline_store_config: type: object properties: @@ -2920,7 +3540,8 @@ paths: - table_name_prefix description: >- Destination for writing feature values to an - offline Delta table. + offline Delta table. The resulting table is + returned as ``table_name``. online_store_config: type: object properties: @@ -2955,7 +3576,14 @@ paths: - online_store_name description: >- Destination for writing feature values to an - online Lakebase table. + online Lakebase table. The resulting table is + returned as ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this + feature. This is only present for streaming + features. pipeline_schedule_state: type: string x-enum: @@ -2983,6 +3611,16 @@ paths: description: >- The type of streaming mode used by the materialization pipeline. + shuffle_partitions: + type: integer + description: >- + Number of shuffle partitions for streaming + materialization of this feature. Higher values + process high-throughput features with more + parallelism at higher compute cost. + Materialized features which are computed + together will use the largest value set among + them. description: >- The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets @@ -2997,10 +3635,54 @@ paths: table or Lakebase table). Output only. table_trigger: type: object - properties: {} + properties: + condition: + type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED + description: >- + Which source table updates trigger a + materialization run. If not set, any source + table update triggers a run. + min_time_between_triggers: + type: string + description: >- + The minimum time between two triggered runs, + so a frequently updated source table does not + trigger runs too often. If not set, a feature + with a sliding window uses half its + slide_duration and a feature with a tumbling + window uses half its window_duration, clamped + to between 5 minutes and 1 hour. Other + features have no minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without + updates before a run starts, so a series of + updates settles before the run. If not set, a + run starts as soon as the source table + updates. description: >- A trigger that fires when the upstream source table changes. + tags: + type: object + description: >- + Custom tags to associate with this + materialization. They are applied to the + materialization job (for batch features) or + pipeline (for streaming features) and forwarded to + the underlying compute as cluster tags, so + materialization cost can be attributed in the + billing system tables. These tags apply only to + the materialization compute; they are not applied + to the Unity Catalog Feature resource itself, + whose tags are managed separately through the + Unity Catalog tagging API. A maximum of 25 tags is + supported; keys and values are subject to the same + limitations as cluster tags. required: - feature_name description: >- @@ -3030,6 +3712,40 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI + /api/2.0/feature-engineering/{name}:cancel: + post: + operationId: feature_engineering_cancel_operation + summary: Cancel an operation. + tags: + - ml + - feature_engineering + description: |- + Cancel an operation. + + :param name: str + The name of the operation resource to be cancelled. + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the operation resource to be cancelled. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI /api/2.0/feature-engineering/features: post: operationId: feature_engineering_create_feature @@ -3050,814 +3766,1052 @@ paths: schema: type: object properties: - feature: + full_name: + type: string + source: type: object properties: - full_name: - type: string - source: + delta_table_source: type: object properties: - delta_table_source: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string + description: >- + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals and + projections. + timeseries_column: + type: string + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contains all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the delta table are present in the DataSource + dataframe. + required: + - full_name + description: A Delta table data source. + feature_view_source: + type: object + properties: + feature_references: + type: array + items: + type: object + properties: + feature: + type: string + description: >- + The three-part full name of the upstream + Feature. + required: + - feature + description: >- + A reference to one registered upstream Feature. A + message rather than a bare name so an upstream + can later be pinned more precisely (e.g. by version) without a breaking type change. + description: >- + The upstream Features this source reads. Must + include at least one feature. + description: >- + A data source composed from registered upstream + Features. + kafka_source: + type: object + properties: + name: + type: string + entity_column_identifiers: + type: array + items: + type: object + properties: + variant_expr_path: + type: string + required: + - variant_expr_path + filter_condition: + type: string + description: >- + The filter condition applied to the source data + before aggregation. + timeseries_column_identifier: type: object properties: - full_name: - type: string - dataframe_schema: + variant_expr_path: type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: + required: + - variant_expr_path + required: + - name + description: A Kafka stream data source. + lateness: + type: object + properties: + settling_delay: + type: string + description: >- + Non-negative time to wait after a window ends before + treating its source data as complete. Training + shifts the eligible evaluation time backwards by + this duration so it does not join data that would + still have been settling online. Materialization + waits for the duration to elapse before publishing + the window. If unset, source data is considered + settled immediately. + description: >- + Completeness timing for this Feature's use of the + source. This configuration is part of the Feature + definition; it does not modify the underlying table or + stream. + request_source: + type: object + properties: + dataframe_schema: + type: string + description: >- + A schema containing scalar or nested fields, in + Spark StructType JSON format (from + df.schema.json()). This preserves field, + array-element, and map-value nullability. + flat_schema: + type: object + properties: + fields: type: array items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity columns of - the Delta table. - filter_condition: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + x-enum: + - BINARY + - BOOLEAN + - DATE + - DECIMAL + - DOUBLE + - FLOAT + - INTEGER + - LONG + - SHORT + - STRING + - TIMESTAMP + description: The scalar data type of the field. + required: + - name + - data_type + description: >- + A single field definition within a FlatSchema, + specifying the field name and its scalar data + type. Does not support nested or complex types (arrays, maps, structs). + description: The list of fields in this schema. + required: + - fields + description: A flat schema with scalar-typed fields only. + description: A request-time data source. + sdp_source: + type: object + properties: + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + filter_condition: + type: string + description: >- + Single WHERE clause to filter the pipeline's output + table before applying transformations. Will be + row-wise evaluated, so should only include + conditionals and projections. + input_tables: + type: array + items: + type: string + description: >- + The full three-part names of the tables the pipeline + reads from. Required to materialize this feature + with a TableTrigger, which starts a run when these + tables update. Each table must exist when the + feature is created. Feature Store doesn't confirm + that the pipeline reads from these tables. At most + 100 tables. + output_table: + type: string + description: >- + The full three-part (catalog, schema, table) name of + the pipeline's output table to read from. The table + doesn't need to exist until the pipeline first runs. + Required. + pipeline_id: + type: string + description: >- + The ID of the Spark Declarative Pipeline that + Feature Store runs to produce this source, before + each materialization or backfill. The pipeline must + already exist when the feature is created, and you + need CAN_RUN, CAN_MANAGE, or owner permission on it. + It doesn't need to have run yet. Deleting the + feature doesn't delete the pipeline. If the pipeline + is deleted, this field reads back empty. Required. + pipeline_state: + type: string + x-enum: + - ERROR + - PENDING + - RESOLVED + description: >- + State tracking pipeline execution and output table + validation. PENDING until the pipeline has run at + least once and created the output table; then + RESOLVED on success, or ERROR on failure. + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contain all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the pipeline's output table are present in the + DataSource dataframe. + description: A Spark Declarative Pipeline data source. + stream_source: + type: object + properties: + full_name: + type: string + description: >- + Three-part full name of the Stream + (catalog.schema.stream). + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Any subsequent functions + operate against this dataframe. + filter_condition: + type: string + description: >- + The filter condition applied to the source data + before aggregation. + transformation_sql: + type: string + description: >- + The pipeline runs these SQL statements immediately + after conversion into the schema specified on the + Stream object. + required: + - full_name + description: A Stream data source. + description: The data source of the feature. + function: + type: object + properties: + aggregation_function: + type: object + properties: + approx_count_distinct: + type: object + properties: + input: type: string description: >- - Single WHERE clause to filter delta table before - applying transformations. Will be row-wise - evaluated, so should only include conditionals - and projections. - timeseries_column: - type: string + The input column from which the approximate + count of distinct values is computed. + relative_error: + type: number description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column of the Delta table. - transformation_sql: - type: string + The error the user accepts, as a fraction of the + count, between 0.02 (by default) and 0.3. This + is one standard error of the estimate, the same + meaning as Spark's relativeSD: 0.02 means the + result is within ±2% of the true count about 68% + of the time (one standard deviation covers 68% + of the region). Feature Store picks the sketch + size that gives this relative error. If neither + relative_error nor relative_sd is set, 0.02 is + default chosen at feature creation. + relative_sd: + type: number description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b AS - col_c FROM x.y.z WHERE col_a > 0" would have - ``transformation_sql`` "*, col_a + col_b AS - col_c") If transformation_sql is not provided, - all columns of the delta table are present in - the DataSource dataframe. + The maximum relative standard deviation allowed + (default defined by Spark). Deprecated: use + relative_error. When relative_error is set, + reads return the same value here for clients + that don't have relative_error, and a request + may only send that value. required: - - full_name - description: A Delta table data source. - kafka_source: + - input + description: Computes the approximate count of distinct values. + approx_percentile: type: object properties: - name: - type: string - dataframe_schema: + input: type: string description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Any subsequent - functions operate against this dataframe. - entity_column_identifiers: - type: array - items: - type: object - properties: - variant_expr_path: - type: string - required: - - variant_expr_path + The input column from which the approximate + percentile is computed. + percentile: + type: number description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity column - identifiers of the Kafka source. - filter_condition: - type: string + The percentile value to compute (between 0 and + 1). + accuracy: + type: integer description: >- - The filter condition applied to the source data - before aggregation. - timeseries_column_identifier: - type: object - properties: - variant_expr_path: - type: string - required: - - variant_expr_path + The accuracy parameter (higher is more accurate + but slower). Deprecated: use relative_error. + When relative_error is set, reads return ceil(1 + / relative_error) here for clients that don't + have relative_error, and a request may only send + that value. + relative_error: + type: number description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column identifier of the Kafka - source. - transformation_sql: + The error the user accepts, as a fraction of + rank, between 0.01 (by default) and 0.3. The + result is within this rank error with 99% + confidence: at 0.01, the value returned for p95 + is between the true p94 and p96 at least 99% of + the time. Feature Store picks the sketch size + that gives this error. If neither relative_error + nor accuracy is set, 0.01 is default chosen at + feature creation. + required: + - input + - percentile + description: Computes the approximate percentile of values. + avg: + type: object + properties: + input: type: string description: >- - The pipeline runs these SQL statements - immediately after conversion into the schema - specified on the KafkaConfig object. + The input column from which the average is + computed. For Kafka sources, use dot-prefixed + path notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. required: - - name - description: A Kafka stream data source. - request_source: + - input + description: Computes the average of values. + count_function: type: object properties: - flat_schema: - type: object - properties: - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - x-enum: - - BINARY - - BOOLEAN - - DATE - - DECIMAL - - DOUBLE - - FLOAT - - INTEGER - - LONG - - SHORT - - STRING - - TIMESTAMP - description: The scalar data type of the field. - required: - - name - - data_type - description: >- - A single field definition within a - FlatSchema, specifying the field name and - its scalar data - type. Does not support nested or complex types (arrays, maps, structs). - description: The list of fields in this schema. - required: - - fields - description: A flat schema with scalar-typed fields only. - description: A request-time data source. - stream_source: + input: + type: string + description: >- + The input column from which the count is + computed. For Kafka sources, use dot-prefixed + path notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. + required: + - input + description: Computes the count of values. + first: type: object properties: - full_name: + input: type: string description: >- - Three-part full name of the Stream - (catalog.schema.stream). - dataframe_schema: + The input column from which the first value is + returned. + required: + - input + description: Returns the first value. + first_distinct: + type: object + properties: + input: type: string description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Any subsequent - functions operate against this dataframe. - filter_condition: + The input column from which the first N distinct + values are returned. + 'n': + type: integer + description: The number of distinct values to return. + required: + - input + - 'n' + description: >- + Returns the first N distinct values, ordered by the + feature's timeseries column. + first_n: + type: object + properties: + input: type: string description: >- - The filter condition applied to the source data - before aggregation. - transformation_sql: + The input column from which the first N values + are returned. + 'n': + type: integer + description: The number of values to return. + required: + - input + - 'n' + description: >- + Returns the first N values, ordered by the feature's + timeseries column. + last: + type: object + properties: + input: type: string description: >- - The pipeline runs these SQL statements - immediately after conversion into the schema - specified on the Stream object. + The input column from which the last value is + returned. required: - - full_name - description: A Stream data source. - description: The data source of the feature. - function: - type: object - properties: - aggregation_function: + - input + description: Returns the last value. + last_distinct: type: object properties: - approx_count_distinct: - type: object - properties: - input: - type: string - description: >- - The input column from which the approximate - count of distinct values is computed. - relative_sd: - type: number - description: >- - The maximum relative standard deviation - allowed (default defined by Spark). - required: - - input + input: + type: string description: >- - Computes the approximate count of distinct - values. - approx_percentile: - type: object - properties: - input: - type: string - description: >- - The input column from which the approximate - percentile is computed. - percentile: - type: number - description: >- - The percentile value to compute (between 0 - and 1). - accuracy: - type: integer - description: >- - The accuracy parameter (higher is more - accurate but slower). - required: - - input - - percentile - description: Computes the approximate percentile of values. - avg: - type: object - properties: - input: - type: string - description: >- - The input column from which the average is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. - required: - - input - description: Computes the average of values. - count_function: + The input column from which the last N distinct + values are returned. + 'n': + type: integer + description: The number of distinct values to return. + required: + - input + - 'n' + description: >- + Returns the last N distinct values, ordered by the + feature's timeseries column. + last_n: + type: object + properties: + input: + type: string + description: >- + The input column from which the last N values + are returned. + 'n': + type: integer + description: The number of values to return. + required: + - input + - 'n' + description: >- + Returns the last N values, ordered by the feature's + timeseries column. + max: + type: object + properties: + input: + type: string + description: >- + The input column from which the maximum is + computed. + required: + - input + description: Computes the maximum value. + min: + type: object + properties: + input: + type: string + description: >- + The input column from which the minimum is + computed. + required: + - input + description: Computes the minimum value. + stddev_pop: + type: object + properties: + input: + type: string + description: >- + The input column from which the population + standard deviation is computed. For Kafka + sources, use dot-prefixed path notation (e.g., + "value.amount"). For nested fields, the leaf + node name is used. Colon-prefixed notation + (e.g., "value:amount") is supported for + backwards compatibility but is deprecated; + migrate to dot notation. + required: + - input + description: Computes the population standard deviation. + stddev_samp: + type: object + properties: + input: + type: string + description: >- + The input column from which the sample standard + deviation is computed. + required: + - input + description: Computes the sample standard deviation. + sum: + type: object + properties: + input: + type: string + description: >- + The input column from which the sum is computed. + For Kafka sources, use dot-prefixed path + notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. + required: + - input + description: Computes the sum of values. + time_window: + type: object + properties: + continuous: type: object properties: - input: + window_duration: type: string - description: >- - The input column from which the count is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. - required: - - input - description: Computes the count of values. - first: - type: object - properties: - input: + offset: type: string description: >- - The input column from which the first value - is returned. + The offset of the continuous window (must be + non-positive). required: - - input - description: Returns the first value. - first_distinct: + - window_duration + rolling: type: object properties: - input: + delay: type: string description: >- - The input column from which the first N - distinct values are returned. - 'n': - type: integer - description: The number of distinct values to return. - required: - - input - - 'n' - description: >- - Returns the first N distinct values, ordered by - the feature's timeseries column. - first_n: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + window_duration: type: string description: >- - The input column from which the first N - values are returned. - 'n': - type: integer - description: The number of values to return. - required: - - input - - 'n' + The duration of the rolling window. Must be + positive when set; absent means lifetime + (aggregate over the entity's entire + history). description: >- - Returns the first N values, ordered by the - feature's timeseries column. - last: - type: object - properties: - input: - type: string - description: >- - The input column from which the last value - is returned. - required: - - input - description: Returns the last value. - last_distinct: + A rolling time window with an optional + non-negative delay. + sawtooth: type: object properties: - input: + delay: type: string description: >- - The input column from which the last N - distinct values are returned. - 'n': - type: integer - description: The number of distinct values to return. - required: - - input - - 'n' - description: >- - Returns the last N distinct values, ordered by - the feature's timeseries column. - last_n: - type: object - properties: - input: + Delay is not currently supported for + Sawtooth windows. + window_duration: type: string description: >- - The input column from which the last N - values are returned. - 'n': - type: integer - description: The number of values to return. - required: - - input - - 'n' + The duration of the window. Must be positive + and span more than two days when set, so + that both the batch (N-1 day) and stale-path + (N-2 day) partial aggregates are well + defined. The duration need not be a whole + number of days (e.g. 3 days 15 minutes is + allowed). Absent means lifetime (aggregate + over the entity's entire history). description: >- - Returns the last N values, ordered by the - feature's timeseries column. - max: - type: object - properties: - input: - type: string - description: >- - The input column from which the maximum is - computed. - required: - - input - description: Computes the maximum value. - min: + A sawtooth window served via the hybrid batch + + streaming path. + sliding: type: object properties: - input: + slide_duration: type: string - description: >- - The input column from which the minimum is - computed. - required: - - input - description: Computes the minimum value. - stddev_pop: - type: object - properties: - input: + delay: type: string description: >- - The input column from which the population - standard deviation is computed. For Kafka - sources, use dot-prefixed path notation - (e.g., "value.amount"). For nested fields, - the leaf node name is used. Colon-prefixed - notation (e.g., "value:amount") is supported - for backwards compatibility but is - deprecated; migrate to dot notation. - required: - - input - description: Computes the population standard deviation. - stddev_samp: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + offset: type: string description: >- - The input column from which the sample - standard deviation is computed. - required: - - input - description: Computes the sample standard deviation. - sum: - type: object - properties: - input: + Non-negative phase shift from the default + midnight UTC alignment. For example, + offset=22h on a 24h slide produces + boundaries at 22:00 UTC (17:00 New York in + standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter + than slide_duration (and therefore + window_duration). + window_duration: type: string description: >- - The input column from which the sum is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. + The duration of the sliding window. Must be + positive when set; absent means lifetime + (aggregate over the entity's entire + history). required: - - input - description: Computes the sum of values. - time_window: - type: object - properties: - continuous: - type: object - properties: - window_duration: - type: string - description: >- - The duration of the continuous window - (must be positive). - offset: - type: string - description: >- - The offset of the continuous window - (must be non-positive). - required: - - window_duration - description: >- - Deprecated: use RollingWindow with ``delay`` - instead. - rolling: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the - rolling window (must be non-negative). - For example, delay=1d shifts the window - end 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the rolling window. Must - be positive when set; absent means - lifetime (aggregate over the entity's - entire history). - description: >- - A rolling time window with an optional - delay. This is the SQL-spec-aligned - replacement for - ContinuousWindow: ``delay`` is the non-negative counterpart of the legacy non-positive - ``ContinuousWindow.offset``. - sawtooth: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the - window (must be non-negative). For - example, delay=1d shifts the window end - 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the window. Must be - positive and span more than two days - when set, so that both the batch (N-1 - day) and stale-path (N-2 day) partial - aggregates are well defined. The - duration need not be a whole number of - days (e.g. 3 days 15 minutes is - allowed). Absent means lifetime - (aggregate over the entity's entire - history). - description: >- - A sawtooth window served via the hybrid - batch + streaming path. - sliding: - type: object - properties: - slide_duration: - type: string - window_duration: - type: string - description: >- - The duration of the sliding window. Must - be positive when set; absent means - lifetime (aggregate over the entity's - entire history). - required: - - slide_duration - tumbling: - type: object - properties: - window_duration: - type: string - required: - - window_duration + - slide_duration + start_time: + type: string + format: date-time description: >- - The time window over which the aggregation is - computed. - var_pop: + Earliest event-time boundary at which the + Feature may emit an output. This gates outputs, + not the historical inputs read by a window. For + example, a 365-day window with + start_time=2026-01-01 begins emitting + partial-window values on that date instead of + waiting for 365 days of data; a lifetime window + produces no output before start_time. If unset, + tumbling and fixed-duration sliding windows + first emit at an offset-aligned boundary after a + full window can be formed. If unset, lifetime + sliding windows and rolling windows emit as soon + as eligible source data exists. For sawtooth + windows, start_time must not be later than the + time the Feature is created. Not supported for + rolling windows on Features with a stream + source. + tumbling: type: object properties: - input: + window_duration: + type: string + delay: type: string description: >- - The input column from which the population - variance is computed. - required: - - input - description: Computes the population variance. - var_samp: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + offset: type: string description: >- - The input column from which the sample - variance is computed. + Non-negative phase shift from the default + midnight UTC alignment. For example, + offset=22h on a 24h window produces + boundaries at 22:00 UTC (17:00 New York in + standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter + than window_duration. required: - - input - description: Computes the sample variance. - description: An aggregation function applied over a time window. - column_selection: + - window_duration + description: >- + The time window over which the aggregation is + computed. + var_pop: type: object properties: - column: + input: type: string description: >- - Column name from source to select as the feature - value. + The input column from which the population + variance is computed. required: - - column - description: >- - Selects the latest value of a single column in a - data source - custom_udf: + - input + description: Computes the population variance. + var_samp: type: object properties: - function_path: + input: type: string description: >- - Fully qualified 3-part Unity Catalog path of the - function to apply. - input_bindings: - type: array - items: - type: object - properties: - parameter: - type: string - description: Name of the UC function parameter. - column: - type: string - description: >- - Source column whose value is passed for - this parameter at execution time. - required: - - parameter - - column - description: >- - Binds a single UC function parameter to a - source column. - description: >- - Binds each UC function parameter to a source - column. May be empty for zero-argument functions - (e.g. a timestamp generator). + The input column from which the sample variance + is computed. required: - - function_path + - input + description: Computes the sample variance. + description: An aggregation function applied over a time window. + column_selection: + type: object + properties: + column: + type: string + description: >- + Column name from source to select as the feature + value. + required: + - column + description: >- + Selects the latest value of a single column in a data + source + custom_udf: + type: object + properties: + function_path: + type: string description: >- - Applies a registered Unity Catalog function row-wise - to source columns. - extra_parameters: + Fully qualified 3-part Unity Catalog path of the + function to apply. + input_bindings: type: array items: type: object properties: - key: + parameter: type: string - description: The name of the parameter. - value: + description: Name of the UC function parameter. + column: type: string - description: The value of the parameter. + description: >- + Source column whose value is passed for this + parameter at execution time. required: - - key - - value + - parameter + - column description: >- - Deprecated: Use typed fields on function-specific - messages (e.g. - ApproxPercentileFunction.percentile) or AggregationFunction.ExtraParameter instead. Kept for - backwards compatibility. - description: >- - Deprecated: Use the function oneof with - AggregationFunction instead. Kept for backwards - compatibility. Extra parameters for parameterized - functions. - function_type: - type: string - x-enum: - - APPROX_COUNT_DISTINCT - - APPROX_PERCENTILE - - AVG - - COUNT - - FIRST - - LAST - - MAX - - MIN - - STDDEV_POP - - STDDEV_SAMP - - SUM - - VAR_POP - - VAR_SAMP - description: >- - Deprecated: Use the function oneof with - AggregationFunction instead. Kept for backwards - compatibility. The type of the function. - description: The function by which the feature is computed. - catalog_name: - type: string - description: Name of parent catalog. - created_at: - type: string - format: date-time - description: Time at which this feature was created. - created_by: - type: string - description: Username of the feature creator. - description: - type: string - description: The description of the feature. - entities: + Binds a single UC function parameter to a source + column. + description: >- + Binds each UC function parameter to a source column. + May be empty for zero-argument functions (e.g. a + timestamp generator). + required: + - function_path + description: >- + Applies a registered Unity Catalog function row-wise to + source columns. + extra_parameters: type: array items: type: object properties: - name: + key: type: string + value: + type: string + description: The value of the parameter. required: - - name - description: >- - The entity columns for the feature, used as aggregation - keys and for query-time lookup. - filter_condition: + - key + - value + function_type: type: string + x-enum: + - APPROX_COUNT_DISTINCT + - APPROX_PERCENTILE + - AVG + - COUNT + - FIRST + - FUNCTION_TYPE_UNSPECIFIED + - LAST + - MAX + - MIN + - STDDEV_POP + - STDDEV_SAMP + - SUM + - VAR_POP + - VAR_SAMP description: >- - Deprecated: Use DeltaTableSource.filter_condition or - KafkaSource.filter_condition instead. Kept for backwards - compatibility. The filter condition applied to the - source data before aggregation. - inputs: - type: array - items: + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can + have their own + + attributes -- see the documentation for details. + description: The function by which the feature is computed. + catalog_name: + type: string + description: Name of parent catalog. + created_at: + type: string + format: date-time + description: Time at which this feature was created. + created_by: + type: string + description: Username of the feature creator. + description: + type: string + description: The description of the feature. + entities: + type: array + items: + type: object + properties: + name: type: string - description: >- - Deprecated: Use AggregationFunction.inputs instead. Kept - for backwards compatibility. The input columns from - which the feature is computed. - lineage_context: + required: + - name + description: >- + The entity columns for the feature, used as aggregation keys + and for query-time lookup. Optional since entities are not + set for RequestSource features or on-demand calculated + features. + filter_condition: + type: string + inputs: + type: array + items: + type: string + lineage_context: + type: object + properties: + job_context: type: object properties: - job_context: - type: object - properties: - job_id: - type: integer - job_run_id: - type: integer - description: The job run ID where this API was invoked. - description: Job context information including job ID and run ID. - notebook_id: + job_id: type: integer - description: The notebook ID where this API was invoked. - description: >- - Lineage context information for this feature. WARNING: - This field is primarily intended for internal use by - Databricks systems and is automatically populated when - features are created through Databricks notebooks or - jobs. Users should not manually set this field as - incorrect values may lead to inaccurate lineage tracking - or unexpected behavior. This field will be set by - feature-engineering client and should be left unset by - SDK and terraform users. - name: - type: string - description: >- - Name of the feature, extracted from the full three-part - name (catalog.schema.name). - schema_name: - type: string - description: Name of parent schema relative to its parent catalog. - time_window: + job_run_id: + type: integer + description: The job run ID where this API was invoked. + description: Job context information including job ID and run ID. + notebook_id: + type: integer + description: The notebook ID where this API was invoked. + description: >- + Lineage context information for this feature. WARNING: This + field is primarily intended for internal use by Databricks + systems and is automatically populated when features are + created through Databricks notebooks or jobs. Users should + not manually set this field as incorrect values may lead to + inaccurate lineage tracking or unexpected behavior. This + field will be set by feature-engineering client and should + be left unset by SDK and terraform users. + name: + type: string + description: >- + Name of the feature, extracted from the full three-part name + (catalog.schema.name). + schema_name: + type: string + description: Name of parent schema relative to its parent catalog. + time_window: + type: object + properties: + continuous: type: object properties: - continuous: - type: object - properties: - window_duration: - type: string - description: >- - The duration of the continuous window (must be - positive). - offset: - type: string - description: >- - The offset of the continuous window (must be - non-positive). - required: - - window_duration + window_duration: + type: string + offset: + type: string description: >- - Deprecated: use RollingWindow with ``delay`` - instead. - rolling: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the rolling - window (must be non-negative). For example, - delay=1d shifts the window end 1 day before the - evaluation time. - window_duration: - type: string - description: >- - The duration of the rolling window. Must be - positive when set; absent means lifetime - (aggregate over the entity's entire history). - description: >- - A rolling time window with an optional delay. This - is the SQL-spec-aligned replacement for - ContinuousWindow: ``delay`` is the non-negative counterpart of the legacy non-positive - ``ContinuousWindow.offset``. - sawtooth: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the window (must - be non-negative). For example, delay=1d shifts - the window end 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the window. Must be positive and - span more than two days when set, so that both - the batch (N-1 day) and stale-path (N-2 day) - partial aggregates are well defined. The - duration need not be a whole number of days - (e.g. 3 days 15 minutes is allowed). Absent - means lifetime (aggregate over the entity's - entire history). - description: >- - A sawtooth window served via the hybrid batch + - streaming path. - sliding: - type: object - properties: - slide_duration: - type: string - window_duration: - type: string - description: >- - The duration of the sliding window. Must be - positive when set; absent means lifetime - (aggregate over the entity's entire history). - required: - - slide_duration - tumbling: - type: object - properties: - window_duration: - type: string - required: - - window_duration + The offset of the continuous window (must be + non-positive). + required: + - window_duration + rolling: + type: object + properties: + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + window_duration: + type: string + description: >- + The duration of the rolling window. Must be positive + when set; absent means lifetime (aggregate over the + entity's entire history). description: >- - Deprecated: Use - Function.aggregation_function.time_window instead. Kept - for backwards compatibility. The time window in which - the feature is computed. - timeseries_column: + A rolling time window with an optional non-negative + delay. + sawtooth: type: object properties: - name: + delay: type: string - required: - - name + description: >- + Delay is not currently supported for Sawtooth + windows. + window_duration: + type: string + description: >- + The duration of the window. Must be positive and + span more than two days when set, so that both the + batch (N-1 day) and stale-path (N-2 day) partial + aggregates are well defined. The duration need not + be a whole number of days (e.g. 3 days 15 minutes is + allowed). Absent means lifetime (aggregate over the + entity's entire history). description: >- - Column recording time, used for point-in-time joins, - backfills, and aggregations. - required: - - full_name - - source - - function - description: Feature to create. - required: - - feature - responses: + A sawtooth window served via the hybrid batch + + streaming path. + sliding: + type: object + properties: + slide_duration: + type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight + UTC alignment. For example, offset=22h on a 24h + slide produces boundaries at 22:00 UTC (17:00 New + York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than + slide_duration (and therefore window_duration). + window_duration: + type: string + description: >- + The duration of the sliding window. Must be positive + when set; absent means lifetime (aggregate over the + entity's entire history). + required: + - slide_duration + start_time: + type: string + format: date-time + description: >- + Earliest event-time boundary at which the Feature may + emit an output. This gates outputs, not the historical + inputs read by a window. For example, a 365-day window + with start_time=2026-01-01 begins emitting + partial-window values on that date instead of waiting + for 365 days of data; a lifetime window produces no + output before start_time. If unset, tumbling and + fixed-duration sliding windows first emit at an + offset-aligned boundary after a full window can be + formed. If unset, lifetime sliding windows and rolling + windows emit as soon as eligible source data exists. For + sawtooth windows, start_time must not be later than the + time the Feature is created. Not supported for rolling + windows on Features with a stream source. + tumbling: + type: object + properties: + window_duration: + type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight + UTC alignment. For example, offset=22h on a 24h + window produces boundaries at 22:00 UTC (17:00 New + York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than + window_duration. + required: + - window_duration + timeseries_column: + type: object + properties: + name: + type: string + required: + - name + description: >- + Column recording time, used for point-in-time joins, + backfills, and aggregations. Optional since a timeseries + column is not set for RequestSource features or on-demand + calculated features. + required: + - full_name + - source + - function + responses: '200': description: Success content: @@ -3966,151 +4920,225 @@ paths: schema: type: object properties: - kafka_config: + name: + type: string + bootstrap_servers: + type: string + description: >- + A comma-separated list of host/port pairs pointing to Kafka + cluster. + subscription_mode: type: object properties: - name: + assign: type: string - bootstrap_servers: + description: >- + A JSON string that contains the specific + topic-partitions to consume from. For example, for + '{"topicA":[0,1],"topicB":[2,4]}', topicA's 0'th and 1st + partitions will be consumed from. + subscribe: + type: string + description: >- + A comma-separated list of Kafka topics to read from. For + example, 'topicA,topicB,topicC'. + subscribe_pattern: type: string description: >- - A comma-separated list of host/port pairs pointing to - Kafka cluster. - subscription_mode: + A regular expression matching topics to subscribe to. + For example, 'topic.*' will subscribe to all topics + starting with 'topic'. + description: Options to configure which Kafka topics to pull data from. + auth_config: + type: object + properties: + mtls_config: type: object properties: - assign: + keystore_location: type: string description: >- - A JSON string that contains the specific - topic-partitions to consume from. For example, for - '{"topicA":[0,1],"topicB":[2,4]}', topicA's 0'th and - 1st partitions will be consumed from. - subscribe: - type: string + Unity Catalog volume path to the JKS keystore file + containing the client certificate and private key. + e.g. + "/Volumes////client.jks". + The materialization compute must have read + permission on this volume. + keystore_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the JKS keystore + password. + key_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key description: >- - A comma-separated list of Kafka topics to read from. - For example, 'topicA,topicB,topicC'. - subscribe_pattern: + Secret-scope reference for the private key password. + Often the same value as the keystore password + (keytool's default), but provided as a separate + field because Apache Kafka requires it as a distinct + option (kafka.ssl.key.password). + truststore_location: type: string description: >- - A regular expression matching topics to subscribe - to. For example, 'topic.*' will subscribe to all - topics starting with 'topic'. - description: >- - Options to configure which Kafka topics to pull data - from. - auth_config: - type: object - properties: - mtls_config: + Unity Catalog volume path to the JKS truststore file + containing the CA certificate(s) trusted to verify + the Kafka broker's server certificate. e.g. + "/Volumes////truststore.jks". + truststore_password_ref: type: object properties: - keystore_location: + scope: type: string - description: >- - Unity Catalog volume path to the JKS keystore - file containing the client certificate and - private key. e.g. - "/Volumes////client.jks". - The materialization compute must have read - permission on this volume. - keystore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS keystore - password. - key_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the private key - password. Often the same value as the keystore - password (keytool's default), but provided as a - separate field because Apache Kafka requires it - as a distinct option (kafka.ssl.key.password). - truststore_location: + description: The Databricks secret scope name. + key: type: string - description: >- - Unity Catalog volume path to the JKS truststore - file containing the CA certificate(s) trusted to - verify the Kafka broker's server certificate. - e.g. - "/Volumes////truststore.jks". - truststore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS truststore - password. - disable_hostname_verification: - type: boolean - description: >- - Set to true only when the broker certificate's - SAN intentionally does not match the connection - endpoint — for example when reaching the cluster - through a PrivateLink endpoint whose DNS name is - not in the broker certificate. Skipping the - hostname check removes a defense against - man-in-the-middle attacks; do not enable - casually. mTLS client authentication is - unaffected by this option. See the Apache Kafka - SSL security guide for background on this check: - https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + description: The key within the scope. required: - - keystore_location - - keystore_password_ref - - key_password_ref - - truststore_location - - truststore_password_ref + - scope + - key + description: >- + Secret-scope reference for the JKS truststore + password. + disable_hostname_verification: + type: boolean + description: >- + Set to true only when the broker certificate's SAN + intentionally does not match the connection endpoint + — for example when reaching the cluster through a + PrivateLink endpoint whose DNS name is not in the + broker certificate. Skipping the hostname check + removes a defense against man-in-the-middle attacks; + do not enable casually. mTLS client authentication + is unaffected by this option. See the Apache Kafka + SSL security guide for background on this check: + https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + required: + - keystore_location + - keystore_password_ref + - key_password_ref + - truststore_location + - truststore_password_ref + description: >- + Mutual-TLS (mTLS) authentication configuration. The + keystore (client certificate + private key) + and truststore (CAs trusted to verify the broker) live as JKS files on Unity Catalog volumes, + with their passwords stored in Databricks secret scopes. This matches the SSL setup pattern + documented at + https://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka. + uc_service_credential_name: + type: string + description: >- + Name of the Unity Catalog service credential. This value + will be set under the option + databricks.serviceCredential + description: Authentication configuration for connection to topics. + backfill_source: + type: object + properties: + delta_table_name: + type: string + delta_table_source: + type: object + properties: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string + description: >- + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals and + projections. + timeseries_column: + type: string + transformation_sql: + type: string description: >- - Mutual-TLS (mTLS) authentication configuration. The - keystore (client certificate + private key) - and truststore (CAs trusted to verify the broker) live as JKS files on Unity Catalog volumes, - with their passwords stored in Databricks secret scopes. This matches the SSL setup pattern - documented at - https://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka. - - At materialization time, the generated PySpark code passes the JKS file paths and resolved - passwords through to the Kafka SSL options (kafka.ssl.keystore.location, - kafka.ssl.keystore.password, kafka.ssl.key.password, kafka.ssl.truststore.location, - kafka.ssl.truststore.password). Passwords are resolved on the Spark cluster via - dbutils.secrets.get; this message stores only references, never password values. - uc_service_credential_name: + A single SQL SELECT expression applied after + filter_condition. Should contains all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the delta table are present in the DataSource + dataframe. + required: + - full_name + description: >- + Deprecated: Use delta_table_name instead. Kept for + backwards compatibility. The Delta table source + containing the historical data to backfill. Only the + delta table name is used for backfill, other fields are + ignored. + description: >- + A user-provided and managed source for backfilling data. + Historical data is used when creating a training set from + streaming features linked to this Kafka config. In the + future, a separate table will be maintained by Databricks + for forward filling data. The schema for this source must + match exactly that of the key and value schemas specified + for this Kafka config. + extra_options: + type: object + description: >- + Catch-all for miscellaneous options. Keys should be source + options or Kafka consumer options (kafka.*) + ingestion_config: + type: object + properties: + ingestion_destination: + type: object + properties: + delta_table_name: type: string description: >- - Name of the Unity Catalog service credential. This - value will be set under the option - databricks.serviceCredential - description: Authentication configuration for connection to topics. + The full three-part name (catalog, schema, name) of + the Delta table to be created for ingestion. + description: >- + Destination for the Databricks-managed Delta table that + holds an offline copy of the streaming data for querying + and training. This table contains both 1) forward-filled + data from the Stream and 2) backfilled data from the + BackfillSource (if provided). This table is created and + managed by Databricks and is deleted when the Stream is + deleted. + backfill_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + historical backfill of the ingestion Delta table. backfill_source: type: object properties: @@ -4133,10 +5161,6 @@ paths: type: array items: type: string - description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity columns of - the Delta table. filter_condition: type: string description: >- @@ -4146,10 +5170,6 @@ paths: and projections. timeseries_column: type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column of the Delta table. transformation_sql: type: string description: >- @@ -4170,227 +5190,141 @@ paths: delta table name is used for backfill, other fields are ignored. description: >- - A user-provided and managed source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Kafka config. In - the future, a separate table will be maintained by - Databricks for forward filling data. The schema for this - source must match exactly that of the key and value - schemas specified for this Kafka config. - extra_options: + A user-provided source for backfilling data. Historical + data is used when creating a training set from streaming + features linked to this Stream. The backfill data stored + in this location will be copied into the ingestion table + for offline querying and training. The schema for this + source must match exactly that of the key and payload + schemas specified for this Stream, except that it may + omit any columns listed in excluded_columns. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this stream's managed + ingestion. If not specified, a default budget policy may + be applied. + deduplication_columns: + type: array + items: + type: string + description: >- + Column paths used to identify duplicate rows during + ingestion; only one row per distinct combination of + these values is kept. Use dot notation for nested fields + (e.g. ``value.user_id``). Empty list means every column + is compared. + ingestion_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + forward-fill ingestion. + ingestion_pipeline_id: + type: string + description: >- + The ID of the SDP pipeline that continuously copies new + events from the streaming source into the ingestion + Delta table. + tags: type: object description: >- - Catch-all for miscellaneous options. Keys should be - source options or Kafka consumer options (kafka.*) - ingestion_config: + Custom tags to associate with this stream's managed + ingestion. They are applied to the ingestion pipeline + and its forward-fill and backfill jobs, and forwarded to + the underlying compute as cluster tags, so ingestion + cost can be attributed in the billing system tables. + These tags apply only to the managed ingestion compute; + they are not applied to the Stream entity itself, and + are distinct from any Unity Catalog tags on the Stream. + A maximum of 25 tags is supported; keys and values are + subject to the same limitations as cluster tags. + required: + - ingestion_destination + description: >- + Configuration for ingesting Kafka data into a + Databricks-managed Delta table. + key_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON schema + format (https://json-schema.org/). + proto_schema: type: object properties: - ingestion_destination: - type: object - properties: - delta_table_name: - type: string - description: >- - The full three-part name (catalog, schema, name) - of the Delta table to be created for ingestion. - description: >- - Destination for the Databricks-managed Delta table - that holds an offline copy of the streaming data for - querying and training. This table contains both 1) - forward-filled data from the Stream and 2) - backfilled data from the BackfillSource (if - provided). This table is created and managed by - Databricks and is deleted when the Stream is - deleted. - backfill_job_id: - type: integer - description: >- - The ID of the Databricks Job that performs the - historical backfill of the ingestion Delta table. - backfill_source: - type: object - properties: - delta_table_name: - type: string - delta_table_source: - type: object - properties: - full_name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON - format (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept - for backwards compatibility. The entity - columns of the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table - before applying transformations. Will be - row-wise evaluated, so should only include - conditionals and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. - The timeseries column of the Delta table. - transformation_sql: - type: string - description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b - AS col_c FROM x.y.z WHERE col_a > 0" would - have ``transformation_sql`` "*, col_a + - col_b AS col_c") If transformation_sql is - not provided, all columns of the delta table - are present in the DataSource dataframe. - required: - - full_name - description: >- - Deprecated: Use delta_table_name instead. Kept - for backwards compatibility. The Delta table - source containing the historical data to - backfill. Only the delta table name is used for - backfill, other fields are ignored. - description: >- - A user-provided source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Stream. The - backfill data stored in this location will be copied - into the ingestion table for offline querying and - training. The schema for this source must match - exactly that of the key and payload schemas - specified for this Stream. - deduplication_columns: - type: array - items: - type: string - description: >- - Column paths used to identify duplicate rows during - ingestion; only one row per distinct combination of - these values is kept. Use dot notation for nested - fields (e.g. ``value.user_id``). Empty list means - every column is compared. - ingestion_job_id: - type: integer + schema_text: + type: string description: >- - The ID of the Databricks Job that performs the - forward-fill ingestion. - ingestion_pipeline_id: + The raw .proto file text (proto2 and proto3 syntax + supported, see + https://protobuf.dev/programming-guides/proto3/ and + https://protobuf.dev/programming-guides/proto2/). + message_name: type: string description: >- - The ID of the SDP pipeline that continuously copies - new events from the streaming source into the - ingestion Delta table. + The fully-qualified name of the message within + schema_text that describes the Kafka payload (e.g. + "Event" or "com.example.Event" if schema_text + declares a package). Identifies which message is + used to decode each Kafka record — a .proto file may + declare multiple messages but only one represents + the payload. Must not be empty. required: - - ingestion_destination + - schema_text + - message_name + description: Protocol Buffer schema with its payload message name. + description: >- + Schema configuration for extracting message keys from + topics. At least one of key_schema and value_schema must be + provided. + value_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string description: >- - Configuration for ingesting Kafka data into a - Databricks-managed Delta table. - key_schema: + Schema of the JSON object in standard IETF JSON schema + format (https://json-schema.org/). + proto_schema: type: object properties: - avro_schema: - type: string - json_schema: + schema_text: type: string description: >- - Schema of the JSON object in standard IETF JSON - schema format (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and proto3 - syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message within - schema_text that describes the Kafka payload - (e.g. "Event" or "com.example.Event" if - schema_text declares a package). Identifies - which message is used to decode each Kafka - record — a .proto file may declare multiple - messages but only one represents the payload. - Must not be empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload message - name. - description: >- - Schema configuration for extracting message keys from - topics. At least one of key_schema and value_schema must - be provided. - value_schema: - type: object - properties: - avro_schema: - type: string - json_schema: + The raw .proto file text (proto2 and proto3 syntax + supported, see + https://protobuf.dev/programming-guides/proto3/ and + https://protobuf.dev/programming-guides/proto2/). + message_name: type: string description: >- - Schema of the JSON object in standard IETF JSON - schema format (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and proto3 - syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message within - schema_text that describes the Kafka payload - (e.g. "Event" or "com.example.Event" if - schema_text declares a package). Identifies - which message is used to decode each Kafka - record — a .proto file may declare multiple - messages but only one represents the payload. - Must not be empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload message - name. - description: >- - Schema configuration for extracting message values from - topics. At least one of key_schema and value_schema must - be provided. - required: - - name - - bootstrap_servers - - subscription_mode - - auth_config + The fully-qualified name of the message within + schema_text that describes the Kafka payload (e.g. + "Event" or "com.example.Event" if schema_text + declares a package). Identifies which message is + used to decode each Kafka record — a .proto file may + declare multiple messages but only one represents + the payload. Must not be empty. + required: + - schema_text + - message_name + description: Protocol Buffer schema with its payload message name. + description: >- + Schema configuration for extracting message values from + topics. At least one of key_schema and value_schema must be + provided. required: - - kafka_config + - name + - bootstrap_servers + - subscription_mode + - auth_config responses: '200': description: Success @@ -4463,6 +5397,382 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI + /api/2.0/feature-engineering/materialization-sets: + post: + operationId: feature_engineering_create_materialization_set + summary: Create a materialization set. + tags: + - ml + - feature_engineering + description: |- + Create a materialization set. + + :param materialization_set: :class:`MaterializationSet` + The materialization set to create. Supply materialization_set_id to choose the identifier; leave it + unset to have one assigned. + :param request_id: str (optional) + Idempotency token for the request. A second request carrying a token that has already been used + returns the operation the first one created, whatever state it reached, and creates no second set. + The token is not checked against the rest of the request, so reusing one for a different set returns + the original operation rather than an error. Omit it and each request creates its own set. + + :returns: :class:`Operation` + parameters: + - name: request_id + in: query + required: false + schema: + type: string + description: >- + Idempotency token for the request. A second request carrying a token + that has already been used returns the operation the first one + created, whatever state it reached, and creates no second set. The + token is not checked against the rest of the request, so reusing one + for a different set returns the original operation rather than an + error. Omit it and each request creates its own set. + requestBody: + content: + application/json: + schema: + type: object + properties: + materialization_set_id: + type: string + description: >- + Server-assigned unique identifier for the materialization + set. + materialized_features: + type: array + items: + type: object + properties: + feature_name: + type: string + description: The full name of the feature in Unity Catalog. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this materialization. If + not specified, a default budget policy may be applied. + cron_schedule: + type: string + cron_schedule_trigger: + type: object + properties: + cron_expression: + type: string + description: >- + The cron expression defining the schedule (e.g., + "0 0 * * *" for daily at midnight). The schedule + is interpreted in timezone_id (defaults to UTC). + Required when mode is MANUAL (or unset). Left + empty when mode is DERIVED, where the service + computes it (aligned to UTC) from the features' + window timing and fills it in on the response. + mode: + type: string + x-enum: + - DERIVED + - MANUAL + description: >- + How the schedule is determined. Defaults to MANUAL + when unset. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with + respect to this timezone. Defaults to UTC when + omitted. Can only be configured for MANUAL + schedules; DERIVED schedules are always aligned to + UTC. + description: >- + A cron-based schedule trigger for the materialization + pipeline. + is_online: + type: boolean + description: >- + True if this is an online materialized feature. False + if it is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. This + is present for both batch and streaming features. + last_materialization_time: + type: string + description: >- + The timestamp when the pipeline last ran and updated + the materialized feature values. If the pipeline has + not run yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this + materialized feature. Format: + operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature was + created for, through DABs or direct-engine creation. + Unset for a materialized feature that was not created + as part of a set. + materialized_feature_id: + type: string + description: >- + Server-assigned unique identifier for the materialized + feature. + notifications: + type: object + properties: + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, or + a generic webhook) to notify. Not supported + for streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final attempt of + a run fails. If false or unset, notify on + every failed attempt, including attempts that + will be retried. Batch materialization does + not retry failures that need a fix on your + side, such as missing permissions or invalid + configuration, so the first attempt is the + final one. Other batch failures are retried up + to twice. Streaming materialization restarts a + failed update indefinitely unless the error + cannot be retried. With this set, a streaming + materialized feature notifies only on errors + that cannot be retried, and never on failures + that are restarted. + description: >- + Who to notify when a run fails, and on which + attempts. + on_success: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, or + a generic webhook) to notify. Not supported + for streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Who to notify when a run succeeds. + description: >- + Notification configuration around the materialization + job or pipeline lifecycle. They are applied to every + job and pipeline that materializes this feature. + Features which are materialized in the same pipeline + will share the same notification. + offline_store_config: + type: object + properties: + catalog_name: + type: string + description: The Unity Catalog catalog name. + schema_name: + type: string + description: The Unity Catalog schema name. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The + materialized feature will be stored in a table + with this prefix and a generated postfix. + required: + - catalog_name + - schema_name + - table_name_prefix + description: >- + Destination for writing feature values to an offline + Delta table. The resulting table is returned as + ``table_name``. + online_store_config: + type: object + properties: + catalog_name: + type: string + description: >- + The Unity Catalog catalog name. This name is also + used as the Lakebase logical database name. + Quoting is handled by the backend where needed, do + not pre-quote it. + schema_name: + type: string + description: >- + The Unity Catalog schema name. This name is also + used as the Lakebase schema name under the + database. Quoting is handled by the backend where + needed, do not pre-quote it. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The + materialized feature will be stored in a Lakebase + table with this prefix and a generated postfix. + online_store_name: + type: string + description: The name of the target online store. + required: + - catalog_name + - schema_name + - table_name_prefix + - online_store_name + description: >- + Destination for writing feature values to an online + Lakebase table. The resulting table is returned as + ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this feature. + This is only present for streaming features. + pipeline_schedule_state: + type: string + x-enum: + - ACTIVE + - PAUSED + - SNAPSHOT + description: >- + The schedule state of the materialization pipeline. + Hidden from GraphQL: being deprecated, so not exposed + to Catalog Explorer. + streaming_mode: + type: object + properties: + freshness_target: + type: string + description: >- + The desired data freshness for feature + materialization, expressed as a duration string + (e.g. "1 minute"). + mode: + type: string + x-enum: + - STREAMING_MODE_TYPE_MBM + - STREAMING_MODE_TYPE_RTM + description: >- + The type of streaming mode used by the + materialization pipeline. + shuffle_partitions: + type: integer + description: >- + Number of shuffle partitions for streaming + materialization of this feature. Higher values + process high-throughput features with more + parallelism at higher compute cost. Materialized + features which are computed together will use the + largest value set among them. + description: >- + The Structured Streaming trigger mode used for + materialization. Real-time mode (RTM) targets + sub-second latency for operational workloads; + micro-batch mode (MBM) favors cost efficiency for ETL + and analytics workloads. + table_name: + type: string + description: >- + The fully qualified Unity Catalog path to the table + containing the materialized feature (Delta table or + Lakebase table). Output only. + table_trigger: + type: object + properties: + condition: + type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED + description: >- + Which source table updates trigger a + materialization run. If not set, any source table + update triggers a run. + min_time_between_triggers: + type: string + description: >- + The minimum time between two triggered runs, so a + frequently updated source table does not trigger + runs too often. If not set, a feature with a + sliding window uses half its slide_duration and a + feature with a tumbling window uses half its + window_duration, clamped to between 5 minutes and + 1 hour. Other features have no minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without updates + before a run starts, so a series of updates + settles before the run. If not set, a run starts + as soon as the source table updates. + description: >- + A trigger that fires when the upstream source table + changes. + tags: + type: object + description: >- + Custom tags to associate with this materialization. + They are applied to the materialization job (for batch + features) or pipeline (for streaming features) and + forwarded to the underlying compute as cluster tags, + so materialization cost can be attributed in the + billing system tables. These tags apply only to the + materialization compute; they are not applied to the + Unity Catalog Feature resource itself, whose tags are + managed separately through the Unity Catalog tagging + API. A maximum of 25 tags is supported; keys and + values are subject to the same limitations as cluster + tags. + required: + - feature_name + description: >- + A materialized feature represents a feature that is + continuously computed and stored. + description: >- + The materialized features in this set. Order is not + significant. Updating the set with a materialized feature + removed from this set will cause it to be deleted. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI /api/2.0/feature-engineering/materialized-features: post: operationId: feature_engineering_create_materialized_feature @@ -4483,153 +5793,290 @@ paths: schema: type: object properties: - materialized_feature: + feature_name: + type: string + description: The full name of the feature in Unity Catalog. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the serverless + compute cost of this materialization. If not specified, a + default budget policy may be applied. + cron_schedule: + type: string + cron_schedule_trigger: type: object properties: - feature_name: + cron_expression: type: string - description: The full name of the feature in Unity Catalog. - cron_schedule: - type: string - description: >- - The quartz cron expression that defines the schedule of - the materialization pipeline. The schedule is evaluated - in the UTC timezone. Hidden from GraphQL: superseded by - the ``trigger`` oneof (cron_schedule_trigger), so not - exposed to Catalog Explorer. - cron_schedule_trigger: - type: object - properties: - cron_expression: - type: string - description: >- - The cron expression defining the schedule (e.g., "0 - 0 * * *" for daily at midnight). description: >- - A cron-based schedule trigger for the materialization - pipeline. - is_online: - type: boolean - description: >- - True if this is an online materialized feature. False if - it is an offline materialized feature. - last_materialization_time: + The cron expression defining the schedule (e.g., "0 0 * + * *" for daily at midnight). The schedule is interpreted + in timezone_id (defaults to UTC). Required when mode is + MANUAL (or unset). Left empty when mode is DERIVED, + where the service computes it (aligned to UTC) from the + features' window timing and fills it in on the response. + mode: type: string + x-enum: + - DERIVED + - MANUAL description: >- - The timestamp when the pipeline last ran and updated the - materialized feature values. If the pipeline has not run - yet, this field will be null. - materialized_feature_id: + How the schedule is determined. Defaults to MANUAL when + unset. + timezone_id: type: string description: >- - Server-assigned unique identifier for the materialized - feature. - offline_store_config: + A Java timezone ID. The schedule is resolved with + respect to this timezone. Defaults to UTC when omitted. + Can only be configured for MANUAL schedules; DERIVED + schedules are always aligned to UTC. + description: >- + A cron-based schedule trigger for the materialization + pipeline. + is_online: + type: boolean + description: >- + True if this is an online materialized feature. False if it + is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. This is + present for both batch and streaming features. + last_materialization_time: + type: string + description: >- + The timestamp when the pipeline last ran and updated the + materialized feature values. If the pipeline has not run + yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this materialized + feature. Format: operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature was + created for, through DABs or direct-engine creation. Unset + for a materialized feature that was not created as part of a + set. + materialized_feature_id: + type: string + description: >- + Server-assigned unique identifier for the materialized + feature. + notifications: + type: object + properties: + on_failure: type: object properties: - catalog_name: - type: string - description: The Unity Catalog catalog name. - schema_name: - type: string - description: The Unity Catalog schema name. - table_name_prefix: - type: string + destination_ids: + type: array + items: + type: string description: >- - Prefix for Unity Catalog table name. The - materialized feature will be stored in a table with - this prefix and a generated postfix. - required: - - catalog_name - - schema_name - - table_name_prefix - description: >- - Destination for writing feature values to an offline - Delta table. - online_store_config: + IDs of the notification destinations (for example + Slack, Microsoft Teams, PagerDuty, or a generic + webhook) to notify. Not supported for streaming + materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final attempt of a run + fails. If false or unset, notify on every failed + attempt, including attempts that will be retried. + Batch materialization does not retry failures that + need a fix on your side, such as missing permissions + or invalid configuration, so the first attempt is + the final one. Other batch failures are retried up + to twice. Streaming materialization restarts a + failed update indefinitely unless the error cannot + be retried. With this set, a streaming materialized + feature notifies only on errors that cannot be + retried, and never on failures that are restarted. + description: Who to notify when a run fails, and on which attempts. + on_success: type: object properties: - catalog_name: - type: string - description: >- - The Unity Catalog catalog name. This name is also - used as the Lakebase logical database name. Quoting - is handled by the backend where needed, do not - pre-quote it. - schema_name: - type: string - description: >- - The Unity Catalog schema name. This name is also - used as the Lakebase schema name under the database. - Quoting is handled by the backend where needed, do - not pre-quote it. - table_name_prefix: - type: string + destination_ids: + type: array + items: + type: string description: >- - Prefix for Unity Catalog table name. The - materialized feature will be stored in a Lakebase - table with this prefix and a generated postfix. - online_store_name: - type: string - description: The name of the target online store. - required: - - catalog_name - - schema_name - - table_name_prefix - - online_store_name + IDs of the notification destinations (for example + Slack, Microsoft Teams, PagerDuty, or a generic + webhook) to notify. Not supported for streaming + materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Who to notify when a run succeeds. + description: >- + Notification configuration around the materialization job or + pipeline lifecycle. They are applied to every job and + pipeline that materializes this feature. Features which are + materialized in the same pipeline will share the same + notification. + offline_store_config: + type: object + properties: + catalog_name: + type: string + description: The Unity Catalog catalog name. + schema_name: + type: string + description: The Unity Catalog schema name. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The materialized + feature will be stored in a table with this prefix and a + generated postfix. + required: + - catalog_name + - schema_name + - table_name_prefix + description: >- + Destination for writing feature values to an offline Delta + table. The resulting table is returned as ``table_name``. + online_store_config: + type: object + properties: + catalog_name: + type: string + description: >- + The Unity Catalog catalog name. This name is also used + as the Lakebase logical database name. Quoting is + handled by the backend where needed, do not pre-quote + it. + schema_name: + type: string + description: >- + The Unity Catalog schema name. This name is also used as + the Lakebase schema name under the database. Quoting is + handled by the backend where needed, do not pre-quote + it. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The materialized + feature will be stored in a Lakebase table with this + prefix and a generated postfix. + online_store_name: + type: string + description: The name of the target online store. + required: + - catalog_name + - schema_name + - table_name_prefix + - online_store_name + description: >- + Destination for writing feature values to an online Lakebase + table. The resulting table is returned as ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this feature. This + is only present for streaming features. + pipeline_schedule_state: + type: string + x-enum: + - ACTIVE + - PAUSED + - SNAPSHOT + description: >- + The schedule state of the materialization pipeline. Hidden + from GraphQL: being deprecated, so not exposed to Catalog + Explorer. + streaming_mode: + type: object + properties: + freshness_target: + type: string description: >- - Destination for writing feature values to an online - Lakebase table. - pipeline_schedule_state: + The desired data freshness for feature materialization, + expressed as a duration string (e.g. "1 minute"). + mode: type: string x-enum: - - ACTIVE - - PAUSED - - SNAPSHOT + - STREAMING_MODE_TYPE_MBM + - STREAMING_MODE_TYPE_RTM description: >- - The schedule state of the materialization pipeline. - Hidden from GraphQL: being deprecated, so not exposed to - Catalog Explorer. - streaming_mode: - type: object - properties: - freshness_target: - type: string - description: >- - The desired data freshness for feature - materialization, expressed as a duration string - (e.g. "1 minute"). - mode: - type: string - x-enum: - - STREAMING_MODE_TYPE_MBM - - STREAMING_MODE_TYPE_RTM - description: >- - The type of streaming mode used by the - materialization pipeline. + The type of streaming mode used by the materialization + pipeline. + shuffle_partitions: + type: integer description: >- - The Structured Streaming trigger mode used for - materialization. Real-time mode (RTM) targets sub-second - latency for operational workloads; micro-batch mode - (MBM) favors cost efficiency for ETL and analytics - workloads. - table_name: + Number of shuffle partitions for streaming + materialization of this feature. Higher values process + high-throughput features with more parallelism at higher + compute cost. Materialized features which are computed + together will use the largest value set among them. + description: >- + The Structured Streaming trigger mode used for + materialization. Real-time mode (RTM) targets sub-second + latency for operational workloads; micro-batch mode (MBM) + favors cost efficiency for ETL and analytics workloads. + table_name: + type: string + description: >- + The fully qualified Unity Catalog path to the table + containing the materialized feature (Delta table or Lakebase + table). Output only. + table_trigger: + type: object + properties: + condition: type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED description: >- - The fully qualified Unity Catalog path to the table - containing the materialized feature (Delta table or - Lakebase table). Output only. - table_trigger: - type: object - properties: {} + Which source table updates trigger a materialization + run. If not set, any source table update triggers a run. + min_time_between_triggers: + type: string description: >- - A trigger that fires when the upstream source table - changes. - required: - - feature_name - description: The materialized feature to create. + The minimum time between two triggered runs, so a + frequently updated source table does not trigger runs + too often. If not set, a feature with a sliding window + uses half its slide_duration and a feature with a + tumbling window uses half its window_duration, clamped + to between 5 minutes and 1 hour. Other features have no + minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without updates before + a run starts, so a series of updates settles before the + run. If not set, a run starts as soon as the source + table updates. + description: A trigger that fires when the upstream source table changes. + tags: + type: object + description: >- + Custom tags to associate with this materialization. They are + applied to the materialization job (for batch features) or + pipeline (for streaming features) and forwarded to the + underlying compute as cluster tags, so materialization cost + can be attributed in the billing system tables. These tags + apply only to the materialization compute; they are not + applied to the Unity Catalog Feature resource itself, whose + tags are managed separately through the Unity Catalog + tagging API. A maximum of 25 tags is supported; keys and + values are subject to the same limitations as cluster tags. required: - - materialized_feature + - feature_name responses: '200': description: Success @@ -4734,327 +6181,164 @@ paths: schema: type: object properties: - stream: + name: + type: string + description: Full three-part (catalog.schema.stream) name of the stream. + source_config: type: object properties: - name: - type: string - description: >- - Full three-part (catalog.schema.stream) name of the - stream. - source_config: + kafka_stream_config: type: object properties: - kafka_stream_config: + subscription_mode: type: object properties: - subscription_mode: - type: object - properties: - assign: - type: string - description: >- - A JSON string that contains the specific - topic-partitions to consume from. For - example, for - '{"topicA":[0,1],"topicB":[2,4]}', topicA's - 0'th and 1st partitions will be consumed - from. - subscribe: - type: string - description: >- - A comma-separated list of Kafka topics to - read from. For example, - 'topicA,topicB,topicC'. - subscribe_pattern: - type: string - description: >- - A regular expression matching topics to - subscribe to. For example, 'topic.*' will - subscribe to all topics starting with - 'topic'. + assign: + type: string description: >- - Options to configure which Kafka topics to pull - data from. - extra_options: - type: object + A JSON string that contains the specific + topic-partitions to consume from. For example, + for '{"topicA":[0,1],"topicB":[2,4]}', topicA's + 0'th and 1st partitions will be consumed from. + subscribe: + type: string description: >- - Optional Kafka source or consumer options, - validated against a server-side allowlist at - request time. Allowed keys: - - ``maxOffsetsPerTrigger`` - ``startingOffsets`` - - ``includeHeaders`` - - ``kafka.request.timeout.ms`` - - ``kafka.session.timeout.ms`` - - ``kafka.max.partition.fetch.bytes`` The - following keys are ingestion-only and are - stripped before being forwarded to the - materialization pipeline: - - ``maxOffsetsPerTrigger`` - ``startingOffsets`` - Auth and connection details belong on the parent - Stream's ``connection_config``, not here. - required: - - subscription_mode - description: Configuration for Apache Kafka streams. - kinesis_stream_config: + A comma-separated list of Kafka topics to read + from. For example, 'topicA,topicB,topicC'. + subscribe_pattern: + type: string + description: >- + A regular expression matching topics to + subscribe to. For example, 'topic.*' will + subscribe to all topics starting with 'topic'. + description: >- + Options to configure which Kafka topics to pull data + from. + extra_options: + type: object + description: >- + Optional Kafka source or consumer options, validated + against a server-side allowlist at request time. + Allowed keys: - ``maxOffsetsPerTrigger`` - + ``startingOffsets`` - ``includeHeaders`` - + ``kafka.request.timeout.ms`` - + ``kafka.session.timeout.ms`` - + ``kafka.max.partition.fetch.bytes`` The following + keys are ingestion-only and are stripped before + being forwarded to the materialization pipeline: - + ``maxOffsetsPerTrigger`` - ``startingOffsets`` Auth + and connection details belong on the parent Stream's + ``connection_config``, not here. + required: + - subscription_mode + description: Configuration for Apache Kafka streams. + kinesis_stream_config: + type: object + properties: + extra_options: + type: object + description: >- + Optional Kinesis source options, validated against a + server-side allowlist at request time. Allowed keys: + - ``consumerMode`` - ``consumerNamePrefix`` - + ``maxFetchRate`` - ``minFetchPeriod`` - + ``maxFetchDuration`` - ``maxRecordsPerFetch`` - + ``shardsPerTask`` - ``fetchBufferSize`` - + ``shardFetchInterval`` ``consumerMode`` must be + ``efo`` or ``polling`` (case-insensitive). + ``maxRecordsPerFetch`` applies only during ingestion + and does not affect the materialization pipeline. + Auth and connection details belong on the parent + Stream's ``connection_config``, not here. + stream_arns: type: object properties: - extra_options: - type: object + arns: + type: array + items: + type: string description: >- - Optional Kinesis source options, validated - against a server-side allowlist at request time. - Auth and connection details belong on the parent - Stream's ``connection_config``, not here. - stream_arns: - type: object - properties: - arns: - type: array - items: - type: string - description: >- - Kinesis stream ARNs to read from. For - example, - 'arn:aws:kinesis:us-west-2:111122223333:stream/stream-a'. - description: Kinesis stream ARNs to read from. - stream_names: - type: object - properties: - names: - type: array - items: - type: string - description: Kinesis stream names to read from. + Kinesis stream ARNs to read from. For example, + 'arn:aws:kinesis:us-west-2:111122223333:stream/stream-a'. + description: Kinesis stream ARNs to read from. + stream_names: + type: object + properties: + names: + type: array + items: + type: string description: Kinesis stream names to read from. - description: Configuration for AWS Kinesis Data Streams. - description: >- - Source-specific configuration. Determines the streaming - platform source. - connection_config: + description: Kinesis stream names to read from. + description: Configuration for AWS Kinesis Data Streams. + description: >- + Source-specific configuration. Determines the streaming + platform source. + connection_config: + type: object + properties: + direct_mtls_config: type: object properties: - direct_mtls_config: + bootstrap_servers: + type: string + description: >- + A comma-separated list of host:port pairs for the + Kafka bootstrap servers. + mtls_config: type: object properties: - bootstrap_servers: + keystore_location: type: string description: >- - A comma-separated list of host:port pairs for - the Kafka bootstrap servers. - mtls_config: + Unity Catalog volume path to the JKS keystore + file containing the client certificate and + private key. e.g. + "/Volumes////client.jks". + The materialization compute must have read + permission on this volume. + keystore_password_ref: type: object properties: - keystore_location: + scope: type: string - description: >- - Unity Catalog volume path to the JKS - keystore file containing the client - certificate and private key. e.g. - "/Volumes////client.jks". - The materialization compute must have read - permission on this volume. - keystore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS keystore - password. - key_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the private key - password. Often the same value as the - keystore password (keytool's default), but - provided as a separate field because Apache - Kafka requires it as a distinct option - (kafka.ssl.key.password). - truststore_location: + description: The Databricks secret scope name. + key: type: string - description: >- - Unity Catalog volume path to the JKS - truststore file containing the CA - certificate(s) trusted to verify the Kafka - broker's server certificate. e.g. - "/Volumes////truststore.jks". - truststore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS - truststore password. - disable_hostname_verification: - type: boolean - description: >- - Set to true only when the broker - certificate's SAN intentionally does not - match the connection endpoint — for example - when reaching the cluster through a - PrivateLink endpoint whose DNS name is not - in the broker certificate. Skipping the - hostname check removes a defense against - man-in-the-middle attacks; do not enable - casually. mTLS client authentication is - unaffected by this option. See the Apache - Kafka SSL security guide for background on - this check: - https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + description: The key within the scope. required: - - keystore_location - - keystore_password_ref - - key_password_ref - - truststore_location - - truststore_password_ref - description: Mutual-TLS authentication configuration. - required: - - bootstrap_servers - - mtls_config - description: >- - Direct mTLS configuration for stream platform - access. This is only used in the short term until UC - Kafka Connections support mTLS . Once UC Kafka - Connections support mTLS, this will be deprecated. - uc_connection_name: - type: string - description: >- - Name of an existing UC Connection for stream - platform access. Must be the correct type for the - streaming platform (e.g. a Kafka Connection for a - Kafka Stream, or a Kinesis Connection for a Kinesis - Stream). - description: >- - Specifies how to connect and authenticate to the stream - platform. - schema_config: - type: object - properties: - direct_schemas: - type: object - properties: - key_schema: - type: object - properties: - avro_schema: - type: string - json_schema: - type: string - description: >- - Schema of the JSON object in standard IETF - JSON schema format - (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and - proto3 syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message - within schema_text that describes the - Kafka payload (e.g. "Event" or - "com.example.Event" if schema_text - declares a package). Identifies which - message is used to decode each Kafka - record — a .proto file may declare - multiple messages but only one - represents the payload. Must not be - empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload - message name. + - scope + - key description: >- - Schema for the message key. This is only used - for Kafka streams. For Kafka, at least one of - payload_schema or key_schema must be specified. - payload_schema: + Secret-scope reference for the JKS keystore + password. + key_password_ref: type: object properties: - avro_schema: + scope: type: string - json_schema: + description: The Databricks secret scope name. + key: type: string - description: >- - Schema of the JSON object in standard IETF - JSON schema format - (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and - proto3 syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message - within schema_text that describes the - Kafka payload (e.g. "Event" or - "com.example.Event" if schema_text - declares a package). Identifies which - message is used to decode each Kafka - record — a .proto file may declare - multiple messages but only one - represents the payload. Must not be - empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload - message name. + description: The key within the scope. + required: + - scope + - key description: >- - Schema for the message payload. For Kafka, this - is the value schema. Unless the platform - supports another schema (e.g. keys for Kafka), - this must be specified. - description: Schema definitions provided directly on the Stream. - schema_registry_config: - type: object - properties: - api_secret_ref: + Secret-scope reference for the private key + password. Often the same value as the keystore + password (keytool's default), but provided as a + separate field because Apache Kafka requires it + as a distinct option (kafka.ssl.key.password). + truststore_location: + type: string + description: >- + Unity Catalog volume path to the JKS truststore + file containing the CA certificate(s) trusted to + verify the Kafka broker's server certificate. + e.g. + "/Volumes////truststore.jks". + truststore_password_ref: type: object properties: scope: @@ -5067,257 +6351,429 @@ paths: - scope - key description: >- - Reference to the schema registry API secret in a - Databricks secret scope. - key_schema_locator: + Secret-scope reference for the JKS truststore + password. + disable_hostname_verification: + type: boolean + description: >- + Set to true only when the broker certificate's + SAN intentionally does not match the connection + endpoint — for example when reaching the cluster + through a PrivateLink endpoint whose DNS name is + not in the broker certificate. Skipping the + hostname check removes a defense against + man-in-the-middle attacks; do not enable + casually. mTLS client authentication is + unaffected by this option. See the Apache Kafka + SSL security guide for background on this check: + https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + required: + - keystore_location + - keystore_password_ref + - key_password_ref + - truststore_location + - truststore_password_ref + description: Mutual-TLS authentication configuration. + required: + - bootstrap_servers + - mtls_config + description: Direct mTLS configuration for stream platform access. + uc_connection_name: + type: string + description: >- + Name of an existing UC Connection for stream platform + access. Must be the correct type for the streaming + platform (e.g. a Kafka Connection for a Kafka Stream, or + a Kinesis Connection for a Kinesis Stream). + description: >- + Specifies how to connect and authenticate to the stream + platform. + schema_config: + type: object + properties: + direct_schemas: + type: object + properties: + key_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON + schema format (https://json-schema.org/). + proto_schema: type: object properties: - format: + schema_text: type: string - x-enum: - - FORMAT_AVRO - - FORMAT_JSON - - FORMAT_PROTOBUF - description: Serialization format for this schema. - confluent_schema: - type: object - properties: - subject: - type: string - description: >- - The Confluent schema registry subject - name. - required: - - subject - description: Confluent Schema Registry schema locator. + description: >- + The raw .proto file text (proto2 and proto3 + syntax supported, see + https://protobuf.dev/programming-guides/proto3/ + and + https://protobuf.dev/programming-guides/proto2/). + message_name: + type: string + description: >- + The fully-qualified name of the message + within schema_text that describes the Kafka + payload (e.g. "Event" or "com.example.Event" + if schema_text declares a package). + Identifies which message is used to decode + each Kafka record — a .proto file may + declare multiple messages but only one + represents the payload. Must not be empty. required: - - format + - schema_text + - message_name description: >- - Schema locator for the message key. Only used - for Kafka streams. At least one of - payload_schema_locator or key_schema_locator - must be set. - payload_schema_locator: + Protocol Buffer schema with its payload message + name. + description: >- + Schema for the message key. This is only used for + Kafka streams. For Kafka, at least one of + payload_schema or key_schema must be specified. + payload_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON + schema format (https://json-schema.org/). + proto_schema: type: object properties: - format: + schema_text: type: string - x-enum: - - FORMAT_AVRO - - FORMAT_JSON - - FORMAT_PROTOBUF - description: Serialization format for this schema. - confluent_schema: - type: object - properties: - subject: - type: string - description: >- - The Confluent schema registry subject - name. - required: - - subject - description: Confluent Schema Registry schema locator. + description: >- + The raw .proto file text (proto2 and proto3 + syntax supported, see + https://protobuf.dev/programming-guides/proto3/ + and + https://protobuf.dev/programming-guides/proto2/). + message_name: + type: string + description: >- + The fully-qualified name of the message + within schema_text that describes the Kafka + payload (e.g. "Event" or "com.example.Event" + if schema_text declares a package). + Identifies which message is used to decode + each Kafka record — a .proto file may + declare multiple messages but only one + represents the payload. Must not be empty. required: - - format + - schema_text + - message_name description: >- - Schema locator for the message payload. For - Kafka this is the value. At least one of - payload_schema_locator or key_schema_locator - must be set. - uc_connection: - type: string - description: A Schema Registry UC Connection object. - required: - - api_secret_ref - description: Resolve schemas from an external schema registry. - description: >- - Schema definitions for the stream, provided either - directly on the Stream or resolved from an external - schema registry through a UC Connection. - ingestion_config: + Protocol Buffer schema with its payload message + name. + description: >- + Schema for the message payload. For Kafka, this is + the value schema. Unless the platform supports + another schema (e.g. keys for Kafka), this must be + specified. + description: Schema definitions provided directly on the Stream. + schema_registry_config: type: object properties: - ingestion_destination: + api_secret_ref: type: object properties: - delta_table_name: + scope: type: string - description: >- - The full three-part name (catalog, schema, name) - of the Delta table to be created for ingestion. - description: >- - Destination for the Databricks-managed Delta table - that holds an offline copy of the streaming data for - querying and training. This table contains both 1) - forward-filled data from the Stream and 2) - backfilled data from the BackfillSource (if - provided). This table is created and managed by - Databricks and is deleted when the Stream is - deleted. - backfill_job_id: - type: integer + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key description: >- - The ID of the Databricks Job that performs the - historical backfill of the ingestion Delta table. - backfill_source: + Reference to the schema registry API secret in a + Databricks secret scope. Set this only if required + for authentication for the schema registry. + key_schema_locator: type: object properties: - delta_table_name: + format: type: string - delta_table_source: + x-enum: + - FORMAT_AVRO + - FORMAT_JSON + - FORMAT_PROTOBUF + description: Serialization format for this schema. + confluent_schema: type: object properties: - full_name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON - format (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept - for backwards compatibility. The entity - columns of the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table - before applying transformations. Will be - row-wise evaluated, so should only include - conditionals and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. - The timeseries column of the Delta table. - transformation_sql: + subject: type: string - description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b - AS col_c FROM x.y.z WHERE col_a > 0" would - have ``transformation_sql`` "*, col_a + - col_b AS col_c") If transformation_sql is - not provided, all columns of the delta table - are present in the DataSource dataframe. + description: The Confluent schema registry subject name. required: - - full_name - description: >- - Deprecated: Use delta_table_name instead. Kept - for backwards compatibility. The Delta table - source containing the historical data to - backfill. Only the delta table name is used for - backfill, other fields are ignored. - description: >- - A user-provided source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Stream. The - backfill data stored in this location will be copied - into the ingestion table for offline querying and - training. The schema for this source must match - exactly that of the key and payload schemas - specified for this Stream. - deduplication_columns: - type: array - items: - type: string + - subject + description: Confluent Schema Registry schema locator. + required: + - format description: >- - Column paths used to identify duplicate rows during - ingestion; only one row per distinct combination of - these values is kept. Use dot notation for nested - fields (e.g. ``value.user_id``). Empty list means - every column is compared. - ingestion_job_id: - type: integer + Schema locator for the message key. Only used for + Kafka streams. At least one of + payload_schema_locator or key_schema_locator must be + set. + payload_schema_locator: + type: object + properties: + format: + type: string + x-enum: + - FORMAT_AVRO + - FORMAT_JSON + - FORMAT_PROTOBUF + description: Serialization format for this schema. + confluent_schema: + type: object + properties: + subject: + type: string + description: The Confluent schema registry subject name. + required: + - subject + description: Confluent Schema Registry schema locator. + required: + - format description: >- - The ID of the Databricks Job that performs the - forward-fill ingestion. - ingestion_pipeline_id: + Schema locator for the message payload. For Kafka + this is the value. At least one of + payload_schema_locator or key_schema_locator must be + set. + uc_connection: + type: string + description: A Schema Registry UC Connection object. + description: Resolve schemas from an external schema registry. + description: >- + Schema definitions for the stream, provided either directly + on the Stream or resolved from an external schema registry + through a UC Connection. + ingestion_config: + type: object + properties: + ingestion_destination: + type: object + properties: + delta_table_name: type: string description: >- - The ID of the SDP pipeline that continuously copies - new events from the streaming source into the - ingestion Delta table. - required: - - ingestion_destination + The full three-part name (catalog, schema, name) of + the Delta table to be created for ingestion. description: >- - Configuration for streaming data ingestion: the managed - table storing an offline copy of forward fill data and - optional historical backfill. - browse_only: - type: boolean + Destination for the Databricks-managed Delta table that + holds an offline copy of the streaming data for querying + and training. This table contains both 1) forward-filled + data from the Stream and 2) backfilled data from the + BackfillSource (if provided). This table is created and + managed by Databricks and is deleted when the Stream is + deleted. + backfill_job_id: + type: integer 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. - create_time: - type: string - format: date-time - description: Time at which this Stream was created. - created_by: - type: string - description: Username of the Stream creator. - description: - type: string - description: User-provided description. - update_time: - type: string - format: date-time - description: Time at which this Stream was last modified. - updated_by: - type: string - description: Username of user who last modified the Stream. - required: - - name - - source_config - - connection_config - - schema_config - - ingestion_config - description: The Stream to create. - required: - - stream - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Stream' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: FeatureEngineeringAPI - get: - operationId: feature_engineering_list_streams - summary: List Streams under a given catalog.schema parent. - tags: - - ml - - feature_engineering - description: |- - List Streams under a given catalog.schema parent. - - :param page_size: int (optional) - The maximum number of results to return. - :param page_token: str (optional) - Pagination token to go to the next page based on a previous query. + The ID of the Databricks Job that performs the + historical backfill of the ingestion Delta table. + backfill_source: + type: object + properties: + delta_table_name: + type: string + delta_table_source: + type: object + properties: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string + description: >- + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals + and projections. + timeseries_column: + type: string + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contains all the + columns needed (eg. "SELECT *, col_a + col_b AS + col_c FROM x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS + col_c") If transformation_sql is not provided, + all columns of the delta table are present in + the DataSource dataframe. + required: + - full_name + description: >- + Deprecated: Use delta_table_name instead. Kept for + backwards compatibility. The Delta table source + containing the historical data to backfill. Only the + delta table name is used for backfill, other fields + are ignored. + description: >- + A user-provided source for backfilling data. Historical + data is used when creating a training set from streaming + features linked to this Stream. The backfill data stored + in this location will be copied into the ingestion table + for offline querying and training. The schema for this + source must match exactly that of the key and payload + schemas specified for this Stream, except that it may + omit any columns listed in excluded_columns. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this stream's managed + ingestion. If not specified, a default budget policy may + be applied. + deduplication_columns: + type: array + items: + type: string + description: >- + Column paths used to identify duplicate rows during + ingestion; only one row per distinct combination of + these values is kept. Use dot notation for nested fields + (e.g. ``value.user_id``). Empty list means every column + is compared. + ingestion_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + forward-fill ingestion. + ingestion_pipeline_id: + type: string + description: >- + The ID of the SDP pipeline that continuously copies new + events from the streaming source into the ingestion + Delta table. + tags: + type: object + description: >- + Custom tags to associate with this stream's managed + ingestion. They are applied to the ingestion pipeline + and its forward-fill and backfill jobs, and forwarded to + the underlying compute as cluster tags, so ingestion + cost can be attributed in the billing system tables. + These tags apply only to the managed ingestion compute; + they are not applied to the Stream entity itself, and + are distinct from any Unity Catalog tags on the Stream. + A maximum of 25 tags is supported; keys and values are + subject to the same limitations as cluster tags. + required: + - ingestion_destination + description: >- + Configuration for streaming data ingestion: the managed + table storing an offline copy of forward fill data and + optional historical backfill. + browse_only: + type: boolean + 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. + create_time: + type: string + format: date-time + description: Time at which this Stream was created. + created_by: + type: string + description: Username of the Stream creator. + description: + type: string + description: User-provided description. + excluded_columns: + type: array + items: + type: string + description: >- + Column paths (dot notation, e.g. "value.email" for Kafka) to + drop. A path may reference a struct, in which case all of + its nested fields are dropped (e.g. "value.address" drops + "value.address.city" and "value.address.zip"). These columns + are not written to the ingestion table and cannot be + referenced by any feature. They are dropped from ingestion, + backfill, and materialization. For direct schemas, each + column must exist in the relevant key or payload schema. + With a schema registry, a column can be excluded before it + exists. A column cannot also be a deduplication column in + the ingestion_config. + record_type_filter: + type: string + description: >- + Optional SQL predicate to filter which record types from a + streaming channel (e.g. a topic for Kafka) belong to this + Stream. Events that do not match are not written to the + ingestion table and are not used in materialization. + Example: "value.event_type = 'transaction'". + update_time: + type: string + format: date-time + description: Time at which this Stream was last modified. + updated_by: + type: string + description: Username of user who last modified the Stream. + required: + - name + - source_config + - connection_config + - schema_config + - ingestion_config + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + get: + operationId: feature_engineering_list_streams + summary: List Streams under a given catalog.schema parent. + tags: + - ml + - feature_engineering + description: |- + List Streams under a given catalog.schema parent. + + :param page_size: int (optional) + The maximum number of results to return. + :param page_token: str (optional) + Pagination token to go to the next page based on a previous query. :param parent: str (optional) Two-part name (catalog.schema) of the parent under which to list Streams. @@ -5445,13 +6901,11 @@ paths: Update a Feature. :param full_name: str - The full three-part name (catalog, schema, name) of the feature. This is the feature's resource - identifier; the catalog_name, schema_name, and name fields below are OUTPUT_ONLY decomposed views of - this value. + The full three-part name (catalog, schema, name) of the feature. :param feature: :class:`Feature` - Feature to update. + Feature whose full_name identifies the target. Only description is mutable. :param update_mask: str - The list of fields to update. + Fields to update. The only supported path is description. :returns: :class:`Feature` parameters: @@ -5460,830 +6914,1064 @@ paths: required: true schema: type: string - description: >- - The full three-part name (catalog, schema, name) of the feature. - This is the feature's resource identifier; the catalog_name, - schema_name, and name fields below are OUTPUT_ONLY decomposed views - of this value. + description: The full three-part name (catalog, schema, name) of the feature. - name: update_mask in: query required: true schema: type: string - description: The list of fields to update. + description: Fields to update. The only supported path is description. requestBody: content: application/json: schema: type: object properties: - feature: + full_name: + type: string + source: type: object properties: - full_name: - type: string - source: + delta_table_source: type: object properties: - delta_table_source: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string + description: >- + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals and + projections. + timeseries_column: + type: string + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contains all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the delta table are present in the DataSource + dataframe. + required: + - full_name + description: A Delta table data source. + feature_view_source: + type: object + properties: + feature_references: + type: array + items: + type: object + properties: + feature: + type: string + description: >- + The three-part full name of the upstream + Feature. + required: + - feature + description: >- + A reference to one registered upstream Feature. A + message rather than a bare name so an upstream + can later be pinned more precisely (e.g. by version) without a breaking type change. + description: >- + The upstream Features this source reads. Must + include at least one feature. + description: >- + A data source composed from registered upstream + Features. + kafka_source: + type: object + properties: + name: + type: string + entity_column_identifiers: + type: array + items: + type: object + properties: + variant_expr_path: + type: string + required: + - variant_expr_path + filter_condition: + type: string + description: >- + The filter condition applied to the source data + before aggregation. + timeseries_column_identifier: type: object properties: - full_name: - type: string - dataframe_schema: + variant_expr_path: type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity columns of - the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table before - applying transformations. Will be row-wise - evaluated, so should only include conditionals - and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column of the Delta table. - transformation_sql: - type: string - description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b AS - col_c FROM x.y.z WHERE col_a > 0" would have - ``transformation_sql`` "*, col_a + col_b AS - col_c") If transformation_sql is not provided, - all columns of the delta table are present in - the DataSource dataframe. required: - - full_name - description: A Delta table data source. - kafka_source: + - variant_expr_path + required: + - name + description: A Kafka stream data source. + lateness: + type: object + properties: + settling_delay: + type: string + description: >- + Non-negative time to wait after a window ends before + treating its source data as complete. Training + shifts the eligible evaluation time backwards by + this duration so it does not join data that would + still have been settling online. Materialization + waits for the duration to elapse before publishing + the window. If unset, source data is considered + settled immediately. + description: >- + Completeness timing for this Feature's use of the + source. This configuration is part of the Feature + definition; it does not modify the underlying table or + stream. + request_source: + type: object + properties: + dataframe_schema: + type: string + description: >- + A schema containing scalar or nested fields, in + Spark StructType JSON format (from + df.schema.json()). This preserves field, + array-element, and map-value nullability. + flat_schema: type: object properties: - name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Any subsequent - functions operate against this dataframe. - entity_column_identifiers: + fields: type: array items: type: object properties: - variant_expr_path: + name: + type: string + description: The name of the field. + data_type: type: string + x-enum: + - BINARY + - BOOLEAN + - DATE + - DECIMAL + - DOUBLE + - FLOAT + - INTEGER + - LONG + - SHORT + - STRING + - TIMESTAMP + description: The scalar data type of the field. required: - - variant_expr_path - description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity column - identifiers of the Kafka source. - filter_condition: - type: string - description: >- - The filter condition applied to the source data - before aggregation. - timeseries_column_identifier: - type: object - properties: - variant_expr_path: - type: string - required: - - variant_expr_path - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column identifier of the Kafka - source. - transformation_sql: - type: string - description: >- - The pipeline runs these SQL statements - immediately after conversion into the schema - specified on the KafkaConfig object. - required: - - name - description: A Kafka stream data source. - request_source: - type: object - properties: - flat_schema: - type: object - properties: - fields: - type: array - items: - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - x-enum: - - BINARY - - BOOLEAN - - DATE - - DECIMAL - - DOUBLE - - FLOAT - - INTEGER - - LONG - - SHORT - - STRING - - TIMESTAMP - description: The scalar data type of the field. - required: - - name - - data_type - description: >- - A single field definition within a - FlatSchema, specifying the field name and - its scalar data - type. Does not support nested or complex types (arrays, maps, structs). - description: The list of fields in this schema. - required: - - fields - description: A flat schema with scalar-typed fields only. - description: A request-time data source. - stream_source: - type: object - properties: - full_name: - type: string - description: >- - Three-part full name of the Stream - (catalog.schema.stream). - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Any subsequent - functions operate against this dataframe. - filter_condition: - type: string - description: >- - The filter condition applied to the source data - before aggregation. - transformation_sql: - type: string - description: >- - The pipeline runs these SQL statements - immediately after conversion into the schema - specified on the Stream object. + - name + - data_type + description: >- + A single field definition within a FlatSchema, + specifying the field name and its scalar data + type. Does not support nested or complex types (arrays, maps, structs). + description: The list of fields in this schema. required: - - full_name - description: A Stream data source. - description: The data source of the feature. - function: + - fields + description: A flat schema with scalar-typed fields only. + description: A request-time data source. + sdp_source: type: object properties: - aggregation_function: - type: object - properties: - approx_count_distinct: - type: object - properties: - input: - type: string - description: >- - The input column from which the approximate - count of distinct values is computed. - relative_sd: - type: number - description: >- - The maximum relative standard deviation - allowed (default defined by Spark). - required: - - input + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + filter_condition: + type: string + description: >- + Single WHERE clause to filter the pipeline's output + table before applying transformations. Will be + row-wise evaluated, so should only include + conditionals and projections. + input_tables: + type: array + items: + type: string + description: >- + The full three-part names of the tables the pipeline + reads from. Required to materialize this feature + with a TableTrigger, which starts a run when these + tables update. Each table must exist when the + feature is created. Feature Store doesn't confirm + that the pipeline reads from these tables. At most + 100 tables. + output_table: + type: string + description: >- + The full three-part (catalog, schema, table) name of + the pipeline's output table to read from. The table + doesn't need to exist until the pipeline first runs. + Required. + pipeline_id: + type: string + description: >- + The ID of the Spark Declarative Pipeline that + Feature Store runs to produce this source, before + each materialization or backfill. The pipeline must + already exist when the feature is created, and you + need CAN_RUN, CAN_MANAGE, or owner permission on it. + It doesn't need to have run yet. Deleting the + feature doesn't delete the pipeline. If the pipeline + is deleted, this field reads back empty. Required. + pipeline_state: + type: string + x-enum: + - ERROR + - PENDING + - RESOLVED + description: >- + State tracking pipeline execution and output table + validation. PENDING until the pipeline has run at + least once and created the output table; then + RESOLVED on success, or ERROR on failure. + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contain all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the pipeline's output table are present in the + DataSource dataframe. + description: A Spark Declarative Pipeline data source. + stream_source: + type: object + properties: + full_name: + type: string + description: >- + Three-part full name of the Stream + (catalog.schema.stream). + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Any subsequent functions + operate against this dataframe. + filter_condition: + type: string + description: >- + The filter condition applied to the source data + before aggregation. + transformation_sql: + type: string + description: >- + The pipeline runs these SQL statements immediately + after conversion into the schema specified on the + Stream object. + required: + - full_name + description: A Stream data source. + description: The data source of the feature. + function: + type: object + properties: + aggregation_function: + type: object + properties: + approx_count_distinct: + type: object + properties: + input: + type: string description: >- - Computes the approximate count of distinct - values. - approx_percentile: - type: object - properties: - input: - type: string - description: >- - The input column from which the approximate - percentile is computed. - percentile: - type: number - description: >- - The percentile value to compute (between 0 - and 1). - accuracy: - type: integer - description: >- - The accuracy parameter (higher is more - accurate but slower). - required: - - input - - percentile - description: Computes the approximate percentile of values. - avg: - type: object - properties: - input: - type: string - description: >- - The input column from which the average is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. - required: - - input - description: Computes the average of values. - count_function: + The input column from which the approximate + count of distinct values is computed. + relative_error: + type: number + description: >- + The error the user accepts, as a fraction of the + count, between 0.02 (by default) and 0.3. This + is one standard error of the estimate, the same + meaning as Spark's relativeSD: 0.02 means the + result is within ±2% of the true count about 68% + of the time (one standard deviation covers 68% + of the region). Feature Store picks the sketch + size that gives this relative error. If neither + relative_error nor relative_sd is set, 0.02 is + default chosen at feature creation. + relative_sd: + type: number + description: >- + The maximum relative standard deviation allowed + (default defined by Spark). Deprecated: use + relative_error. When relative_error is set, + reads return the same value here for clients + that don't have relative_error, and a request + may only send that value. + required: + - input + description: Computes the approximate count of distinct values. + approx_percentile: + type: object + properties: + input: + type: string + description: >- + The input column from which the approximate + percentile is computed. + percentile: + type: number + description: >- + The percentile value to compute (between 0 and + 1). + accuracy: + type: integer + description: >- + The accuracy parameter (higher is more accurate + but slower). Deprecated: use relative_error. + When relative_error is set, reads return ceil(1 + / relative_error) here for clients that don't + have relative_error, and a request may only send + that value. + relative_error: + type: number + description: >- + The error the user accepts, as a fraction of + rank, between 0.01 (by default) and 0.3. The + result is within this rank error with 99% + confidence: at 0.01, the value returned for p95 + is between the true p94 and p96 at least 99% of + the time. Feature Store picks the sketch size + that gives this error. If neither relative_error + nor accuracy is set, 0.01 is default chosen at + feature creation. + required: + - input + - percentile + description: Computes the approximate percentile of values. + avg: + type: object + properties: + input: + type: string + description: >- + The input column from which the average is + computed. For Kafka sources, use dot-prefixed + path notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. + required: + - input + description: Computes the average of values. + count_function: + type: object + properties: + input: + type: string + description: >- + The input column from which the count is + computed. For Kafka sources, use dot-prefixed + path notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. + required: + - input + description: Computes the count of values. + first: + type: object + properties: + input: + type: string + description: >- + The input column from which the first value is + returned. + required: + - input + description: Returns the first value. + first_distinct: + type: object + properties: + input: + type: string + description: >- + The input column from which the first N distinct + values are returned. + 'n': + type: integer + description: The number of distinct values to return. + required: + - input + - 'n' + description: >- + Returns the first N distinct values, ordered by the + feature's timeseries column. + first_n: + type: object + properties: + input: + type: string + description: >- + The input column from which the first N values + are returned. + 'n': + type: integer + description: The number of values to return. + required: + - input + - 'n' + description: >- + Returns the first N values, ordered by the feature's + timeseries column. + last: + type: object + properties: + input: + type: string + description: >- + The input column from which the last value is + returned. + required: + - input + description: Returns the last value. + last_distinct: + type: object + properties: + input: + type: string + description: >- + The input column from which the last N distinct + values are returned. + 'n': + type: integer + description: The number of distinct values to return. + required: + - input + - 'n' + description: >- + Returns the last N distinct values, ordered by the + feature's timeseries column. + last_n: + type: object + properties: + input: + type: string + description: >- + The input column from which the last N values + are returned. + 'n': + type: integer + description: The number of values to return. + required: + - input + - 'n' + description: >- + Returns the last N values, ordered by the feature's + timeseries column. + max: + type: object + properties: + input: + type: string + description: >- + The input column from which the maximum is + computed. + required: + - input + description: Computes the maximum value. + min: + type: object + properties: + input: + type: string + description: >- + The input column from which the minimum is + computed. + required: + - input + description: Computes the minimum value. + stddev_pop: + type: object + properties: + input: + type: string + description: >- + The input column from which the population + standard deviation is computed. For Kafka + sources, use dot-prefixed path notation (e.g., + "value.amount"). For nested fields, the leaf + node name is used. Colon-prefixed notation + (e.g., "value:amount") is supported for + backwards compatibility but is deprecated; + migrate to dot notation. + required: + - input + description: Computes the population standard deviation. + stddev_samp: + type: object + properties: + input: + type: string + description: >- + The input column from which the sample standard + deviation is computed. + required: + - input + description: Computes the sample standard deviation. + sum: + type: object + properties: + input: + type: string + description: >- + The input column from which the sum is computed. + For Kafka sources, use dot-prefixed path + notation (e.g., "value.amount"). For nested + fields, the leaf node name is used. + Colon-prefixed notation (e.g., "value:amount") + is supported for backwards compatibility but is + deprecated; migrate to dot notation. + required: + - input + description: Computes the sum of values. + time_window: + type: object + properties: + continuous: type: object properties: - input: + window_duration: type: string - description: >- - The input column from which the count is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. - required: - - input - description: Computes the count of values. - first: - type: object - properties: - input: + offset: type: string description: >- - The input column from which the first value - is returned. + The offset of the continuous window (must be + non-positive). required: - - input - description: Returns the first value. - first_distinct: + - window_duration + rolling: type: object properties: - input: + delay: type: string description: >- - The input column from which the first N - distinct values are returned. - 'n': - type: integer - description: The number of distinct values to return. - required: - - input - - 'n' - description: >- - Returns the first N distinct values, ordered by - the feature's timeseries column. - first_n: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + window_duration: type: string description: >- - The input column from which the first N - values are returned. - 'n': - type: integer - description: The number of values to return. - required: - - input - - 'n' + The duration of the rolling window. Must be + positive when set; absent means lifetime + (aggregate over the entity's entire + history). description: >- - Returns the first N values, ordered by the - feature's timeseries column. - last: - type: object - properties: - input: - type: string - description: >- - The input column from which the last value - is returned. - required: - - input - description: Returns the last value. - last_distinct: + A rolling time window with an optional + non-negative delay. + sawtooth: type: object properties: - input: + delay: type: string description: >- - The input column from which the last N - distinct values are returned. - 'n': - type: integer - description: The number of distinct values to return. - required: - - input - - 'n' - description: >- - Returns the last N distinct values, ordered by - the feature's timeseries column. - last_n: - type: object - properties: - input: + Delay is not currently supported for + Sawtooth windows. + window_duration: type: string description: >- - The input column from which the last N - values are returned. - 'n': - type: integer - description: The number of values to return. - required: - - input - - 'n' + The duration of the window. Must be positive + and span more than two days when set, so + that both the batch (N-1 day) and stale-path + (N-2 day) partial aggregates are well + defined. The duration need not be a whole + number of days (e.g. 3 days 15 minutes is + allowed). Absent means lifetime (aggregate + over the entity's entire history). description: >- - Returns the last N values, ordered by the - feature's timeseries column. - max: - type: object - properties: - input: - type: string - description: >- - The input column from which the maximum is - computed. - required: - - input - description: Computes the maximum value. - min: + A sawtooth window served via the hybrid batch + + streaming path. + sliding: type: object properties: - input: + slide_duration: type: string - description: >- - The input column from which the minimum is - computed. - required: - - input - description: Computes the minimum value. - stddev_pop: - type: object - properties: - input: + delay: type: string description: >- - The input column from which the population - standard deviation is computed. For Kafka - sources, use dot-prefixed path notation - (e.g., "value.amount"). For nested fields, - the leaf node name is used. Colon-prefixed - notation (e.g., "value:amount") is supported - for backwards compatibility but is - deprecated; migrate to dot notation. - required: - - input - description: Computes the population standard deviation. - stddev_samp: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + offset: type: string description: >- - The input column from which the sample - standard deviation is computed. - required: - - input - description: Computes the sample standard deviation. - sum: - type: object - properties: - input: + Non-negative phase shift from the default + midnight UTC alignment. For example, + offset=22h on a 24h slide produces + boundaries at 22:00 UTC (17:00 New York in + standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter + than slide_duration (and therefore + window_duration). + window_duration: type: string description: >- - The input column from which the sum is - computed. For Kafka sources, use - dot-prefixed path notation (e.g., - "value.amount"). For nested fields, the leaf - node name is used. Colon-prefixed notation - (e.g., "value:amount") is supported for - backwards compatibility but is deprecated; - migrate to dot notation. + The duration of the sliding window. Must be + positive when set; absent means lifetime + (aggregate over the entity's entire + history). required: - - input - description: Computes the sum of values. - time_window: - type: object - properties: - continuous: - type: object - properties: - window_duration: - type: string - description: >- - The duration of the continuous window - (must be positive). - offset: - type: string - description: >- - The offset of the continuous window - (must be non-positive). - required: - - window_duration - description: >- - Deprecated: use RollingWindow with ``delay`` - instead. - rolling: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the - rolling window (must be non-negative). - For example, delay=1d shifts the window - end 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the rolling window. Must - be positive when set; absent means - lifetime (aggregate over the entity's - entire history). - description: >- - A rolling time window with an optional - delay. This is the SQL-spec-aligned - replacement for - ContinuousWindow: ``delay`` is the non-negative counterpart of the legacy non-positive - ``ContinuousWindow.offset``. - sawtooth: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the - window (must be non-negative). For - example, delay=1d shifts the window end - 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the window. Must be - positive and span more than two days - when set, so that both the batch (N-1 - day) and stale-path (N-2 day) partial - aggregates are well defined. The - duration need not be a whole number of - days (e.g. 3 days 15 minutes is - allowed). Absent means lifetime - (aggregate over the entity's entire - history). - description: >- - A sawtooth window served via the hybrid - batch + streaming path. - sliding: - type: object - properties: - slide_duration: - type: string - window_duration: - type: string - description: >- - The duration of the sliding window. Must - be positive when set; absent means - lifetime (aggregate over the entity's - entire history). - required: - - slide_duration - tumbling: - type: object - properties: - window_duration: - type: string - required: - - window_duration + - slide_duration + start_time: + type: string + format: date-time description: >- - The time window over which the aggregation is - computed. - var_pop: + Earliest event-time boundary at which the + Feature may emit an output. This gates outputs, + not the historical inputs read by a window. For + example, a 365-day window with + start_time=2026-01-01 begins emitting + partial-window values on that date instead of + waiting for 365 days of data; a lifetime window + produces no output before start_time. If unset, + tumbling and fixed-duration sliding windows + first emit at an offset-aligned boundary after a + full window can be formed. If unset, lifetime + sliding windows and rolling windows emit as soon + as eligible source data exists. For sawtooth + windows, start_time must not be later than the + time the Feature is created. Not supported for + rolling windows on Features with a stream + source. + tumbling: type: object properties: - input: + window_duration: + type: string + delay: type: string description: >- - The input column from which the population - variance is computed. - required: - - input - description: Computes the population variance. - var_samp: - type: object - properties: - input: + Non-negative analytic lag that evaluates the + window this far in the past. Use this for + timing variations unrelated to source + lateness, such as a 30-day count as of one + week ago. If unset, the analytic lag is + zero. It composes with source.lateness when + both are set. + offset: type: string description: >- - The input column from which the sample - variance is computed. + Non-negative phase shift from the default + midnight UTC alignment. For example, + offset=22h on a 24h window produces + boundaries at 22:00 UTC (17:00 New York in + standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter + than window_duration. required: - - input - description: Computes the sample variance. - description: An aggregation function applied over a time window. - column_selection: + - window_duration + description: >- + The time window over which the aggregation is + computed. + var_pop: type: object properties: - column: + input: type: string description: >- - Column name from source to select as the feature - value. + The input column from which the population + variance is computed. required: - - column - description: >- - Selects the latest value of a single column in a - data source - custom_udf: + - input + description: Computes the population variance. + var_samp: type: object properties: - function_path: + input: type: string description: >- - Fully qualified 3-part Unity Catalog path of the - function to apply. - input_bindings: - type: array - items: - type: object - properties: - parameter: - type: string - description: Name of the UC function parameter. - column: - type: string - description: >- - Source column whose value is passed for - this parameter at execution time. - required: - - parameter - - column - description: >- - Binds a single UC function parameter to a - source column. - description: >- - Binds each UC function parameter to a source - column. May be empty for zero-argument functions - (e.g. a timestamp generator). + The input column from which the sample variance + is computed. required: - - function_path + - input + description: Computes the sample variance. + description: An aggregation function applied over a time window. + column_selection: + type: object + properties: + column: + type: string description: >- - Applies a registered Unity Catalog function row-wise - to source columns. - extra_parameters: + Column name from source to select as the feature + value. + required: + - column + description: >- + Selects the latest value of a single column in a data + source + custom_udf: + type: object + properties: + function_path: + type: string + description: >- + Fully qualified 3-part Unity Catalog path of the + function to apply. + input_bindings: type: array items: type: object properties: - key: + parameter: type: string - description: The name of the parameter. - value: + description: Name of the UC function parameter. + column: type: string - description: The value of the parameter. + description: >- + Source column whose value is passed for this + parameter at execution time. required: - - key - - value + - parameter + - column description: >- - Deprecated: Use typed fields on function-specific - messages (e.g. - ApproxPercentileFunction.percentile) or AggregationFunction.ExtraParameter instead. Kept for - backwards compatibility. - description: >- - Deprecated: Use the function oneof with - AggregationFunction instead. Kept for backwards - compatibility. Extra parameters for parameterized - functions. - function_type: - type: string - x-enum: - - APPROX_COUNT_DISTINCT - - APPROX_PERCENTILE - - AVG - - COUNT - - FIRST - - LAST - - MAX - - MIN - - STDDEV_POP - - STDDEV_SAMP - - SUM - - VAR_POP - - VAR_SAMP - description: >- - Deprecated: Use the function oneof with - AggregationFunction instead. Kept for backwards - compatibility. The type of the function. - description: The function by which the feature is computed. - catalog_name: - type: string - description: Name of parent catalog. - created_at: - type: string - format: date-time - description: Time at which this feature was created. - created_by: - type: string - description: Username of the feature creator. - description: - type: string - description: The description of the feature. - entities: + Binds a single UC function parameter to a source + column. + description: >- + Binds each UC function parameter to a source column. + May be empty for zero-argument functions (e.g. a + timestamp generator). + required: + - function_path + description: >- + Applies a registered Unity Catalog function row-wise to + source columns. + extra_parameters: type: array items: type: object properties: - name: + key: + type: string + value: type: string + description: The value of the parameter. required: - - name - description: >- - The entity columns for the feature, used as aggregation - keys and for query-time lookup. - filter_condition: - type: string - description: >- - Deprecated: Use DeltaTableSource.filter_condition or - KafkaSource.filter_condition instead. Kept for backwards - compatibility. The filter condition applied to the - source data before aggregation. - inputs: - type: array - items: - type: string - description: >- - Deprecated: Use AggregationFunction.inputs instead. Kept - for backwards compatibility. The input columns from - which the feature is computed. - lineage_context: - type: object - properties: - job_context: - type: object - properties: - job_id: - type: integer - job_run_id: - type: integer - description: The job run ID where this API was invoked. - description: Job context information including job ID and run ID. - notebook_id: - type: integer - description: The notebook ID where this API was invoked. - description: >- - Lineage context information for this feature. WARNING: - This field is primarily intended for internal use by - Databricks systems and is automatically populated when - features are created through Databricks notebooks or - jobs. Users should not manually set this field as - incorrect values may lead to inaccurate lineage tracking - or unexpected behavior. This field will be set by - feature-engineering client and should be left unset by - SDK and terraform users. - name: + - key + - value + function_type: type: string + x-enum: + - APPROX_COUNT_DISTINCT + - APPROX_PERCENTILE + - AVG + - COUNT + - FIRST + - FUNCTION_TYPE_UNSPECIFIED + - LAST + - MAX + - MIN + - STDDEV_POP + - STDDEV_SAMP + - SUM + - VAR_POP + - VAR_SAMP description: >- - Name of the feature, extracted from the full three-part - name (catalog.schema.name). - schema_name: - type: string - description: Name of parent schema relative to its parent catalog. - time_window: - type: object - properties: - continuous: - type: object - properties: - window_duration: - type: string - description: >- - The duration of the continuous window (must be - positive). - offset: - type: string - description: >- - The offset of the continuous window (must be - non-positive). - required: - - window_duration + Create a collection of name/value pairs. + + + Example enumeration: + + + >>> class Color(Enum): + + ... RED = 1 + + ... BLUE = 2 + + ... GREEN = 3 + + + Access them by: + + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many + members they have: + + + >>> len(Color) + + 3 + + + >>> list(Color) + + [, , ] + + + Methods can be added to enumerations, and members can + have their own + + attributes -- see the documentation for details. + description: The function by which the feature is computed. + catalog_name: + type: string + description: Name of parent catalog. + created_at: + type: string + format: date-time + description: Time at which this feature was created. + created_by: + type: string + description: Username of the feature creator. + description: + type: string + description: The description of the feature. + entities: + type: array + items: + type: object + properties: + name: + type: string + required: + - name + description: >- + The entity columns for the feature, used as aggregation keys + and for query-time lookup. Optional since entities are not + set for RequestSource features or on-demand calculated + features. + filter_condition: + type: string + inputs: + type: array + items: + type: string + lineage_context: + type: object + properties: + job_context: + type: object + properties: + job_id: + type: integer + job_run_id: + type: integer + description: The job run ID where this API was invoked. + description: Job context information including job ID and run ID. + notebook_id: + type: integer + description: The notebook ID where this API was invoked. + description: >- + Lineage context information for this feature. WARNING: This + field is primarily intended for internal use by Databricks + systems and is automatically populated when features are + created through Databricks notebooks or jobs. Users should + not manually set this field as incorrect values may lead to + inaccurate lineage tracking or unexpected behavior. This + field will be set by feature-engineering client and should + be left unset by SDK and terraform users. + name: + type: string + description: >- + Name of the feature, extracted from the full three-part name + (catalog.schema.name). + schema_name: + type: string + description: Name of parent schema relative to its parent catalog. + time_window: + type: object + properties: + continuous: + type: object + properties: + window_duration: + type: string + offset: + type: string description: >- - Deprecated: use RollingWindow with ``delay`` - instead. - rolling: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the rolling - window (must be non-negative). For example, - delay=1d shifts the window end 1 day before the - evaluation time. - window_duration: - type: string - description: >- - The duration of the rolling window. Must be - positive when set; absent means lifetime - (aggregate over the entity's entire history). - description: >- - A rolling time window with an optional delay. This - is the SQL-spec-aligned replacement for - ContinuousWindow: ``delay`` is the non-negative counterpart of the legacy non-positive - ``ContinuousWindow.offset``. - sawtooth: - type: object - properties: - delay: - type: string - description: >- - The delay applied to the end of the window (must - be non-negative). For example, delay=1d shifts - the window end 1 day before the evaluation time. - window_duration: - type: string - description: >- - The duration of the window. Must be positive and - span more than two days when set, so that both - the batch (N-1 day) and stale-path (N-2 day) - partial aggregates are well defined. The - duration need not be a whole number of days - (e.g. 3 days 15 minutes is allowed). Absent - means lifetime (aggregate over the entity's - entire history). - description: >- - A sawtooth window served via the hybrid batch + - streaming path. - sliding: - type: object - properties: - slide_duration: - type: string - window_duration: - type: string - description: >- - The duration of the sliding window. Must be - positive when set; absent means lifetime - (aggregate over the entity's entire history). - required: - - slide_duration - tumbling: - type: object - properties: - window_duration: - type: string - required: - - window_duration + The offset of the continuous window (must be + non-positive). + required: + - window_duration + rolling: + type: object + properties: + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + window_duration: + type: string + description: >- + The duration of the rolling window. Must be positive + when set; absent means lifetime (aggregate over the + entity's entire history). description: >- - Deprecated: Use - Function.aggregation_function.time_window instead. Kept - for backwards compatibility. The time window in which - the feature is computed. - timeseries_column: + A rolling time window with an optional non-negative + delay. + sawtooth: type: object properties: - name: + delay: + type: string + description: >- + Delay is not currently supported for Sawtooth + windows. + window_duration: + type: string + description: >- + The duration of the window. Must be positive and + span more than two days when set, so that both the + batch (N-1 day) and stale-path (N-2 day) partial + aggregates are well defined. The duration need not + be a whole number of days (e.g. 3 days 15 minutes is + allowed). Absent means lifetime (aggregate over the + entity's entire history). + description: >- + A sawtooth window served via the hybrid batch + + streaming path. + sliding: + type: object + properties: + slide_duration: + type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight + UTC alignment. For example, offset=22h on a 24h + slide produces boundaries at 22:00 UTC (17:00 New + York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than + slide_duration (and therefore window_duration). + window_duration: type: string + description: >- + The duration of the sliding window. Must be positive + when set; absent means lifetime (aggregate over the + entity's entire history). required: - - name + - slide_duration + start_time: + type: string + format: date-time description: >- - Column recording time, used for point-in-time joins, - backfills, and aggregations. + Earliest event-time boundary at which the Feature may + emit an output. This gates outputs, not the historical + inputs read by a window. For example, a 365-day window + with start_time=2026-01-01 begins emitting + partial-window values on that date instead of waiting + for 365 days of data; a lifetime window produces no + output before start_time. If unset, tumbling and + fixed-duration sliding windows first emit at an + offset-aligned boundary after a full window can be + formed. If unset, lifetime sliding windows and rolling + windows emit as soon as eligible source data exists. For + sawtooth windows, start_time must not be later than the + time the Feature is created. Not supported for rolling + windows on Features with a stream source. + tumbling: + type: object + properties: + window_duration: + type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window + this far in the past. Use this for timing variations + unrelated to source lateness, such as a 30-day count + as of one week ago. If unset, the analytic lag is + zero. It composes with source.lateness when both are + set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight + UTC alignment. For example, offset=22h on a 24h + window produces boundaries at 22:00 UTC (17:00 New + York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than + window_duration. + required: + - window_duration + timeseries_column: + type: object + properties: + name: + type: string required: - - full_name - - source - - function - description: Feature to update. + - name + description: >- + Column recording time, used for point-in-time joins, + backfills, and aggregations. Optional since a timeseries + column is not set for RequestSource features or on-demand + calculated features. required: - - feature + - full_name + - source + - function responses: '200': description: Success @@ -6438,191 +8126,257 @@ paths: schema: type: object properties: - kafka_config: + name: + type: string + bootstrap_servers: + type: string + description: >- + A comma-separated list of host/port pairs pointing to Kafka + cluster. + subscription_mode: type: object properties: - name: + assign: + type: string + description: >- + A JSON string that contains the specific + topic-partitions to consume from. For example, for + '{"topicA":[0,1],"topicB":[2,4]}', topicA's 0'th and 1st + partitions will be consumed from. + subscribe: + type: string + description: >- + A comma-separated list of Kafka topics to read from. For + example, 'topicA,topicB,topicC'. + subscribe_pattern: type: string - bootstrap_servers: + description: >- + A regular expression matching topics to subscribe to. + For example, 'topic.*' will subscribe to all topics + starting with 'topic'. + description: Options to configure which Kafka topics to pull data from. + auth_config: + type: object + properties: + mtls_config: + type: object + properties: + keystore_location: + type: string + description: >- + Unity Catalog volume path to the JKS keystore file + containing the client certificate and private key. + e.g. + "/Volumes////client.jks". + The materialization compute must have read + permission on this volume. + keystore_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the JKS keystore + password. + key_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the private key password. + Often the same value as the keystore password + (keytool's default), but provided as a separate + field because Apache Kafka requires it as a distinct + option (kafka.ssl.key.password). + truststore_location: + type: string + description: >- + Unity Catalog volume path to the JKS truststore file + containing the CA certificate(s) trusted to verify + the Kafka broker's server certificate. e.g. + "/Volumes////truststore.jks". + truststore_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the JKS truststore + password. + disable_hostname_verification: + type: boolean + description: >- + Set to true only when the broker certificate's SAN + intentionally does not match the connection endpoint + — for example when reaching the cluster through a + PrivateLink endpoint whose DNS name is not in the + broker certificate. Skipping the hostname check + removes a defense against man-in-the-middle attacks; + do not enable casually. mTLS client authentication + is unaffected by this option. See the Apache Kafka + SSL security guide for background on this check: + https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + required: + - keystore_location + - keystore_password_ref + - key_password_ref + - truststore_location + - truststore_password_ref + description: >- + Mutual-TLS (mTLS) authentication configuration. The + keystore (client certificate + private key) + and truststore (CAs trusted to verify the broker) live as JKS files on Unity Catalog volumes, + with their passwords stored in Databricks secret scopes. This matches the SSL setup pattern + documented at + https://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka. + uc_service_credential_name: type: string description: >- - A comma-separated list of host/port pairs pointing to - Kafka cluster. - subscription_mode: + Name of the Unity Catalog service credential. This value + will be set under the option + databricks.serviceCredential + description: Authentication configuration for connection to topics. + backfill_source: + type: object + properties: + delta_table_name: + type: string + delta_table_source: type: object properties: - assign: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: type: string description: >- - A JSON string that contains the specific - topic-partitions to consume from. For example, for - '{"topicA":[0,1],"topicB":[2,4]}', topicA's 0'th and - 1st partitions will be consumed from. - subscribe: + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals and + projections. + timeseries_column: + type: string + transformation_sql: type: string description: >- - A comma-separated list of Kafka topics to read from. - For example, 'topicA,topicB,topicC'. - subscribe_pattern: + A single SQL SELECT expression applied after + filter_condition. Should contains all the columns + needed (eg. "SELECT *, col_a + col_b AS col_c FROM + x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") + If transformation_sql is not provided, all columns + of the delta table are present in the DataSource + dataframe. + required: + - full_name + description: >- + Deprecated: Use delta_table_name instead. Kept for + backwards compatibility. The Delta table source + containing the historical data to backfill. Only the + delta table name is used for backfill, other fields are + ignored. + description: >- + A user-provided and managed source for backfilling data. + Historical data is used when creating a training set from + streaming features linked to this Kafka config. In the + future, a separate table will be maintained by Databricks + for forward filling data. The schema for this source must + match exactly that of the key and value schemas specified + for this Kafka config. + extra_options: + type: object + description: >- + Catch-all for miscellaneous options. Keys should be source + options or Kafka consumer options (kafka.*) + ingestion_config: + type: object + properties: + ingestion_destination: + type: object + properties: + delta_table_name: type: string description: >- - A regular expression matching topics to subscribe - to. For example, 'topic.*' will subscribe to all - topics starting with 'topic'. + The full three-part name (catalog, schema, name) of + the Delta table to be created for ingestion. + description: >- + Destination for the Databricks-managed Delta table that + holds an offline copy of the streaming data for querying + and training. This table contains both 1) forward-filled + data from the Stream and 2) backfilled data from the + BackfillSource (if provided). This table is created and + managed by Databricks and is deleted when the Stream is + deleted. + backfill_job_id: + type: integer description: >- - Options to configure which Kafka topics to pull data - from. - auth_config: + The ID of the Databricks Job that performs the + historical backfill of the ingestion Delta table. + backfill_source: type: object properties: - mtls_config: + delta_table_name: + type: string + delta_table_source: type: object properties: - keystore_location: + full_name: + type: string + dataframe_schema: type: string description: >- - Unity Catalog volume path to the JKS keystore - file containing the client certificate and - private key. e.g. - "/Volumes////client.jks". - The materialization compute must have read - permission on this volume. - keystore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS keystore - password. - key_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string description: >- - Secret-scope reference for the private key - password. Often the same value as the keystore - password (keytool's default), but provided as a - separate field because Apache Kafka requires it - as a distinct option (kafka.ssl.key.password). - truststore_location: - type: string - description: >- - Unity Catalog volume path to the JKS truststore - file containing the CA certificate(s) trusted to - verify the Kafka broker's server certificate. - e.g. - "/Volumes////truststore.jks". - truststore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS truststore - password. - disable_hostname_verification: - type: boolean - description: >- - Set to true only when the broker certificate's - SAN intentionally does not match the connection - endpoint — for example when reaching the cluster - through a PrivateLink endpoint whose DNS name is - not in the broker certificate. Skipping the - hostname check removes a defense against - man-in-the-middle attacks; do not enable - casually. mTLS client authentication is - unaffected by this option. See the Apache Kafka - SSL security guide for background on this check: - https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification - required: - - keystore_location - - keystore_password_ref - - key_password_ref - - truststore_location - - truststore_password_ref - description: >- - Mutual-TLS (mTLS) authentication configuration. The - keystore (client certificate + private key) - and truststore (CAs trusted to verify the broker) live as JKS files on Unity Catalog volumes, - with their passwords stored in Databricks secret scopes. This matches the SSL setup pattern - documented at - https://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka. - - At materialization time, the generated PySpark code passes the JKS file paths and resolved - passwords through to the Kafka SSL options (kafka.ssl.keystore.location, - kafka.ssl.keystore.password, kafka.ssl.key.password, kafka.ssl.truststore.location, - kafka.ssl.truststore.password). Passwords are resolved on the Spark cluster via - dbutils.secrets.get; this message stores only references, never password values. - uc_service_credential_name: - type: string - description: >- - Name of the Unity Catalog service credential. This - value will be set under the option - databricks.serviceCredential - description: Authentication configuration for connection to topics. - backfill_source: - type: object - properties: - delta_table_name: - type: string - delta_table_source: - type: object - properties: - full_name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON format - (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept for - backwards compatibility. The entity columns of - the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table before - applying transformations. Will be row-wise - evaluated, so should only include conditionals - and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. The - timeseries column of the Delta table. - transformation_sql: + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals + and projections. + timeseries_column: + type: string + transformation_sql: type: string description: >- A single SQL SELECT expression applied after @@ -6642,228 +8396,141 @@ paths: delta table name is used for backfill, other fields are ignored. description: >- - A user-provided and managed source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Kafka config. In - the future, a separate table will be maintained by - Databricks for forward filling data. The schema for this - source must match exactly that of the key and value - schemas specified for this Kafka config. - extra_options: + A user-provided source for backfilling data. Historical + data is used when creating a training set from streaming + features linked to this Stream. The backfill data stored + in this location will be copied into the ingestion table + for offline querying and training. The schema for this + source must match exactly that of the key and payload + schemas specified for this Stream, except that it may + omit any columns listed in excluded_columns. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this stream's managed + ingestion. If not specified, a default budget policy may + be applied. + deduplication_columns: + type: array + items: + type: string + description: >- + Column paths used to identify duplicate rows during + ingestion; only one row per distinct combination of + these values is kept. Use dot notation for nested fields + (e.g. ``value.user_id``). Empty list means every column + is compared. + ingestion_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + forward-fill ingestion. + ingestion_pipeline_id: + type: string + description: >- + The ID of the SDP pipeline that continuously copies new + events from the streaming source into the ingestion + Delta table. + tags: type: object description: >- - Catch-all for miscellaneous options. Keys should be - source options or Kafka consumer options (kafka.*) - ingestion_config: + Custom tags to associate with this stream's managed + ingestion. They are applied to the ingestion pipeline + and its forward-fill and backfill jobs, and forwarded to + the underlying compute as cluster tags, so ingestion + cost can be attributed in the billing system tables. + These tags apply only to the managed ingestion compute; + they are not applied to the Stream entity itself, and + are distinct from any Unity Catalog tags on the Stream. + A maximum of 25 tags is supported; keys and values are + subject to the same limitations as cluster tags. + required: + - ingestion_destination + description: >- + Configuration for ingesting Kafka data into a + Databricks-managed Delta table. + key_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON schema + format (https://json-schema.org/). + proto_schema: type: object properties: - ingestion_destination: - type: object - properties: - delta_table_name: - type: string - description: >- - The full three-part name (catalog, schema, name) - of the Delta table to be created for ingestion. - description: >- - Destination for the Databricks-managed Delta table - that holds an offline copy of the streaming data for - querying and training. This table contains both 1) - forward-filled data from the Stream and 2) - backfilled data from the BackfillSource (if - provided). This table is created and managed by - Databricks and is deleted when the Stream is - deleted. - backfill_job_id: - type: integer - description: >- - The ID of the Databricks Job that performs the - historical backfill of the ingestion Delta table. - backfill_source: - type: object - properties: - delta_table_name: - type: string - delta_table_source: - type: object - properties: - full_name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON - format (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept - for backwards compatibility. The entity - columns of the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table - before applying transformations. Will be - row-wise evaluated, so should only include - conditionals and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. - The timeseries column of the Delta table. - transformation_sql: - type: string - description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b - AS col_c FROM x.y.z WHERE col_a > 0" would - have ``transformation_sql`` "*, col_a + - col_b AS col_c") If transformation_sql is - not provided, all columns of the delta table - are present in the DataSource dataframe. - required: - - full_name - description: >- - Deprecated: Use delta_table_name instead. Kept - for backwards compatibility. The Delta table - source containing the historical data to - backfill. Only the delta table name is used for - backfill, other fields are ignored. - description: >- - A user-provided source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Stream. The - backfill data stored in this location will be copied - into the ingestion table for offline querying and - training. The schema for this source must match - exactly that of the key and payload schemas - specified for this Stream. - deduplication_columns: - type: array - items: - type: string - description: >- - Column paths used to identify duplicate rows during - ingestion; only one row per distinct combination of - these values is kept. Use dot notation for nested - fields (e.g. ``value.user_id``). Empty list means - every column is compared. - ingestion_job_id: - type: integer + schema_text: + type: string description: >- - The ID of the Databricks Job that performs the - forward-fill ingestion. - ingestion_pipeline_id: + The raw .proto file text (proto2 and proto3 syntax + supported, see + https://protobuf.dev/programming-guides/proto3/ and + https://protobuf.dev/programming-guides/proto2/). + message_name: type: string description: >- - The ID of the SDP pipeline that continuously copies - new events from the streaming source into the - ingestion Delta table. + The fully-qualified name of the message within + schema_text that describes the Kafka payload (e.g. + "Event" or "com.example.Event" if schema_text + declares a package). Identifies which message is + used to decode each Kafka record — a .proto file may + declare multiple messages but only one represents + the payload. Must not be empty. required: - - ingestion_destination + - schema_text + - message_name + description: Protocol Buffer schema with its payload message name. + description: >- + Schema configuration for extracting message keys from + topics. At least one of key_schema and value_schema must be + provided. + value_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string description: >- - Configuration for ingesting Kafka data into a - Databricks-managed Delta table. - key_schema: + Schema of the JSON object in standard IETF JSON schema + format (https://json-schema.org/). + proto_schema: type: object properties: - avro_schema: + schema_text: type: string - json_schema: - type: string - description: >- - Schema of the JSON object in standard IETF JSON - schema format (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and proto3 - syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message within - schema_text that describes the Kafka payload - (e.g. "Event" or "com.example.Event" if - schema_text declares a package). Identifies - which message is used to decode each Kafka - record — a .proto file may declare multiple - messages but only one represents the payload. - Must not be empty. - required: - - schema_text - - message_name description: >- - Protocol Buffer schema with its payload message - name. - description: >- - Schema configuration for extracting message keys from - topics. At least one of key_schema and value_schema must - be provided. - value_schema: - type: object - properties: - avro_schema: + The raw .proto file text (proto2 and proto3 syntax + supported, see + https://protobuf.dev/programming-guides/proto3/ and + https://protobuf.dev/programming-guides/proto2/). + message_name: type: string - json_schema: - type: string - description: >- - Schema of the JSON object in standard IETF JSON - schema format (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and proto3 - syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message within - schema_text that describes the Kafka payload - (e.g. "Event" or "com.example.Event" if - schema_text declares a package). Identifies - which message is used to decode each Kafka - record — a .proto file may declare multiple - messages but only one represents the payload. - Must not be empty. - required: - - schema_text - - message_name description: >- - Protocol Buffer schema with its payload message - name. - description: >- - Schema configuration for extracting message values from - topics. At least one of key_schema and value_schema must - be provided. - required: - - name - - bootstrap_servers - - subscription_mode - - auth_config - description: The Kafka config to update. + The fully-qualified name of the message within + schema_text that describes the Kafka payload (e.g. + "Event" or "com.example.Event" if schema_text + declares a package). Identifies which message is + used to decode each Kafka record — a .proto file may + declare multiple messages but only one represents + the payload. Must not be empty. + required: + - schema_text + - message_name + description: Protocol Buffer schema with its payload message name. + description: >- + Schema configuration for extracting message values from + topics. At least one of key_schema and value_schema must be + provided. required: - - kafka_config + - name + - bootstrap_servers + - subscription_mode + - auth_config responses: '200': description: Success @@ -6883,28 +8550,67 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI - /api/2.0/feature-engineering/materialized-features/{materialized_feature_id}: + /api/2.0/feature-engineering/materialization-sets/{materialization_set_id}: delete: - operationId: feature_engineering_delete_materialized_feature - summary: Delete a materialized feature. + operationId: feature_engineering_delete_materialization_set + summary: >- + Delete a materialization set and every materialized feature in it. The + set is gone afterwards, so a tags: - ml - feature_engineering - description: |- - Delete a materialized feature. + description: >- + Delete a materialization set and every materialized feature in it. The + set is gone afterwards, so a - :param materialized_feature_id: str - The ID of the materialized feature to delete. + later read returns NOT_FOUND and the set id is free to use again. + + + :param materialization_set_id: str + The ID of the materialization set to delete. + :param allow_missing: bool (optional) + Return success instead of NOT_FOUND when the set does not exist, so a repeated destroy is + idempotent. + :param request_id: str (optional) + Idempotency token for the request. A second request carrying a token that has already been used + returns the operation the first one created, whatever state it reached, and deletes nothing further. + The token is not checked against the rest of the request. Omit it and each request deletes + independently. + + :returns: :class:`Operation` parameters: - - name: materialized_feature_id + - name: materialization_set_id in: path required: true schema: type: string - description: The ID of the materialized feature to delete. + description: The ID of the materialization set to delete. + - name: allow_missing + in: query + required: false + schema: + type: boolean + description: >- + Return success instead of NOT_FOUND when the set does not exist, so + a repeated destroy is idempotent. + - name: request_id + in: query + required: false + schema: + type: string + description: >- + Idempotency token for the request. A second request carrying a token + that has already been used returns the operation the first one + created, whatever state it reached, and deletes nothing further. The + token is not checked against the rest of the request. Omit it and + each request deletes independently. responses: '200': description: Success + content: + application/json: + schema: + type: object default: description: Error response content: @@ -6918,32 +8624,38 @@ paths: type: string x-stackql-sdk-source: FeatureEngineeringAPI get: - operationId: feature_engineering_get_materialized_feature - summary: Get a materialized feature. + operationId: feature_engineering_get_materialization_set + summary: >- + Get a materialization set and the materialized features in it. A set + whose materialized feature tags: - ml - feature_engineering - description: |- - Get a materialized feature. + description: >- + Get a materialization set and the materialized features in it. A set + whose materialized feature - :param materialized_feature_id: str - The ID of the materialized feature. + members have all been deleted is returned with an empty member list. - :returns: :class:`MaterializedFeature` + + :param materialization_set_id: str + The ID of the materialization set. + + :returns: :class:`MaterializationSet` parameters: - - name: materialized_feature_id + - name: materialization_set_id in: path required: true schema: type: string - description: The ID of the materialized feature. + description: The ID of the materialization set. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/MaterializedFeature' + $ref: '#/components/schemas/MaterializationSet' default: description: Error response content: @@ -6957,198 +8669,393 @@ paths: type: string x-stackql-sdk-source: FeatureEngineeringAPI patch: - operationId: feature_engineering_update_materialized_feature - summary: Update a materialized feature (pause/resume). + operationId: feature_engineering_update_materialization_set + summary: >- + Update the materialization set's state to match the supplied + materialization set. Changes are applied tags: - ml - feature_engineering - description: |- - Update a materialized feature (pause/resume). + description: >- + Update the materialization set's state to match the supplied + materialization set. Changes are applied - :param materialized_feature_id: str - Server-assigned unique identifier for the materialized feature. - :param materialized_feature: :class:`MaterializedFeature` - The materialized feature to update. - :param update_mask: str - Provide the materialization feature fields which should be updated. Currently, only the - pipeline_state field can be updated. + member by member and are not atomic: when one member fails, the error + reports which members were - :returns: :class:`MaterializedFeature` + already changed. + + + :param materialization_set_id: str + Server-assigned unique identifier for the materialization set. + :param materialization_set: :class:`MaterializationSet` + The desired state of the updated materialization set. materialization_set_id selects the set. + :param update_mask: FieldMask + The fields to update. Only 'materialized_features' or '*' is supported. + :param request_id: str (optional) + Idempotency token for the request. A second request carrying a token that has already been used + returns the operation the first one created, whatever state it reached, and changes nothing further. + The token is not checked against the rest of the request. Omit it and each request updates + independently. + + :returns: :class:`Operation` parameters: - - name: materialized_feature_id + - name: materialization_set_id in: path required: true schema: type: string - description: Server-assigned unique identifier for the materialized feature. + description: Server-assigned unique identifier for the materialization set. - name: update_mask in: query required: true + schema: + type: object + description: >- + The fields to update. Only 'materialized_features' or '*' is + supported. + - name: request_id + in: query + required: false schema: type: string description: >- - Provide the materialization feature fields which should be updated. - Currently, only the pipeline_state field can be updated. + Idempotency token for the request. A second request carrying a token + that has already been used returns the operation the first one + created, whatever state it reached, and changes nothing further. The + token is not checked against the rest of the request. Omit it and + each request updates independently. requestBody: content: application/json: schema: type: object properties: - materialized_feature: - type: object - properties: - feature_name: - type: string - description: The full name of the feature in Unity Catalog. - cron_schedule: - type: string - description: >- - The quartz cron expression that defines the schedule of - the materialization pipeline. The schedule is evaluated - in the UTC timezone. Hidden from GraphQL: superseded by - the ``trigger`` oneof (cron_schedule_trigger), so not - exposed to Catalog Explorer. - cron_schedule_trigger: - type: object - properties: - cron_expression: - type: string - description: >- - The cron expression defining the schedule (e.g., "0 - 0 * * *" for daily at midnight). - description: >- - A cron-based schedule trigger for the materialization - pipeline. - is_online: - type: boolean - description: >- - True if this is an online materialized feature. False if - it is an offline materialized feature. - last_materialization_time: - type: string - description: >- - The timestamp when the pipeline last ran and updated the - materialized feature values. If the pipeline has not run - yet, this field will be null. - materialized_feature_id: - type: string - description: >- - Server-assigned unique identifier for the materialized - feature. - offline_store_config: - type: object - properties: - catalog_name: - type: string - description: The Unity Catalog catalog name. - schema_name: - type: string - description: The Unity Catalog schema name. - table_name_prefix: - type: string - description: >- - Prefix for Unity Catalog table name. The - materialized feature will be stored in a table with - this prefix and a generated postfix. - required: - - catalog_name - - schema_name - - table_name_prefix - description: >- - Destination for writing feature values to an offline - Delta table. - online_store_config: - type: object - properties: - catalog_name: - type: string - description: >- - The Unity Catalog catalog name. This name is also - used as the Lakebase logical database name. Quoting - is handled by the backend where needed, do not - pre-quote it. - schema_name: - type: string - description: >- - The Unity Catalog schema name. This name is also - used as the Lakebase schema name under the database. - Quoting is handled by the backend where needed, do - not pre-quote it. - table_name_prefix: - type: string - description: >- - Prefix for Unity Catalog table name. The - materialized feature will be stored in a Lakebase - table with this prefix and a generated postfix. - online_store_name: - type: string - description: The name of the target online store. - required: - - catalog_name - - schema_name - - table_name_prefix - - online_store_name - description: >- - Destination for writing feature values to an online - Lakebase table. - pipeline_schedule_state: - type: string - x-enum: - - ACTIVE - - PAUSED - - SNAPSHOT - description: >- - The schedule state of the materialization pipeline. - Hidden from GraphQL: being deprecated, so not exposed to - Catalog Explorer. - streaming_mode: - type: object - properties: - freshness_target: - type: string - description: >- - The desired data freshness for feature - materialization, expressed as a duration string - (e.g. "1 minute"). - mode: - type: string - x-enum: - - STREAMING_MODE_TYPE_MBM - - STREAMING_MODE_TYPE_RTM - description: >- - The type of streaming mode used by the - materialization pipeline. - description: >- - The Structured Streaming trigger mode used for - materialization. Real-time mode (RTM) targets sub-second - latency for operational workloads; micro-batch mode - (MBM) favors cost efficiency for ETL and analytics - workloads. - table_name: - type: string - description: >- - The fully qualified Unity Catalog path to the table - containing the materialized feature (Delta table or - Lakebase table). Output only. - table_trigger: - type: object - properties: {} - description: >- - A trigger that fires when the upstream source table - changes. - required: - - feature_name - description: The materialized feature to update. - required: - - materialized_feature + materialization_set_id: + type: string + description: >- + Server-assigned unique identifier for the materialization + set. + materialized_features: + type: array + items: + type: object + properties: + feature_name: + type: string + description: The full name of the feature in Unity Catalog. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this materialization. If + not specified, a default budget policy may be applied. + cron_schedule: + type: string + cron_schedule_trigger: + type: object + properties: + cron_expression: + type: string + description: >- + The cron expression defining the schedule (e.g., + "0 0 * * *" for daily at midnight). The schedule + is interpreted in timezone_id (defaults to UTC). + Required when mode is MANUAL (or unset). Left + empty when mode is DERIVED, where the service + computes it (aligned to UTC) from the features' + window timing and fills it in on the response. + mode: + type: string + x-enum: + - DERIVED + - MANUAL + description: >- + How the schedule is determined. Defaults to MANUAL + when unset. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with + respect to this timezone. Defaults to UTC when + omitted. Can only be configured for MANUAL + schedules; DERIVED schedules are always aligned to + UTC. + description: >- + A cron-based schedule trigger for the materialization + pipeline. + is_online: + type: boolean + description: >- + True if this is an online materialized feature. False + if it is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. This + is present for both batch and streaming features. + last_materialization_time: + type: string + description: >- + The timestamp when the pipeline last ran and updated + the materialized feature values. If the pipeline has + not run yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this + materialized feature. Format: + operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature was + created for, through DABs or direct-engine creation. + Unset for a materialized feature that was not created + as part of a set. + materialized_feature_id: + type: string + description: >- + Server-assigned unique identifier for the materialized + feature. + notifications: + type: object + properties: + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, or + a generic webhook) to notify. Not supported + for streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final attempt of + a run fails. If false or unset, notify on + every failed attempt, including attempts that + will be retried. Batch materialization does + not retry failures that need a fix on your + side, such as missing permissions or invalid + configuration, so the first attempt is the + final one. Other batch failures are retried up + to twice. Streaming materialization restarts a + failed update indefinitely unless the error + cannot be retried. With this set, a streaming + materialized feature notifies only on errors + that cannot be retried, and never on failures + that are restarted. + description: >- + Who to notify when a run fails, and on which + attempts. + on_success: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for + example Slack, Microsoft Teams, PagerDuty, or + a generic webhook) to notify. Not supported + for streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Who to notify when a run succeeds. + description: >- + Notification configuration around the materialization + job or pipeline lifecycle. They are applied to every + job and pipeline that materializes this feature. + Features which are materialized in the same pipeline + will share the same notification. + offline_store_config: + type: object + properties: + catalog_name: + type: string + description: The Unity Catalog catalog name. + schema_name: + type: string + description: The Unity Catalog schema name. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The + materialized feature will be stored in a table + with this prefix and a generated postfix. + required: + - catalog_name + - schema_name + - table_name_prefix + description: >- + Destination for writing feature values to an offline + Delta table. The resulting table is returned as + ``table_name``. + online_store_config: + type: object + properties: + catalog_name: + type: string + description: >- + The Unity Catalog catalog name. This name is also + used as the Lakebase logical database name. + Quoting is handled by the backend where needed, do + not pre-quote it. + schema_name: + type: string + description: >- + The Unity Catalog schema name. This name is also + used as the Lakebase schema name under the + database. Quoting is handled by the backend where + needed, do not pre-quote it. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The + materialized feature will be stored in a Lakebase + table with this prefix and a generated postfix. + online_store_name: + type: string + description: The name of the target online store. + required: + - catalog_name + - schema_name + - table_name_prefix + - online_store_name + description: >- + Destination for writing feature values to an online + Lakebase table. The resulting table is returned as + ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this feature. + This is only present for streaming features. + pipeline_schedule_state: + type: string + x-enum: + - ACTIVE + - PAUSED + - SNAPSHOT + description: >- + The schedule state of the materialization pipeline. + Hidden from GraphQL: being deprecated, so not exposed + to Catalog Explorer. + streaming_mode: + type: object + properties: + freshness_target: + type: string + description: >- + The desired data freshness for feature + materialization, expressed as a duration string + (e.g. "1 minute"). + mode: + type: string + x-enum: + - STREAMING_MODE_TYPE_MBM + - STREAMING_MODE_TYPE_RTM + description: >- + The type of streaming mode used by the + materialization pipeline. + shuffle_partitions: + type: integer + description: >- + Number of shuffle partitions for streaming + materialization of this feature. Higher values + process high-throughput features with more + parallelism at higher compute cost. Materialized + features which are computed together will use the + largest value set among them. + description: >- + The Structured Streaming trigger mode used for + materialization. Real-time mode (RTM) targets + sub-second latency for operational workloads; + micro-batch mode (MBM) favors cost efficiency for ETL + and analytics workloads. + table_name: + type: string + description: >- + The fully qualified Unity Catalog path to the table + containing the materialized feature (Delta table or + Lakebase table). Output only. + table_trigger: + type: object + properties: + condition: + type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED + description: >- + Which source table updates trigger a + materialization run. If not set, any source table + update triggers a run. + min_time_between_triggers: + type: string + description: >- + The minimum time between two triggered runs, so a + frequently updated source table does not trigger + runs too often. If not set, a feature with a + sliding window uses half its slide_duration and a + feature with a tumbling window uses half its + window_duration, clamped to between 5 minutes and + 1 hour. Other features have no minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without updates + before a run starts, so a series of updates + settles before the run. If not set, a run starts + as soon as the source table updates. + description: >- + A trigger that fires when the upstream source table + changes. + tags: + type: object + description: >- + Custom tags to associate with this materialization. + They are applied to the materialization job (for batch + features) or pipeline (for streaming features) and + forwarded to the underlying compute as cluster tags, + so materialization cost can be attributed in the + billing system tables. These tags apply only to the + materialization compute; they are not applied to the + Unity Catalog Feature resource itself, whose tags are + managed separately through the Unity Catalog tagging + API. A maximum of 25 tags is supported; keys and + values are subject to the same limitations as cluster + tags. + required: + - feature_name + description: >- + A materialized feature represents a feature that is + continuously computed and stored. + description: >- + The materialized features in this set. Order is not + significant. Updating the set with a materialized feature + removed from this set will cause it to be deleted. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/MaterializedFeature' + type: object default: description: Error response content: @@ -7161,30 +9068,1100 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI - /api/2.0/feature-engineering/streams/{name}: + /api/2.0/feature-engineering/materialized-features/{materialized_feature_id}: delete: - operationId: feature_engineering_delete_stream - summary: Delete a Stream by its full three-part name (catalog.schema.stream). + operationId: feature_engineering_delete_materialized_feature + summary: Delete a materialized feature. tags: - ml - feature_engineering description: |- - Delete a Stream by its full three-part name (catalog.schema.stream). + Delete a materialized feature. - :param name: str - Full three-part name (catalog.schema.stream) of the Stream to delete. + :param materialized_feature_id: str + The ID of the materialized feature to delete. parameters: - - name: name + - name: materialized_feature_id + in: path + required: true + schema: + type: string + description: The ID of the materialized feature to delete. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + get: + operationId: feature_engineering_get_materialized_feature + summary: Get a materialized feature. + tags: + - ml + - feature_engineering + description: |- + Get a materialized feature. + + :param materialized_feature_id: str + The ID of the materialized feature. + + :returns: :class:`MaterializedFeature` + parameters: + - name: materialized_feature_id + in: path + required: true + schema: + type: string + description: The ID of the materialized feature. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MaterializedFeature' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + patch: + operationId: feature_engineering_update_materialized_feature + summary: Update a materialized feature (pause/resume). + tags: + - ml + - feature_engineering + description: |- + Update a materialized feature (pause/resume). + + :param materialized_feature_id: str + Server-assigned unique identifier for the materialized feature. + :param materialized_feature: :class:`MaterializedFeature` + The materialized feature to update. + :param update_mask: str + Provide the materialization feature fields which should be updated. Currently, only the + pipeline_state field can be updated. + + :returns: :class:`MaterializedFeature` + parameters: + - name: materialized_feature_id in: path required: true + schema: + type: string + description: Server-assigned unique identifier for the materialized feature. + - name: update_mask + in: query + required: true schema: type: string description: >- - Full three-part name (catalog.schema.stream) of the Stream to - delete. + Provide the materialization feature fields which should be updated. + Currently, only the pipeline_state field can be updated. + requestBody: + content: + application/json: + schema: + type: object + properties: + feature_name: + type: string + description: The full name of the feature in Unity Catalog. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the serverless + compute cost of this materialization. If not specified, a + default budget policy may be applied. + cron_schedule: + type: string + cron_schedule_trigger: + type: object + properties: + cron_expression: + type: string + description: >- + The cron expression defining the schedule (e.g., "0 0 * + * *" for daily at midnight). The schedule is interpreted + in timezone_id (defaults to UTC). Required when mode is + MANUAL (or unset). Left empty when mode is DERIVED, + where the service computes it (aligned to UTC) from the + features' window timing and fills it in on the response. + mode: + type: string + x-enum: + - DERIVED + - MANUAL + description: >- + How the schedule is determined. Defaults to MANUAL when + unset. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with + respect to this timezone. Defaults to UTC when omitted. + Can only be configured for MANUAL schedules; DERIVED + schedules are always aligned to UTC. + description: >- + A cron-based schedule trigger for the materialization + pipeline. + is_online: + type: boolean + description: >- + True if this is an online materialized feature. False if it + is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. This is + present for both batch and streaming features. + last_materialization_time: + type: string + description: >- + The timestamp when the pipeline last ran and updated the + materialized feature values. If the pipeline has not run + yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this materialized + feature. Format: operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature was + created for, through DABs or direct-engine creation. Unset + for a materialized feature that was not created as part of a + set. + materialized_feature_id: + type: string + description: >- + Server-assigned unique identifier for the materialized + feature. + notifications: + type: object + properties: + on_failure: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for example + Slack, Microsoft Teams, PagerDuty, or a generic + webhook) to notify. Not supported for streaming + materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final attempt of a run + fails. If false or unset, notify on every failed + attempt, including attempts that will be retried. + Batch materialization does not retry failures that + need a fix on your side, such as missing permissions + or invalid configuration, so the first attempt is + the final one. Other batch failures are retried up + to twice. Streaming materialization restarts a + failed update indefinitely unless the error cannot + be retried. With this set, a streaming materialized + feature notifies only on errors that cannot be + retried, and never on failures that are restarted. + description: Who to notify when a run fails, and on which attempts. + on_success: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for example + Slack, Microsoft Teams, PagerDuty, or a generic + webhook) to notify. Not supported for streaming + materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Who to notify when a run succeeds. + description: >- + Notification configuration around the materialization job or + pipeline lifecycle. They are applied to every job and + pipeline that materializes this feature. Features which are + materialized in the same pipeline will share the same + notification. + offline_store_config: + type: object + properties: + catalog_name: + type: string + description: The Unity Catalog catalog name. + schema_name: + type: string + description: The Unity Catalog schema name. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The materialized + feature will be stored in a table with this prefix and a + generated postfix. + required: + - catalog_name + - schema_name + - table_name_prefix + description: >- + Destination for writing feature values to an offline Delta + table. The resulting table is returned as ``table_name``. + online_store_config: + type: object + properties: + catalog_name: + type: string + description: >- + The Unity Catalog catalog name. This name is also used + as the Lakebase logical database name. Quoting is + handled by the backend where needed, do not pre-quote + it. + schema_name: + type: string + description: >- + The Unity Catalog schema name. This name is also used as + the Lakebase schema name under the database. Quoting is + handled by the backend where needed, do not pre-quote + it. + table_name_prefix: + type: string + description: >- + Prefix for Unity Catalog table name. The materialized + feature will be stored in a Lakebase table with this + prefix and a generated postfix. + online_store_name: + type: string + description: The name of the target online store. + required: + - catalog_name + - schema_name + - table_name_prefix + - online_store_name + description: >- + Destination for writing feature values to an online Lakebase + table. The resulting table is returned as ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this feature. This + is only present for streaming features. + pipeline_schedule_state: + type: string + x-enum: + - ACTIVE + - PAUSED + - SNAPSHOT + description: >- + The schedule state of the materialization pipeline. Hidden + from GraphQL: being deprecated, so not exposed to Catalog + Explorer. + streaming_mode: + type: object + properties: + freshness_target: + type: string + description: >- + The desired data freshness for feature materialization, + expressed as a duration string (e.g. "1 minute"). + mode: + type: string + x-enum: + - STREAMING_MODE_TYPE_MBM + - STREAMING_MODE_TYPE_RTM + description: >- + The type of streaming mode used by the materialization + pipeline. + shuffle_partitions: + type: integer + description: >- + Number of shuffle partitions for streaming + materialization of this feature. Higher values process + high-throughput features with more parallelism at higher + compute cost. Materialized features which are computed + together will use the largest value set among them. + description: >- + The Structured Streaming trigger mode used for + materialization. Real-time mode (RTM) targets sub-second + latency for operational workloads; micro-batch mode (MBM) + favors cost efficiency for ETL and analytics workloads. + table_name: + type: string + description: >- + The fully qualified Unity Catalog path to the table + containing the materialized feature (Delta table or Lakebase + table). Output only. + table_trigger: + type: object + properties: + condition: + type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED + description: >- + Which source table updates trigger a materialization + run. If not set, any source table update triggers a run. + min_time_between_triggers: + type: string + description: >- + The minimum time between two triggered runs, so a + frequently updated source table does not trigger runs + too often. If not set, a feature with a sliding window + uses half its slide_duration and a feature with a + tumbling window uses half its window_duration, clamped + to between 5 minutes and 1 hour. Other features have no + minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without updates before + a run starts, so a series of updates settles before the + run. If not set, a run starts as soon as the source + table updates. + description: A trigger that fires when the upstream source table changes. + tags: + type: object + description: >- + Custom tags to associate with this materialization. They are + applied to the materialization job (for batch features) or + pipeline (for streaming features) and forwarded to the + underlying compute as cluster tags, so materialization cost + can be attributed in the billing system tables. These tags + apply only to the materialization compute; they are not + applied to the Unity Catalog Feature resource itself, whose + tags are managed separately through the Unity Catalog + tagging API. A maximum of 25 tags is supported; keys and + values are subject to the same limitations as cluster tags. + required: + - feature_name + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MaterializedFeature' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + /api/2.0/feature-engineering/streams/{name}: + delete: + operationId: feature_engineering_delete_stream + summary: Delete a Stream by its full three-part name (catalog.schema.stream). + tags: + - ml + - feature_engineering + description: |- + Delete a Stream by its full three-part name (catalog.schema.stream). + + :param name: str + Full three-part name (catalog.schema.stream) of the Stream to delete. + parameters: + - name: name + in: path + required: true + schema: + type: string + description: >- + Full three-part name (catalog.schema.stream) of the Stream to + delete. + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + get: + operationId: feature_engineering_get_stream + summary: Get a Stream by its full three-part name (catalog.schema.stream). + tags: + - ml + - feature_engineering + description: |- + Get a Stream by its full three-part name (catalog.schema.stream). + + :param name: str + Full three-part name (catalog.schema.stream) of the Stream to get. + + :returns: :class:`Stream` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: Full three-part name (catalog.schema.stream) of the Stream to get. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: FeatureEngineeringAPI + patch: + operationId: feature_engineering_update_stream + summary: Update a Stream. Only fields listed in ``update_mask`` are mutated. + tags: + - ml + - feature_engineering + description: |- + Update a Stream. Only fields listed in ``update_mask`` are mutated. + + :param name: str + Full three-part (catalog.schema.stream) name of the stream. + :param stream: :class:`Stream` + The Stream to update. + :param update_mask: FieldMask + The list of fields to update. + + :returns: :class:`Stream` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: Full three-part (catalog.schema.stream) name of the stream. + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Full three-part (catalog.schema.stream) name of the stream. + source_config: + type: object + properties: + kafka_stream_config: + type: object + properties: + subscription_mode: + type: object + properties: + assign: + type: string + description: >- + A JSON string that contains the specific + topic-partitions to consume from. For example, + for '{"topicA":[0,1],"topicB":[2,4]}', topicA's + 0'th and 1st partitions will be consumed from. + subscribe: + type: string + description: >- + A comma-separated list of Kafka topics to read + from. For example, 'topicA,topicB,topicC'. + subscribe_pattern: + type: string + description: >- + A regular expression matching topics to + subscribe to. For example, 'topic.*' will + subscribe to all topics starting with 'topic'. + description: >- + Options to configure which Kafka topics to pull data + from. + extra_options: + type: object + description: >- + Optional Kafka source or consumer options, validated + against a server-side allowlist at request time. + Allowed keys: - ``maxOffsetsPerTrigger`` - + ``startingOffsets`` - ``includeHeaders`` - + ``kafka.request.timeout.ms`` - + ``kafka.session.timeout.ms`` - + ``kafka.max.partition.fetch.bytes`` The following + keys are ingestion-only and are stripped before + being forwarded to the materialization pipeline: - + ``maxOffsetsPerTrigger`` - ``startingOffsets`` Auth + and connection details belong on the parent Stream's + ``connection_config``, not here. + required: + - subscription_mode + description: Configuration for Apache Kafka streams. + kinesis_stream_config: + type: object + properties: + extra_options: + type: object + description: >- + Optional Kinesis source options, validated against a + server-side allowlist at request time. Allowed keys: + - ``consumerMode`` - ``consumerNamePrefix`` - + ``maxFetchRate`` - ``minFetchPeriod`` - + ``maxFetchDuration`` - ``maxRecordsPerFetch`` - + ``shardsPerTask`` - ``fetchBufferSize`` - + ``shardFetchInterval`` ``consumerMode`` must be + ``efo`` or ``polling`` (case-insensitive). + ``maxRecordsPerFetch`` applies only during ingestion + and does not affect the materialization pipeline. + Auth and connection details belong on the parent + Stream's ``connection_config``, not here. + stream_arns: + type: object + properties: + arns: + type: array + items: + type: string + description: >- + Kinesis stream ARNs to read from. For example, + 'arn:aws:kinesis:us-west-2:111122223333:stream/stream-a'. + description: Kinesis stream ARNs to read from. + stream_names: + type: object + properties: + names: + type: array + items: + type: string + description: Kinesis stream names to read from. + description: Kinesis stream names to read from. + description: Configuration for AWS Kinesis Data Streams. + description: >- + Source-specific configuration. Determines the streaming + platform source. + connection_config: + type: object + properties: + direct_mtls_config: + type: object + properties: + bootstrap_servers: + type: string + description: >- + A comma-separated list of host:port pairs for the + Kafka bootstrap servers. + mtls_config: + type: object + properties: + keystore_location: + type: string + description: >- + Unity Catalog volume path to the JKS keystore + file containing the client certificate and + private key. e.g. + "/Volumes////client.jks". + The materialization compute must have read + permission on this volume. + keystore_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the JKS keystore + password. + key_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the private key + password. Often the same value as the keystore + password (keytool's default), but provided as a + separate field because Apache Kafka requires it + as a distinct option (kafka.ssl.key.password). + truststore_location: + type: string + description: >- + Unity Catalog volume path to the JKS truststore + file containing the CA certificate(s) trusted to + verify the Kafka broker's server certificate. + e.g. + "/Volumes////truststore.jks". + truststore_password_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Secret-scope reference for the JKS truststore + password. + disable_hostname_verification: + type: boolean + description: >- + Set to true only when the broker certificate's + SAN intentionally does not match the connection + endpoint — for example when reaching the cluster + through a PrivateLink endpoint whose DNS name is + not in the broker certificate. Skipping the + hostname check removes a defense against + man-in-the-middle attacks; do not enable + casually. mTLS client authentication is + unaffected by this option. See the Apache Kafka + SSL security guide for background on this check: + https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification + required: + - keystore_location + - keystore_password_ref + - key_password_ref + - truststore_location + - truststore_password_ref + description: Mutual-TLS authentication configuration. + required: + - bootstrap_servers + - mtls_config + description: Direct mTLS configuration for stream platform access. + uc_connection_name: + type: string + description: >- + Name of an existing UC Connection for stream platform + access. Must be the correct type for the streaming + platform (e.g. a Kafka Connection for a Kafka Stream, or + a Kinesis Connection for a Kinesis Stream). + description: >- + Specifies how to connect and authenticate to the stream + platform. + schema_config: + type: object + properties: + direct_schemas: + type: object + properties: + key_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON + schema format (https://json-schema.org/). + proto_schema: + type: object + properties: + schema_text: + type: string + description: >- + The raw .proto file text (proto2 and proto3 + syntax supported, see + https://protobuf.dev/programming-guides/proto3/ + and + https://protobuf.dev/programming-guides/proto2/). + message_name: + type: string + description: >- + The fully-qualified name of the message + within schema_text that describes the Kafka + payload (e.g. "Event" or "com.example.Event" + if schema_text declares a package). + Identifies which message is used to decode + each Kafka record — a .proto file may + declare multiple messages but only one + represents the payload. Must not be empty. + required: + - schema_text + - message_name + description: >- + Protocol Buffer schema with its payload message + name. + description: >- + Schema for the message key. This is only used for + Kafka streams. For Kafka, at least one of + payload_schema or key_schema must be specified. + payload_schema: + type: object + properties: + avro_schema: + type: string + json_schema: + type: string + description: >- + Schema of the JSON object in standard IETF JSON + schema format (https://json-schema.org/). + proto_schema: + type: object + properties: + schema_text: + type: string + description: >- + The raw .proto file text (proto2 and proto3 + syntax supported, see + https://protobuf.dev/programming-guides/proto3/ + and + https://protobuf.dev/programming-guides/proto2/). + message_name: + type: string + description: >- + The fully-qualified name of the message + within schema_text that describes the Kafka + payload (e.g. "Event" or "com.example.Event" + if schema_text declares a package). + Identifies which message is used to decode + each Kafka record — a .proto file may + declare multiple messages but only one + represents the payload. Must not be empty. + required: + - schema_text + - message_name + description: >- + Protocol Buffer schema with its payload message + name. + description: >- + Schema for the message payload. For Kafka, this is + the value schema. Unless the platform supports + another schema (e.g. keys for Kafka), this must be + specified. + description: Schema definitions provided directly on the Stream. + schema_registry_config: + type: object + properties: + api_secret_ref: + type: object + properties: + scope: + type: string + description: The Databricks secret scope name. + key: + type: string + description: The key within the scope. + required: + - scope + - key + description: >- + Reference to the schema registry API secret in a + Databricks secret scope. Set this only if required + for authentication for the schema registry. + key_schema_locator: + type: object + properties: + format: + type: string + x-enum: + - FORMAT_AVRO + - FORMAT_JSON + - FORMAT_PROTOBUF + description: Serialization format for this schema. + confluent_schema: + type: object + properties: + subject: + type: string + description: The Confluent schema registry subject name. + required: + - subject + description: Confluent Schema Registry schema locator. + required: + - format + description: >- + Schema locator for the message key. Only used for + Kafka streams. At least one of + payload_schema_locator or key_schema_locator must be + set. + payload_schema_locator: + type: object + properties: + format: + type: string + x-enum: + - FORMAT_AVRO + - FORMAT_JSON + - FORMAT_PROTOBUF + description: Serialization format for this schema. + confluent_schema: + type: object + properties: + subject: + type: string + description: The Confluent schema registry subject name. + required: + - subject + description: Confluent Schema Registry schema locator. + required: + - format + description: >- + Schema locator for the message payload. For Kafka + this is the value. At least one of + payload_schema_locator or key_schema_locator must be + set. + uc_connection: + type: string + description: A Schema Registry UC Connection object. + description: Resolve schemas from an external schema registry. + description: >- + Schema definitions for the stream, provided either directly + on the Stream or resolved from an external schema registry + through a UC Connection. + ingestion_config: + type: object + properties: + ingestion_destination: + type: object + properties: + delta_table_name: + type: string + description: >- + The full three-part name (catalog, schema, name) of + the Delta table to be created for ingestion. + description: >- + Destination for the Databricks-managed Delta table that + holds an offline copy of the streaming data for querying + and training. This table contains both 1) forward-filled + data from the Stream and 2) backfilled data from the + BackfillSource (if provided). This table is created and + managed by Databricks and is deleted when the Stream is + deleted. + backfill_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + historical backfill of the ingestion Delta table. + backfill_source: + type: object + properties: + delta_table_name: + type: string + delta_table_source: + type: object + properties: + full_name: + type: string + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after + transformations, in Spark StructType JSON format + (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + entity_columns: + type: array + items: + type: string + filter_condition: + type: string + description: >- + Single WHERE clause to filter delta table before + applying transformations. Will be row-wise + evaluated, so should only include conditionals + and projections. + timeseries_column: + type: string + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after + filter_condition. Should contains all the + columns needed (eg. "SELECT *, col_a + col_b AS + col_c FROM x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS + col_c") If transformation_sql is not provided, + all columns of the delta table are present in + the DataSource dataframe. + required: + - full_name + description: >- + Deprecated: Use delta_table_name instead. Kept for + backwards compatibility. The Delta table source + containing the historical data to backfill. Only the + delta table name is used for backfill, other fields + are ignored. + description: >- + A user-provided source for backfilling data. Historical + data is used when creating a training set from streaming + features linked to this Stream. The backfill data stored + in this location will be copied into the ingestion table + for offline querying and training. The schema for this + source must match exactly that of the key and payload + schemas specified for this Stream, except that it may + omit any columns listed in excluded_columns. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the + serverless compute cost of this stream's managed + ingestion. If not specified, a default budget policy may + be applied. + deduplication_columns: + type: array + items: + type: string + description: >- + Column paths used to identify duplicate rows during + ingestion; only one row per distinct combination of + these values is kept. Use dot notation for nested fields + (e.g. ``value.user_id``). Empty list means every column + is compared. + ingestion_job_id: + type: integer + description: >- + The ID of the Databricks Job that performs the + forward-fill ingestion. + ingestion_pipeline_id: + type: string + description: >- + The ID of the SDP pipeline that continuously copies new + events from the streaming source into the ingestion + Delta table. + tags: + type: object + description: >- + Custom tags to associate with this stream's managed + ingestion. They are applied to the ingestion pipeline + and its forward-fill and backfill jobs, and forwarded to + the underlying compute as cluster tags, so ingestion + cost can be attributed in the billing system tables. + These tags apply only to the managed ingestion compute; + they are not applied to the Stream entity itself, and + are distinct from any Unity Catalog tags on the Stream. + A maximum of 25 tags is supported; keys and values are + subject to the same limitations as cluster tags. + required: + - ingestion_destination + description: >- + Configuration for streaming data ingestion: the managed + table storing an offline copy of forward fill data and + optional historical backfill. + browse_only: + type: boolean + 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. + create_time: + type: string + format: date-time + description: Time at which this Stream was created. + created_by: + type: string + description: Username of the Stream creator. + description: + type: string + description: User-provided description. + excluded_columns: + type: array + items: + type: string + description: >- + Column paths (dot notation, e.g. "value.email" for Kafka) to + drop. A path may reference a struct, in which case all of + its nested fields are dropped (e.g. "value.address" drops + "value.address.city" and "value.address.zip"). These columns + are not written to the ingestion table and cannot be + referenced by any feature. They are dropped from ingestion, + backfill, and materialization. For direct schemas, each + column must exist in the relevant key or payload schema. + With a schema registry, a column can be excluded before it + exists. A column cannot also be a deduplication column in + the ingestion_config. + record_type_filter: + type: string + description: >- + Optional SQL predicate to filter which record types from a + streaming channel (e.g. a topic for Kafka) belong to this + Stream. Events that do not match are not written to the + ingestion table and are not used in materialization. + Example: "value.event_type = 'transaction'". + update_time: + type: string + format: date-time + description: Time at which this Stream was last modified. + updated_by: + type: string + description: Username of user who last modified the Stream. + required: + - name + - source_config + - connection_config + - schema_config + - ingestion_config responses: '200': description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' default: description: Error response content: @@ -7197,33 +10174,34 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI + /api/2.0/feature-engineering/{name}: get: - operationId: feature_engineering_get_stream - summary: Get a Stream by its full three-part name (catalog.schema.stream). + operationId: feature_engineering_get_operation + summary: Get an operation. tags: - ml - feature_engineering description: |- - Get a Stream by its full three-part name (catalog.schema.stream). + Get an operation. :param name: str - Full three-part name (catalog.schema.stream) of the Stream to get. + The name of the operation resource. - :returns: :class:`Stream` + :returns: :class:`Operation` parameters: - name: name in: path required: true schema: type: string - description: Full three-part name (catalog.schema.stream) of the Stream to get. + description: The name of the operation resource. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Stream' + $ref: '#/components/schemas/Operation' default: description: Error response content: @@ -7236,601 +10214,108 @@ paths: message: type: string x-stackql-sdk-source: FeatureEngineeringAPI - patch: - operationId: feature_engineering_update_stream - summary: Update a Stream. Only fields listed in ``update_mask`` are mutated. + /api/2.0/feature-engineering/features:purgeFeatureEntities: + post: + operationId: feature_engineering_purge_feature_entities + summary: Purge materialized feature values for specified entities. tags: - ml - feature_engineering description: |- - Update a Stream. Only fields listed in ``update_mask`` are mutated. - - :param name: str - Full three-part (catalog.schema.stream) name of the stream. - :param stream: :class:`Stream` - The Stream to update. - :param update_mask: FieldMask - The list of fields to update. - - :returns: :class:`Stream` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Full three-part (catalog.schema.stream) name of the stream. - - name: update_mask - in: query - required: true - schema: - type: object - description: The list of fields to update. + Purge materialized feature values for specified entities. + + :param features: List[str] + Fully qualified names of the features to purge. At least one nonempty feature name is required. A + request may contain at most 500 features; submit additional features in separate requests. Duplicate + features are rejected. + :param entities_table: str + Fully qualified name of the Unity Catalog Delta table containing the entity keys to purge. The table + may contain a subset of each feature's entity-key columns. A partial key match deletes all feature + rows matching the provided key values. Non-key columns are rejected; null key values are allowed. + :param budget_policy_id: str (optional) + The budget policy ID, in UUID format, used to attribute the serverless compute cost of this purge. + If not specified, a default budget policy may be applied. + :param delete_rows: bool (optional) + If false feature values are set to null on purge but rows are not deleted. If true then the full + rows containing entities are deleted. Defaults to false. When true, the request must include every + feature which shares the same ``table_name`` property in their MaterializedFeature. Features from + multiple tables may be included if all features materialized in each table are included. + :param request_id: str (optional) + Optional UUID4 idempotency token for the request. + :param tags: Dict[str,str] (optional) + Custom tags to associate with this purge. They are applied to the purge job and forwarded to the + underlying compute as Databricks resource tags, so purge cost can be attributed in the billing + system tables. These tags apply only to the purge compute; they are not applied to the Unity Catalog + Feature resources themselves, whose tags are managed separately through the Unity Catalog tagging + API. A maximum of 25 tags is supported; keys and values are subject to the same limitations as + Databricks resource tags. + + :returns: :class:`Operation` requestBody: content: application/json: schema: type: object properties: - stream: + features: + type: array + items: + type: string + description: >- + Fully qualified names of the features to purge. At least one + nonempty feature name is required. A request may contain at + most 500 features; submit additional features in separate + requests. Duplicate features are rejected. + entities_table: + type: string + description: >- + Fully qualified name of the Unity Catalog Delta table + containing the entity keys to purge. The table may contain a + subset of each feature's entity-key columns. A partial key + match deletes all feature rows matching the provided key + values. Non-key columns are rejected; null key values are + allowed. + budget_policy_id: + type: string + description: >- + The budget policy ID, in UUID format, used to attribute the + serverless compute cost of this purge. If not specified, a + default budget policy may be applied. + delete_rows: + type: boolean + description: >- + If false feature values are set to null on purge but rows + are not deleted. If true then the full rows containing + entities are deleted. Defaults to false. When true, the + request must include every feature which shares the same + ``table_name`` property in their MaterializedFeature. + Features from multiple tables may be included if all + features materialized in each table are included. + request_id: + type: string + description: Optional UUID4 idempotency token for the request. + tags: type: object - properties: - name: - type: string - description: >- - Full three-part (catalog.schema.stream) name of the - stream. - source_config: - type: object - properties: - kafka_stream_config: - type: object - properties: - subscription_mode: - type: object - properties: - assign: - type: string - description: >- - A JSON string that contains the specific - topic-partitions to consume from. For - example, for - '{"topicA":[0,1],"topicB":[2,4]}', topicA's - 0'th and 1st partitions will be consumed - from. - subscribe: - type: string - description: >- - A comma-separated list of Kafka topics to - read from. For example, - 'topicA,topicB,topicC'. - subscribe_pattern: - type: string - description: >- - A regular expression matching topics to - subscribe to. For example, 'topic.*' will - subscribe to all topics starting with - 'topic'. - description: >- - Options to configure which Kafka topics to pull - data from. - extra_options: - type: object - description: >- - Optional Kafka source or consumer options, - validated against a server-side allowlist at - request time. Allowed keys: - - ``maxOffsetsPerTrigger`` - ``startingOffsets`` - - ``includeHeaders`` - - ``kafka.request.timeout.ms`` - - ``kafka.session.timeout.ms`` - - ``kafka.max.partition.fetch.bytes`` The - following keys are ingestion-only and are - stripped before being forwarded to the - materialization pipeline: - - ``maxOffsetsPerTrigger`` - ``startingOffsets`` - Auth and connection details belong on the parent - Stream's ``connection_config``, not here. - required: - - subscription_mode - description: Configuration for Apache Kafka streams. - kinesis_stream_config: - type: object - properties: - extra_options: - type: object - description: >- - Optional Kinesis source options, validated - against a server-side allowlist at request time. - Auth and connection details belong on the parent - Stream's ``connection_config``, not here. - stream_arns: - type: object - properties: - arns: - type: array - items: - type: string - description: >- - Kinesis stream ARNs to read from. For - example, - 'arn:aws:kinesis:us-west-2:111122223333:stream/stream-a'. - description: Kinesis stream ARNs to read from. - stream_names: - type: object - properties: - names: - type: array - items: - type: string - description: Kinesis stream names to read from. - description: Kinesis stream names to read from. - description: Configuration for AWS Kinesis Data Streams. - description: >- - Source-specific configuration. Determines the streaming - platform source. - connection_config: - type: object - properties: - direct_mtls_config: - type: object - properties: - bootstrap_servers: - type: string - description: >- - A comma-separated list of host:port pairs for - the Kafka bootstrap servers. - mtls_config: - type: object - properties: - keystore_location: - type: string - description: >- - Unity Catalog volume path to the JKS - keystore file containing the client - certificate and private key. e.g. - "/Volumes////client.jks". - The materialization compute must have read - permission on this volume. - keystore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS keystore - password. - key_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the private key - password. Often the same value as the - keystore password (keytool's default), but - provided as a separate field because Apache - Kafka requires it as a distinct option - (kafka.ssl.key.password). - truststore_location: - type: string - description: >- - Unity Catalog volume path to the JKS - truststore file containing the CA - certificate(s) trusted to verify the Kafka - broker's server certificate. e.g. - "/Volumes////truststore.jks". - truststore_password_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Secret-scope reference for the JKS - truststore password. - disable_hostname_verification: - type: boolean - description: >- - Set to true only when the broker - certificate's SAN intentionally does not - match the connection endpoint — for example - when reaching the cluster through a - PrivateLink endpoint whose DNS name is not - in the broker certificate. Skipping the - hostname check removes a defense against - man-in-the-middle attacks; do not enable - casually. mTLS client authentication is - unaffected by this option. See the Apache - Kafka SSL security guide for background on - this check: - https://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification - required: - - keystore_location - - keystore_password_ref - - key_password_ref - - truststore_location - - truststore_password_ref - description: Mutual-TLS authentication configuration. - required: - - bootstrap_servers - - mtls_config - description: >- - Direct mTLS configuration for stream platform - access. This is only used in the short term until UC - Kafka Connections support mTLS . Once UC Kafka - Connections support mTLS, this will be deprecated. - uc_connection_name: - type: string - description: >- - Name of an existing UC Connection for stream - platform access. Must be the correct type for the - streaming platform (e.g. a Kafka Connection for a - Kafka Stream, or a Kinesis Connection for a Kinesis - Stream). - description: >- - Specifies how to connect and authenticate to the stream - platform. - schema_config: - type: object - properties: - direct_schemas: - type: object - properties: - key_schema: - type: object - properties: - avro_schema: - type: string - json_schema: - type: string - description: >- - Schema of the JSON object in standard IETF - JSON schema format - (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and - proto3 syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message - within schema_text that describes the - Kafka payload (e.g. "Event" or - "com.example.Event" if schema_text - declares a package). Identifies which - message is used to decode each Kafka - record — a .proto file may declare - multiple messages but only one - represents the payload. Must not be - empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload - message name. - description: >- - Schema for the message key. This is only used - for Kafka streams. For Kafka, at least one of - payload_schema or key_schema must be specified. - payload_schema: - type: object - properties: - avro_schema: - type: string - json_schema: - type: string - description: >- - Schema of the JSON object in standard IETF - JSON schema format - (https://json-schema.org/). - proto_schema: - type: object - properties: - schema_text: - type: string - description: >- - The raw .proto file text (proto2 and - proto3 syntax supported, see - https://protobuf.dev/programming-guides/proto3/ - and - https://protobuf.dev/programming-guides/proto2/). - message_name: - type: string - description: >- - The fully-qualified name of the message - within schema_text that describes the - Kafka payload (e.g. "Event" or - "com.example.Event" if schema_text - declares a package). Identifies which - message is used to decode each Kafka - record — a .proto file may declare - multiple messages but only one - represents the payload. Must not be - empty. - required: - - schema_text - - message_name - description: >- - Protocol Buffer schema with its payload - message name. - description: >- - Schema for the message payload. For Kafka, this - is the value schema. Unless the platform - supports another schema (e.g. keys for Kafka), - this must be specified. - description: Schema definitions provided directly on the Stream. - schema_registry_config: - type: object - properties: - api_secret_ref: - type: object - properties: - scope: - type: string - description: The Databricks secret scope name. - key: - type: string - description: The key within the scope. - required: - - scope - - key - description: >- - Reference to the schema registry API secret in a - Databricks secret scope. - key_schema_locator: - type: object - properties: - format: - type: string - x-enum: - - FORMAT_AVRO - - FORMAT_JSON - - FORMAT_PROTOBUF - description: Serialization format for this schema. - confluent_schema: - type: object - properties: - subject: - type: string - description: >- - The Confluent schema registry subject - name. - required: - - subject - description: Confluent Schema Registry schema locator. - required: - - format - description: >- - Schema locator for the message key. Only used - for Kafka streams. At least one of - payload_schema_locator or key_schema_locator - must be set. - payload_schema_locator: - type: object - properties: - format: - type: string - x-enum: - - FORMAT_AVRO - - FORMAT_JSON - - FORMAT_PROTOBUF - description: Serialization format for this schema. - confluent_schema: - type: object - properties: - subject: - type: string - description: >- - The Confluent schema registry subject - name. - required: - - subject - description: Confluent Schema Registry schema locator. - required: - - format - description: >- - Schema locator for the message payload. For - Kafka this is the value. At least one of - payload_schema_locator or key_schema_locator - must be set. - uc_connection: - type: string - description: A Schema Registry UC Connection object. - required: - - api_secret_ref - description: Resolve schemas from an external schema registry. - description: >- - Schema definitions for the stream, provided either - directly on the Stream or resolved from an external - schema registry through a UC Connection. - ingestion_config: - type: object - properties: - ingestion_destination: - type: object - properties: - delta_table_name: - type: string - description: >- - The full three-part name (catalog, schema, name) - of the Delta table to be created for ingestion. - description: >- - Destination for the Databricks-managed Delta table - that holds an offline copy of the streaming data for - querying and training. This table contains both 1) - forward-filled data from the Stream and 2) - backfilled data from the BackfillSource (if - provided). This table is created and managed by - Databricks and is deleted when the Stream is - deleted. - backfill_job_id: - type: integer - description: >- - The ID of the Databricks Job that performs the - historical backfill of the ingestion Delta table. - backfill_source: - type: object - properties: - delta_table_name: - type: string - delta_table_source: - type: object - properties: - full_name: - type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after - transformations, in Spark StructType JSON - format (from df.schema.json()). Required if - transformation_sql is specified. Example: - {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} - entity_columns: - type: array - items: - type: string - description: >- - Deprecated: Use Feature.entity instead. Kept - for backwards compatibility. The entity - columns of the Delta table. - filter_condition: - type: string - description: >- - Single WHERE clause to filter delta table - before applying transformations. Will be - row-wise evaluated, so should only include - conditionals and projections. - timeseries_column: - type: string - description: >- - Deprecated: Use Feature.timeseries_column - instead. Kept for backwards compatibility. - The timeseries column of the Delta table. - transformation_sql: - type: string - description: >- - A single SQL SELECT expression applied after - filter_condition. Should contains all the - columns needed (eg. "SELECT *, col_a + col_b - AS col_c FROM x.y.z WHERE col_a > 0" would - have ``transformation_sql`` "*, col_a + - col_b AS col_c") If transformation_sql is - not provided, all columns of the delta table - are present in the DataSource dataframe. - required: - - full_name - description: >- - Deprecated: Use delta_table_name instead. Kept - for backwards compatibility. The Delta table - source containing the historical data to - backfill. Only the delta table name is used for - backfill, other fields are ignored. - description: >- - A user-provided source for backfilling data. - Historical data is used when creating a training set - from streaming features linked to this Stream. The - backfill data stored in this location will be copied - into the ingestion table for offline querying and - training. The schema for this source must match - exactly that of the key and payload schemas - specified for this Stream. - deduplication_columns: - type: array - items: - type: string - description: >- - Column paths used to identify duplicate rows during - ingestion; only one row per distinct combination of - these values is kept. Use dot notation for nested - fields (e.g. ``value.user_id``). Empty list means - every column is compared. - ingestion_job_id: - type: integer - description: >- - The ID of the Databricks Job that performs the - forward-fill ingestion. - ingestion_pipeline_id: - type: string - description: >- - The ID of the SDP pipeline that continuously copies - new events from the streaming source into the - ingestion Delta table. - required: - - ingestion_destination - description: >- - Configuration for streaming data ingestion: the managed - table storing an offline copy of forward fill data and - optional historical backfill. - browse_only: - type: boolean - 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. - create_time: - type: string - format: date-time - description: Time at which this Stream was created. - created_by: - type: string - description: Username of the Stream creator. - description: - type: string - description: User-provided description. - update_time: - type: string - format: date-time - description: Time at which this Stream was last modified. - updated_by: - type: string - description: Username of user who last modified the Stream. - required: - - name - - source_config - - connection_config - - schema_config - - ingestion_config - description: The Stream to update. + description: >- + Custom tags to associate with this purge. They are applied + to the purge job and forwarded to the underlying compute as + Databricks resource tags, so purge cost can be attributed in + the billing system tables. These tags apply only to the + purge compute; they are not applied to the Unity Catalog + Feature resources themselves, whose tags are managed + separately through the Unity Catalog tagging API. A maximum + of 25 tags is supported; keys and values are subject to the + same limitations as Databricks resource tags. required: - - stream + - features + - entities_table responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Stream' + type: object default: description: Error response content: @@ -7854,60 +10339,54 @@ paths: Create an Online Feature Store. :param online_store: :class:`OnlineStore` - Online store to create. - - :returns: :class:`OnlineStore` - requestBody: - content: - application/json: - schema: - type: object - properties: - online_store: - type: object - properties: - name: - type: string - description: >- - The name of the online store. This is the unique - identifier for the online store. - capacity: - type: string - description: >- - The capacity of the online store. Valid values are - "CU_1", "CU_2", "CU_4", "CU_8". - creation_time: - type: string - description: The timestamp when the online store was created. - creator: - type: string - description: The email of the creator of the online store. - read_replica_count: - type: integer - description: >- - The number of read replicas for the online store. - Defaults to 0. - state: - type: string - x-enum: - - AVAILABLE - - DELETING - - FAILING_OVER - - STARTING - - STOPPED - - UPDATING - description: The current state of the online store. - usage_policy_id: - type: string - description: >- - The usage policy applied to the online store to track - billing. - required: - - name - - capacity - description: Online store to create. + Online store to create. + + :returns: :class:`OnlineStore` + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: >- + The name of the online store. This is the unique identifier + for the online store. + capacity: + type: string + description: >- + The capacity of the online store. Valid values are "CU_1", + "CU_2", "CU_4", "CU_8". + creation_time: + type: string + description: The timestamp when the online store was created. + creator: + type: string + description: The email of the creator of the online store. + read_replica_count: + type: integer + description: >- + The number of read replicas for the online store. Defaults + to 0. + state: + type: string + x-enum: + - AVAILABLE + - DELETING + - FAILING_OVER + - STARTING + - STOPPED + - UPDATING + description: The current state of the online store. + usage_policy_id: + type: string + description: >- + The usage policy applied to the online store to track + billing. required: - - online_store + - name + - capacity responses: '200': description: Success @@ -8055,9 +10534,19 @@ paths: tags: - ml - feature_store - description: |- + description: >- Update an Online Feature Store. + + This update is not guaranteed to be atomic: when a request changes + multiple fields, some may be + + applied while others fail. On a failed response, treat the update as + partially applied and retry until + + it succeeds. + + :param name: str The name of the online store. This is the unique identifier for the online store. :param online_store: :class:`OnlineStore` @@ -8087,51 +10576,45 @@ paths: schema: type: object properties: - online_store: - type: object - properties: - name: - type: string - description: >- - The name of the online store. This is the unique - identifier for the online store. - capacity: - type: string - description: >- - The capacity of the online store. Valid values are - "CU_1", "CU_2", "CU_4", "CU_8". - creation_time: - type: string - description: The timestamp when the online store was created. - creator: - type: string - description: The email of the creator of the online store. - read_replica_count: - type: integer - description: >- - The number of read replicas for the online store. - Defaults to 0. - state: - type: string - x-enum: - - AVAILABLE - - DELETING - - FAILING_OVER - - STARTING - - STOPPED - - UPDATING - description: The current state of the online store. - usage_policy_id: - type: string - description: >- - The usage policy applied to the online store to track - billing. - required: - - name - - capacity - description: Online store to update. + name: + type: string + description: >- + The name of the online store. This is the unique identifier + for the online store. + capacity: + type: string + description: >- + The capacity of the online store. Valid values are "CU_1", + "CU_2", "CU_4", "CU_8". + creation_time: + type: string + description: The timestamp when the online store was created. + creator: + type: string + description: The email of the creator of the online store. + read_replica_count: + type: integer + description: >- + The number of read replicas for the online store. Defaults + to 0. + state: + type: string + x-enum: + - AVAILABLE + - DELETING + - FAILING_OVER + - STARTING + - STOPPED + - UPDATING + description: The current state of the online store. + usage_policy_id: + type: string + description: >- + The usage policy applied to the online store to track + billing. required: - - online_store + - name + - capacity responses: '200': description: Success @@ -8237,6 +10720,15 @@ paths: description: >- The publish mode of the pipeline that syncs the online table with the source table. + budget_policy_id: + type: string + description: >- + Budget policy id used to attribute the serverless + compute cost of the synced online-table sync pipeline. + Applied only when the sync pipeline is first created + (the initial publish of a new online table); + republishing to an existing online table does not update + it. full_feature_name: type: string description: >- @@ -8246,6 +10738,16 @@ paths: Required for view sources without a UC PrimaryKeyConstraint; ignored when the source already has one. + tags: + type: object + description: >- + Custom tags to apply to the synced online-table sync + pipeline created for this publish. They are forwarded to + the pipeline's compute as cluster tags so its cost can + be attributed in the billing system tables. Applied only + when the sync pipeline is first created (the initial + publish of a new online table); republishing to an + existing online table does not update them. required: - online_store - online_table_name @@ -8548,18 +11050,12 @@ paths: schema: type: object properties: - feature_tag: - type: object - properties: - key: - type: string - value: - type: string - required: - - key - description: Represents a tag on a feature in a feature table. + key: + type: string + value: + type: string required: - - feature_tag + - key responses: '200': description: Success @@ -8782,18 +11278,12 @@ paths: schema: type: object properties: - feature_tag: - type: object - properties: - key: - type: string - value: - type: string - required: - - key - description: Represents a tag on a feature in a feature table. + key: + type: string + value: + type: string required: - - feature_tag + - key responses: '200': description: Success @@ -11536,11 +14026,23 @@ components: description: >- The input column from which the approximate count of distinct values is computed. + relative_error: + type: number + description: >- + The error the user accepts, as a fraction of the count, between 0.02 + (by default) and 0.3. This is one standard error of the estimate, + the same meaning as Spark's relativeSD: 0.02 means the result is + within ±2% of the true count about 68% of the time (one standard + deviation covers 68% of the region). Feature Store picks the sketch + size that gives this relative error. If neither relative_error nor + relative_sd is set, 0.02 is default chosen at feature creation. relative_sd: type: number description: >- The maximum relative standard deviation allowed (default defined by - Spark). + Spark). Deprecated: use relative_error. When relative_error is set, + reads return the same value here for clients that don't have + relative_error, and a request may only send that value. required: - input description: Computes the approximate count of distinct values. @@ -11555,7 +14057,20 @@ components: description: The percentile value to compute (between 0 and 1). accuracy: type: integer - description: The accuracy parameter (higher is more accurate but slower). + description: >- + The accuracy parameter (higher is more accurate but slower). + Deprecated: use relative_error. When relative_error is set, reads + return ceil(1 / relative_error) here for clients that don't have + relative_error, and a request may only send that value. + relative_error: + type: number + description: >- + The error the user accepts, as a fraction of rank, between 0.01 (by + default) and 0.3. The result is within this rank error with 99% + confidence: at 0.01, the value returned for p95 is between the true + p94 and p96 at least 99% of the time. Feature Store picks the sketch + size that gives this error. If neither relative_error nor accuracy + is set, 0.01 is default chosen at feature creation. required: - input - percentile @@ -11584,6 +14099,43 @@ components: required: - input description: Computes the average of values. + BackfillFeaturesResponse: + type: object + properties: {} + description: Result of a completed backfill. + BackfillOperationMetadata: + type: object + properties: + backfill_ranges: + type: array + items: + $ref: '#/components/schemas/BackfillRange' + description: Output ranges targeted by the backfill. + feature_full_names: + type: array + items: + type: string + description: Full names of the features targeted by the backfill. + state: + $ref: '#/components/schemas/BackfillOperationMetadataState' + description: Current state of the backfill. + description: Progress and configuration for a backfill. + BackfillRange: + type: object + properties: + end_time: + type: string + format: date-time + description: >- + End of the backfill range, exclusive. If unset, defaults to the + current time. + start_time: + type: string + format: date-time + description: >- + Start of the backfill range, inclusive. If unset, defaults to the + earliest source timestamp of the feature. + description: A time range for a backfill. BackfillSource: type: object properties: @@ -11620,8 +14172,7 @@ components: - column description: >- A ColumnSelection function, equivalent to the LAST() record of an entity - over a lifetime - ContinuousWindow + over a lifetime window CommentObject: type: object properties: @@ -11658,13 +14209,11 @@ components: properties: window_duration: type: string - description: The duration of the continuous window (must be positive). offset: type: string description: The offset of the continuous window (must be non-positive). required: - window_duration - description: 'Deprecated: use RollingWindow with ``delay`` instead.' CountFunction: type: object properties: @@ -11738,7 +14287,20 @@ components: type: string description: >- The cron expression defining the schedule (e.g., "0 0 * * *" for - daily at midnight). + daily at midnight). The schedule is interpreted in timezone_id + (defaults to UTC). Required when mode is MANUAL (or unset). Left + empty when mode is DERIVED, where the service computes it (aligned + to UTC) from the features' window timing and fills it in on the + response. + mode: + $ref: '#/components/schemas/CronScheduleMode' + description: How the schedule is determined. Defaults to MANUAL when unset. + timezone_id: + type: string + description: >- + A Java timezone ID. The schedule is resolved with respect to this + timezone. Defaults to UTC when omitted. Can only be configured for + MANUAL schedules; DERIVED schedules are always aligned to UTC. description: A cron-based schedule trigger for the materialization pipeline. CustomUdf: type: object @@ -11765,18 +14327,44 @@ components: delta_table_source: $ref: '#/components/schemas/DeltaTableSource' description: A Delta table data source. + feature_view_source: + $ref: '#/components/schemas/FeatureViewSource' + description: A data source composed from registered upstream Features. kafka_source: $ref: '#/components/schemas/KafkaSource' description: A Kafka stream data source. + lateness: + $ref: '#/components/schemas/SourceLateness' + description: >- + Completeness timing for this Feature's use of the source. This + configuration is part of the Feature definition; it does not modify + the underlying table or stream. request_source: $ref: '#/components/schemas/RequestSource' description: A request-time data source. + sdp_source: + $ref: '#/components/schemas/SdpSource' + description: A Spark Declarative Pipeline data source. stream_source: $ref: '#/components/schemas/StreamSource' description: A Stream data source. description: >- Specifies the data source backing a feature. Exactly one source type must be set. + DatabricksServiceExceptionWithDetailsProto: + type: object + properties: + details: + type: array + items: + type: object + error_code: + $ref: '#/components/schemas/ErrorCode' + message: + type: string + stack_trace: + type: string + description: Databricks Error that is returned by all Databricks APIs. Dataset: type: object properties: @@ -11897,9 +14485,6 @@ components: type: array items: type: string - description: >- - Deprecated: Use Feature.entity instead. Kept for backwards - compatibility. The entity columns of the Delta table. filter_condition: type: string description: >- @@ -11908,9 +14493,6 @@ components: conditionals and projections. timeseries_column: type: string - description: >- - Deprecated: Use Feature.timeseries_column instead. Kept for - backwards compatibility. The timeseries column of the Delta table. transformation_sql: type: string description: >- @@ -11938,8 +14520,7 @@ components: - mtls_config description: >- Direct connection configs for mTLS, as Kafka Connections do not support - mTLS yet . Temporarily - used until UC Kafka Connections gain mTLS support. + mTLS yet. DirectSchemas: type: object properties: @@ -12111,22 +14692,14 @@ components: $ref: '#/components/schemas/EntityColumn' description: >- The entity columns for the feature, used as aggregation keys and for - query-time lookup. + query-time lookup. Optional since entities are not set for + RequestSource features or on-demand calculated features. filter_condition: type: string - description: >- - Deprecated: Use DeltaTableSource.filter_condition or - KafkaSource.filter_condition instead. Kept for backwards - compatibility. The filter condition applied to the source data - before aggregation. inputs: type: array items: type: string - description: >- - Deprecated: Use AggregationFunction.inputs instead. Kept for - backwards compatibility. The input columns from which the feature is - computed. lineage_context: $ref: '#/components/schemas/LineageContext' description: >- @@ -12147,15 +14720,12 @@ components: description: Name of parent schema relative to its parent catalog. time_window: $ref: '#/components/schemas/TimeWindow' - description: >- - Deprecated: Use Function.aggregation_function.time_window instead. - Kept for backwards compatibility. The time window in which the - feature is computed. timeseries_column: $ref: '#/components/schemas/TimeseriesColumn' description: >- Column recording time, used for point-in-time joins, backfills, and - aggregations. + aggregations. Optional since a timeseries column is not set for + RequestSource features or on-demand calculated features. required: - full_name - source @@ -12206,6 +14776,18 @@ components: items: $ref: '#/components/schemas/LinkedFeature' description: Feature list wrap all the features for a model version + FeatureReference: + type: object + properties: + feature: + type: string + description: The three-part full name of the upstream Feature. + required: + - feature + description: >- + A reference to one registered upstream Feature. A message rather than a + bare name so an upstream + can later be pinned more precisely (e.g. by version) without a breaking type change. FeatureTag: type: object properties: @@ -12216,6 +14798,17 @@ components: required: - key description: Represents a tag on a feature in a feature table. + FeatureViewSource: + type: object + properties: + feature_references: + type: array + items: + $ref: '#/components/schemas/FeatureReference' + description: >- + The upstream Features this source reads. Must include at least one + feature. + description: A data source composed from registered upstream Features. FieldDefinition: type: object properties: @@ -12335,31 +14928,19 @@ components: type: array items: $ref: '#/components/schemas/FunctionExtraParameter' - description: >- - Deprecated: Use the function oneof with AggregationFunction instead. - Kept for backwards compatibility. Extra parameters for parameterized - functions. function_type: $ref: '#/components/schemas/FunctionFunctionType' - description: >- - Deprecated: Use the function oneof with AggregationFunction instead. - Kept for backwards compatibility. The type of the function. FunctionExtraParameter: type: object properties: key: type: string - description: The name of the parameter. value: type: string description: The value of the parameter. required: - key - value - description: |- - Deprecated: Use typed fields on function-specific messages (e.g. - ApproxPercentileFunction.percentile) or AggregationFunction.ExtraParameter instead. Kept for - backwards compatibility. GetExperimentByNameResponse: type: object properties: @@ -12389,13 +14970,6 @@ components: properties: model: $ref: '#/components/schemas/LoggedModel' - GetLoggedModelsRequestResponse: - type: object - properties: - models: - type: array - items: - $ref: '#/components/schemas/LoggedModel' GetMetricHistoryResponse: type: object properties: @@ -12502,7 +15076,14 @@ components: Stream. The backfill data stored in this location will be copied into the ingestion table for offline querying and training. The schema for this source must match exactly that of the key and - payload schemas specified for this Stream. + payload schemas specified for this Stream, except that it may omit + any columns listed in excluded_columns. + budget_policy_id: + type: string + description: >- + The ID of the budget policy used to attribute the serverless compute + cost of this stream's managed ingestion. If not specified, a default + budget policy may be applied. deduplication_columns: type: array items: @@ -12522,6 +15103,18 @@ components: description: >- The ID of the SDP pipeline that continuously copies new events from the streaming source into the ingestion Delta table. + tags: + type: object + description: >- + Custom tags to associate with this stream's managed ingestion. They + are applied to the ingestion pipeline and its forward-fill and + backfill jobs, and forwarded to the underlying compute as cluster + tags, so ingestion cost can be attributed in the billing system + tables. These tags apply only to the managed ingestion compute; they + are not applied to the Stream entity itself, and are distinct from + any Unity Catalog tags on the Stream. A maximum of 25 tags is + supported; keys and values are subject to the same limitations as + cluster tags. required: - ingestion_destination description: >- @@ -12568,6 +15161,103 @@ components: - key - value description: Tag for a dataset input. + Issue: + type: object + properties: + title: + type: string + description: Non-empty, at most 250 UTF-8 bytes. + severity: + $ref: '#/components/schemas/IssueSeverity' + description: >- + Cannot be cleared: an Issue without a severity would match no + severity filter. + categories: + type: array + items: + type: string + description: >- + At most 10 values of at most 64 UTF-8 bytes each, unique + case-insensitively. Leading and trailing whitespace is trimmed. + create_time: + type: string + format: date-time + description: When the Issue was created. + created_by: + type: string + description: >- + The email of the user whose request created the Issue. source_type + tells whether issue detection created it. + description: + type: string + description: Markdown, at most 32 KiB. + issue_id: + type: string + description: >- + The last segment of ``name``. Issue assessments on traces reference + the Issue by this ID. + last_seen_time: + type: string + format: date-time + description: >- + The request time of the latest trace the Issue affects. Required, + and can't be cleared, unless source_type is MANUAL. A MANUAL Issue + without one returns its create_time. + last_updated_by: + type: string + description: The email of the user whose request last updated the Issue. + metadata: + type: object + description: >- + Additional details about the Issue, such as how issue detection + observed it. Not a stable contract: keys and values can change + without notice, so clients must tolerate unknown and missing keys. + At most 20 entries, with keys of at most 64 UTF-8 bytes. + name: + type: string + description: experiments/{experiment}/issues/{issue} + source_id: + type: string + description: >- + Set once at create. For ADHOC_RUN and SCHEDULED_RUN, the ID of the + issue detection run in the same experiment that created the Issue. + Absent for MANUAL. + source_type: + $ref: '#/components/schemas/IssueSourceType' + description: Set once at create. Defaults to MANUAL. + status: + $ref: '#/components/schemas/IssueStatus' + description: Defaults to PENDING on create, and can't be cleared. + tags: + type: object + description: >- + Caller-owned; the server never writes system values here. At most 10 + entries. Keys match ^[A-Za-z0-9_.:/-]+$ and are at most 128 UTF-8 + bytes; values are at most 256 UTF-8 bytes. + update_time: + type: string + format: date-time + description: When the Issue was last updated. + required: + - title + - severity + description: A quality or operational problem found in an experiment's traces. + IssueTagFilter: + type: object + properties: + key: + type: string + description: Matched exactly. + values: + type: array + items: + type: string + description: >- + Matched exactly, and ORed together. Empty matches any Issue carrying + the key. + required: + - key + description: One predicate over Issue.tags. JobContext: type: object properties: @@ -12657,33 +15347,15 @@ components: properties: name: type: string - dataframe_schema: - type: string - description: >- - Schema of the resulting dataframe after transformations, in Spark - StructType JSON format (from df.schema.json()). Any subsequent - functions operate against this dataframe. entity_column_identifiers: type: array items: $ref: '#/components/schemas/ColumnIdentifier' - description: >- - Deprecated: Use Feature.entity instead. Kept for backwards - compatibility. The entity column identifiers of the Kafka source. filter_condition: type: string description: The filter condition applied to the source data before aggregation. timeseries_column_identifier: $ref: '#/components/schemas/ColumnIdentifier' - description: >- - Deprecated: Use Feature.timeseries_column instead. Kept for - backwards compatibility. The timeseries column identifier of the - Kafka source. - transformation_sql: - type: string - description: >- - The pipeline runs these SQL statements immediately after conversion - into the schema specified on the KafkaConfig object. required: - name KafkaStreamConfig: @@ -12737,7 +15409,13 @@ components: type: object description: >- Optional Kinesis source options, validated against a server-side - allowlist at request time. Auth and connection details belong on the + allowlist at request time. Allowed keys: - ``consumerMode`` - + ``consumerNamePrefix`` - ``maxFetchRate`` - ``minFetchPeriod`` - + ``maxFetchDuration`` - ``maxRecordsPerFetch`` - ``shardsPerTask`` - + ``fetchBufferSize`` - ``shardFetchInterval`` ``consumerMode`` must + be ``efo`` or ``polling`` (case-insensitive). ``maxRecordsPerFetch`` + applies only during ingestion and does not affect the + materialization pipeline. Auth and connection details belong on the parent Stream's ``connection_config``, not here. stream_arns: $ref: '#/components/schemas/StreamArnList' @@ -13034,44 +15712,196 @@ components: tags: type: array items: - $ref: '#/components/schemas/LoggedModelTag' - description: Mutable string key-value pairs set on the model. + $ref: '#/components/schemas/LoggedModelTag' + description: Mutable string key-value pairs set on the model. + description: >- + A LoggedModelInfo includes logged model attributes, tags, and + registration info. + LoggedModelParameter: + type: object + properties: + key: + type: string + description: The key identifying this param. + value: + type: string + description: The value of this param. + description: Parameter associated with a LoggedModel. + LoggedModelTag: + type: object + properties: + key: + type: string + description: The tag key. + value: + type: string + description: The tag value. + description: Tag for a LoggedModel. + MaterializationFailureNotification: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for example Slack, Microsoft + Teams, PagerDuty, or a generic webhook) to notify. Not supported for + streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + final_attempt_only: + type: boolean + description: >- + If true, notify only when the final attempt of a run fails. If false + or unset, notify on every failed attempt, including attempts that + will be retried. Batch materialization does not retry failures that + need a fix on your side, such as missing permissions or invalid + configuration, so the first attempt is the final one. Other batch + failures are retried up to twice. Streaming materialization restarts + a failed update indefinitely unless the error cannot be retried. + With this set, a streaming materialized feature notifies only on + errors that cannot be retried, and never on failures that are + restarted. + description: Recipients to notify when a materialization run fails. + MaterializationNotifications: + type: object + properties: + on_failure: + $ref: '#/components/schemas/MaterializationFailureNotification' + description: Who to notify when a run fails, and on which attempts. + on_success: + $ref: '#/components/schemas/MaterializationSuccessNotification' + description: Who to notify when a run succeeds. + description: >- + Notifications for the jobs and pipelines that materialize a feature, one + field per trigger. + MaterializationSet: + type: object + properties: + materialization_set_id: + type: string + description: Server-assigned unique identifier for the materialization set. + materialized_features: + type: array + items: + $ref: '#/components/schemas/MaterializedFeature' + description: >- + The materialized features in this set. Order is not significant. + Updating the set with a materialized feature removed from this set + will cause it to be deleted. + description: A group of materialized features created and managed as a single unit. + MaterializationSetDeletionProgress: + type: object + properties: + deleted_materialized_feature_ids: + type: array + items: + type: string + description: >- + Members that are no longer materialized, including any that were + already gone. + failed_materialized_features: + type: array + items: + $ref: '#/components/schemas/MaterializedFeatureChangeFailure' + description: Members that could not be deleted, one entry each. description: >- - A LoggedModelInfo includes logged model attributes, tags, and - registration info. - LoggedModelParameter: + What a partly failed DeleteMaterializationSet got through, attached to + the error so a caller can + tell which materialized feature members are gone and which ones still need attention. The set + itself is left in place whenever any member failed, so a retry can still find the members. + MaterializationSetOperationMetadata: type: object properties: - key: + create_time: type: string - description: The key identifying this param. - value: + format: date-time + description: Time at which the operation was requested. + deletion_progress: + $ref: '#/components/schemas/MaterializationSetDeletionProgress' + description: Set by a DeleteMaterializationSet operation. + feature_full_names: + type: array + items: + type: string + description: >- + Full names of the features the set materializes, one entry per + feature. + materialization_set_id: type: string - description: The value of this param. - description: Parameter associated with a LoggedModel. - LoggedModelTag: + description: ID of the materialization set the operation targets. + state: + $ref: '#/components/schemas/MaterializationSetOperationMetadataState' + description: Current state of the operation. + update_progress: + $ref: '#/components/schemas/MaterializationSetUpdateProgress' + description: Set by an UpdateMaterializationSet operation. + description: >- + Progress of a materialization set operation. Shared by create, update + and delete, because + databricks.longrunning freezes a method's metadata type once it ships. + MaterializationSetUpdateProgress: type: object properties: - key: - type: string - description: The tag key. - value: - type: string - description: The tag value. - description: Tag for a LoggedModel. + deleted_materialized_feature_ids: + type: array + items: + type: string + description: >- + Materialized feature members that were deleted from the + materialization set. + failed_materialized_features: + type: array + items: + $ref: '#/components/schemas/MaterializedFeatureChangeFailure' + description: >- + Materialized feature members that could not be updated, one entry + each. + updated_materialized_feature_ids: + type: array + items: + type: string + description: Materialized feature members whose mutable state was updated. + description: >- + What a partly failed UpdateMaterializationSet got through, attached to + the error so a caller can + tell which materialized feature members already changed and which ones did not and why it + failed. + MaterializationSuccessNotification: + type: object + properties: + destination_ids: + type: array + items: + type: string + description: >- + IDs of the notification destinations (for example Slack, Microsoft + Teams, PagerDuty, or a generic webhook) to notify. Not supported for + streaming materialized features. + email_addresses: + type: array + items: + type: string + description: Email addresses to notify. + description: Recipients to notify when a materialization run succeeds. MaterializedFeature: type: object properties: feature_name: type: string description: The full name of the feature in Unity Catalog. - cron_schedule: + budget_policy_id: type: string description: >- - The quartz cron expression that defines the schedule of the - materialization pipeline. The schedule is evaluated in the UTC - timezone. Hidden from GraphQL: superseded by the ``trigger`` oneof - (cron_schedule_trigger), so not exposed to Catalog Explorer. + The ID of the budget policy used to attribute the serverless compute + cost of this materialization. If not specified, a default budget + policy may be applied. + cron_schedule: + type: string cron_schedule_trigger: $ref: '#/components/schemas/CronSchedule' description: A cron-based schedule trigger for the materialization pipeline. @@ -13080,21 +15910,53 @@ components: description: >- True if this is an online materialized feature. False if it is an offline materialized feature. + job_id: + type: integer + description: >- + The ID of the job that materializes the feature. This is present for + both batch and streaming features. last_materialization_time: type: string description: >- The timestamp when the pipeline last ran and updated the materialized feature values. If the pipeline has not run yet, this field will be null. + latest_backfill_operation: + type: string + description: >- + Name of the latest backfill operation on this materialized feature. + Format: operations/{operation_id}. + materialization_set_id: + type: string + description: >- + The materialization set this materialized feature was created for, + through DABs or direct-engine creation. Unset for a materialized + feature that was not created as part of a set. materialized_feature_id: type: string description: Server-assigned unique identifier for the materialized feature. + notifications: + $ref: '#/components/schemas/MaterializationNotifications' + description: >- + Notification configuration around the materialization job or + pipeline lifecycle. They are applied to every job and pipeline that + materializes this feature. Features which are materialized in the + same pipeline will share the same notification. offline_store_config: $ref: '#/components/schemas/OfflineStoreConfig' - description: Destination for writing feature values to an offline Delta table. + description: >- + Destination for writing feature values to an offline Delta table. + The resulting table is returned as ``table_name``. online_store_config: $ref: '#/components/schemas/OnlineStoreConfig' - description: Destination for writing feature values to an online Lakebase table. + description: >- + Destination for writing feature values to an online Lakebase table. + The resulting table is returned as ``table_name``. + pipeline_id: + type: string + description: >- + The ID of the pipeline that materializes this feature. This is only + present for streaming features. pipeline_schedule_state: $ref: '#/components/schemas/MaterializedFeaturePipelineScheduleState' description: >- @@ -13115,11 +15977,38 @@ components: table_trigger: $ref: '#/components/schemas/TableTrigger' description: A trigger that fires when the upstream source table changes. + tags: + type: object + description: >- + Custom tags to associate with this materialization. They are applied + to the materialization job (for batch features) or pipeline (for + streaming features) and forwarded to the underlying compute as + cluster tags, so materialization cost can be attributed in the + billing system tables. These tags apply only to the materialization + compute; they are not applied to the Unity Catalog Feature resource + itself, whose tags are managed separately through the Unity Catalog + tagging API. A maximum of 25 tags is supported; keys and values are + subject to the same limitations as cluster tags. required: - feature_name description: >- A materialized feature represents a feature that is continuously computed and stored. + MaterializedFeatureChangeFailure: + type: object + properties: + error_code: + type: string + description: >- + Databricks error code name of the failure, for example + "RESOURCE_CONFLICT". + materialized_feature_id: + type: string + description: The member that could not be changed. + message: + type: string + description: The failure's message. + description: Why one materialization set member could not be changed. MaxFunction: type: object properties: @@ -13456,12 +16345,6 @@ components: with their passwords stored in Databricks secret scopes. This matches the SSL setup pattern documented at https://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka. - - At materialization time, the generated PySpark code passes the JKS file paths and resolved - passwords through to the Kafka SSL options (kafka.ssl.keystore.location, - kafka.ssl.keystore.password, kafka.ssl.key.password, kafka.ssl.truststore.location, - kafka.ssl.truststore.password). Passwords are resolved on the Spark cluster via - dbutils.secrets.get; this message stores only references, never password values. OfflineStoreConfig: type: object properties: @@ -13545,6 +16428,39 @@ components: - table_name_prefix - online_store_name description: Configuration for online store destination. + Operation: + type: object + properties: + done: + type: boolean + description: >- + If the value is ``false``, it means the operation is still in + progress. If ``true``, the operation is completed, and either + ``error`` or ``response`` is available. + error: + $ref: '#/components/schemas/DatabricksServiceExceptionWithDetailsProto' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the ``name`` should be a resource name ending with + ``operations/{unique_id}``. + response: + type: object + description: The normal, successful response of the operation. + description: >- + This resource represents a long-running operation that is the result of + a network API call. Param: type: object properties: @@ -13594,6 +16510,13 @@ components: description: >- The publish mode of the pipeline that syncs the online table with the source table. + budget_policy_id: + type: string + description: >- + Budget policy id used to attribute the serverless compute cost of + the synced online-table sync pipeline. Applied only when the sync + pipeline is first created (the initial publish of a new online + table); republishing to an existing online table does not update it. full_feature_name: type: string description: >- @@ -13601,6 +16524,15 @@ components: source table, used to derive the synced online table's entity and timeseries columns. Required for view sources without a UC PrimaryKeyConstraint; ignored when the source already has one. + tags: + type: object + description: >- + Custom tags to apply to the synced online-table sync pipeline + created for this publish. They are forwarded to the pipeline's + compute as cluster tags so its cost can be attributed in the billing + system tables. Applied only when the sync pipeline is first created + (the initial publish of a new online table); republishing to an + existing online table does not update them. required: - online_store - online_table_name @@ -13615,6 +16547,74 @@ components: description: >- The ID of the pipeline that syncs the online table with the source table. + PurgeFeatureEntitiesMetadata: + type: object + properties: + create_time: + type: string + format: date-time + description: Time at which the purge operation was created. + delete_rows: + type: boolean + description: >- + Whether this purge deletes matching rows instead of setting feature + values to null. + entities_table: + type: string + description: >- + Fully qualified name of the Unity Catalog Delta table containing the + entity keys to purge. + entities_table_version: + type: string + description: Version of the entities table used by the purge. + features: + type: array + items: + type: string + description: Fully qualified names of the features targeted by the purge. + job_id: + type: integer + description: ID of the job that executes this purge. + state: + $ref: '#/components/schemas/PurgeFeatureEntitiesMetadataState' + description: Current state of the purge operation. + description: Progress and configuration for a feature entity purge. + PurgeFeatureEntitiesResponse: + type: object + properties: + error: + $ref: '#/components/schemas/DatabricksServiceExceptionWithDetailsProto' + description: >- + Operation-level error, if the purge failed outside an individual + feature target. + metadata: + $ref: '#/components/schemas/PurgeFeatureEntitiesMetadata' + description: Metadata about the purge operation. + results: + type: array + items: + $ref: '#/components/schemas/PurgeFeatureEntitiesResult' + description: Per-feature purge results. + state: + $ref: '#/components/schemas/PurgeFeatureEntitiesMetadataState' + description: State of the purge operation. + description: Result of a completed feature entity purge. + PurgeFeatureEntitiesResult: + type: object + properties: + error: + $ref: '#/components/schemas/DatabricksServiceExceptionWithDetailsProto' + description: Error encountered while purging this feature, if any. + feature: + type: string + description: Fully qualified name of the feature that was purged. + offline_state: + $ref: '#/components/schemas/PurgeFeatureEntitiesResultState' + description: State of the offline purge for this feature. + online_state: + $ref: '#/components/schemas/PurgeFeatureEntitiesResultState' + description: State of the online purge for this feature. + description: Result of purging one feature. RegisteredModelAccessControlRequest: type: object properties: @@ -13740,6 +16740,12 @@ components: RequestSource: type: object properties: + dataframe_schema: + type: string + description: >- + A schema containing scalar or nested fields, in Spark StructType + JSON format (from df.schema.json()). This preserves field, + array-element, and map-value nullability. flat_schema: $ref: '#/components/schemas/FlatSchema' description: A flat schema with scalar-typed fields only. @@ -13764,19 +16770,16 @@ components: delay: type: string description: >- - The delay applied to the end of the rolling window (must be - non-negative). For example, delay=1d shifts the window end 1 day - before the evaluation time. + Non-negative analytic lag that evaluates the window this far in the + past. Use this for timing variations unrelated to source lateness, + such as a 30-day count as of one week ago. If unset, the analytic + lag is zero. It composes with source.lateness when both are set. window_duration: type: string description: >- The duration of the rolling window. Must be positive when set; absent means lifetime (aggregate over the entity's entire history). - description: >- - A rolling time window with an optional delay. This is the - SQL-spec-aligned replacement for - ContinuousWindow: ``delay`` is the non-negative counterpart of the legacy non-positive - ``ContinuousWindow.offset``. + description: A rolling time window with an optional non-negative delay. Run: type: object properties: @@ -13883,10 +16886,7 @@ components: properties: delay: type: string - description: >- - The delay applied to the end of the window (must be non-negative). - For example, delay=1d shifts the window end 1 day before the - evaluation time. + description: Delay is not currently supported for Sawtooth windows. window_duration: type: string description: >- @@ -13956,7 +16956,8 @@ components: $ref: '#/components/schemas/SecretScopeReference' description: >- Reference to the schema registry API secret in a Databricks secret - scope. + scope. Set this only if required for authentication for the schema + registry. key_schema_locator: $ref: '#/components/schemas/SchemaLocator' description: >- @@ -13972,11 +16973,66 @@ components: uc_connection: type: string description: A Schema Registry UC Connection object. - required: - - api_secret_ref description: >- Configuration for resolving a Stream's schema from an external schema registry (e.g. Confluent). + SdpSource: + type: object + properties: + dataframe_schema: + type: string + description: >- + Schema of the resulting dataframe after transformations, in Spark + StructType JSON format (from df.schema.json()). Required if + transformation_sql is specified. Example: + {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + filter_condition: + type: string + description: >- + Single WHERE clause to filter the pipeline's output table before + applying transformations. Will be row-wise evaluated, so should only + include conditionals and projections. + input_tables: + type: array + items: + type: string + description: >- + The full three-part names of the tables the pipeline reads from. + Required to materialize this feature with a TableTrigger, which + starts a run when these tables update. Each table must exist when + the feature is created. Feature Store doesn't confirm that the + pipeline reads from these tables. At most 100 tables. + output_table: + type: string + description: >- + The full three-part (catalog, schema, table) name of the pipeline's + output table to read from. The table doesn't need to exist until the + pipeline first runs. Required. + pipeline_id: + type: string + description: >- + The ID of the Spark Declarative Pipeline that Feature Store runs to + produce this source, before each materialization or backfill. The + pipeline must already exist when the feature is created, and you + need CAN_RUN, CAN_MANAGE, or owner permission on it. It doesn't need + to have run yet. Deleting the feature doesn't delete the pipeline. + If the pipeline is deleted, this field reads back empty. Required. + pipeline_state: + $ref: '#/components/schemas/SdpSourceState' + description: >- + State tracking pipeline execution and output table validation. + PENDING until the pipeline has run at least once and created the + output table; then RESOLVED on success, or ERROR on failure. + transformation_sql: + type: string + description: >- + A single SQL SELECT expression applied after filter_condition. + Should contain all the columns needed (eg. "SELECT *, col_a + col_b + AS col_c FROM x.y.z WHERE col_a > 0" would have + ``transformation_sql`` "*, col_a + col_b AS col_c") If + transformation_sql is not provided, all columns of the pipeline's + output table are present in the DataSource dataframe. + description: A Spark Declarative Pipeline (SDP) data source. SearchExperimentsResponse: type: object properties: @@ -13990,6 +17046,21 @@ components: Token that can be used to retrieve the next page of experiments. An empty token means that no more experiments are available for retrieval. + SearchIssuesResponse: + type: object + properties: + issues: + type: array + items: + $ref: '#/components/schemas/Issue' + description: The page's Issues, in the requested order. + next_page_token: + type: string + description: Absent on the last page. + total_size: + type: integer + description: Exact number of matching Issues. + description: One page of SearchIssues results. SearchLoggedModelsDataset: type: object properties: @@ -14081,10 +17152,7 @@ components: required: - scope - key - description: >- - Reference to an entry in a Databricks secret scope. The referenced value - is fetched on the Spark - cluster at materialization time via dbutils.secrets.get(scope, key). + description: Reference to an entry in a Databricks secret scope. SetExperimentTagResponse: type: object properties: {} @@ -14105,6 +17173,21 @@ components: properties: slide_duration: type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window this far in the + past. Use this for timing variations unrelated to source lateness, + such as a 30-day count as of one week ago. If unset, the analytic + lag is zero. It composes with source.lateness when both are set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight UTC alignment. + For example, offset=22h on a 24h slide produces boundaries at 22:00 + UTC (17:00 New York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than slide_duration (and + therefore window_duration). window_duration: type: string description: >- @@ -14112,6 +17195,21 @@ components: absent means lifetime (aggregate over the entity's entire history). required: - slide_duration + SourceLateness: + type: object + properties: + settling_delay: + type: string + description: >- + Non-negative time to wait after a window ends before treating its + source data as complete. Training shifts the eligible evaluation + time backwards by this duration so it does not join data that would + still have been settling online. Materialization waits for the + duration to elapse before publishing the window. If unset, source + data is considered settled immediately. + description: >- + Configures when event-time data from this source is considered complete + for a Feature. StddevPopFunction: type: object properties: @@ -14179,6 +17277,27 @@ components: description: type: string description: User-provided description. + excluded_columns: + type: array + items: + type: string + description: >- + Column paths (dot notation, e.g. "value.email" for Kafka) to drop. A + path may reference a struct, in which case all of its nested fields + are dropped (e.g. "value.address" drops "value.address.city" and + "value.address.zip"). These columns are not written to the ingestion + table and cannot be referenced by any feature. They are dropped from + ingestion, backfill, and materialization. For direct schemas, each + column must exist in the relevant key or payload schema. With a + schema registry, a column can be excluded before it exists. A column + cannot also be a deduplication column in the ingestion_config. + record_type_filter: + type: string + description: >- + Optional SQL predicate to filter which record types from a streaming + channel (e.g. a topic for Kafka) belong to this Stream. Events that + do not match are not written to the ingestion table and are not used + in materialization. Example: "value.event_type = 'transaction'". update_time: type: string format: date-time @@ -14195,7 +17314,7 @@ components: description: >- A Stream is a governed UC entity representing an external streaming data source. The - source_config oneof determines the streaming platform source (e.g. Kafka, Kinesis, etc.). + source_config field determines the streaming platform source (e.g. Kafka, Kinesis). StreamArnList: type: object properties: @@ -14212,10 +17331,7 @@ components: properties: direct_mtls_config: $ref: '#/components/schemas/DirectMtlsConfig' - description: >- - Direct mTLS configuration for stream platform access. This is only - used in the short term until UC Kafka Connections support mTLS . - Once UC Kafka Connections support mTLS, this will be deprecated. + description: Direct mTLS configuration for stream platform access. uc_connection_name: type: string description: >- @@ -14290,6 +17406,13 @@ components: mode: $ref: '#/components/schemas/StreamingModeStreamingModeType' description: The type of streaming mode used by the materialization pipeline. + shuffle_partitions: + type: integer + description: >- + Number of shuffle partitions for streaming materialization of this + feature. Higher values process high-throughput features with more + parallelism at higher compute cost. Materialized features which are + computed together will use the largest value set among them. description: >- The streaming mode configuration for a streaming materialization pipeline. @@ -14329,8 +17452,30 @@ components: description: Computes the sum of values. TableTrigger: type: object - properties: {} - description: A trigger that fires when the upstream source table changes. + properties: + condition: + $ref: '#/components/schemas/TableTriggerTableTriggerCondition' + description: >- + Which source table updates trigger a materialization run. If not + set, any source table update triggers a run. + min_time_between_triggers: + type: string + description: >- + The minimum time between two triggered runs, so a frequently updated + source table does not trigger runs too often. If not set, a feature + with a sliding window uses half its slide_duration and a feature + with a tumbling window uses half its window_duration, clamped to + between 5 minutes and 1 hour. Other features have no minimum. + wait_after_last_change: + type: string + description: >- + How long the source table must go without updates before a run + starts, so a series of updates settles before the run. If not set, a + run starts as soon as the source table updates. + description: >- + A trigger that fires when the feature's source table changes: a + DeltaTableSource's table, or an + SdpSource's input_tables. TestRegistryWebhookResponse: type: object properties: @@ -14351,6 +17496,22 @@ components: description: A sawtooth window served via the hybrid batch + streaming path. sliding: $ref: '#/components/schemas/SlidingWindow' + start_time: + type: string + format: date-time + description: >- + Earliest event-time boundary at which the Feature may emit an + output. This gates outputs, not the historical inputs read by a + window. For example, a 365-day window with start_time=2026-01-01 + begins emitting partial-window values on that date instead of + waiting for 365 days of data; a lifetime window produces no output + before start_time. If unset, tumbling and fixed-duration sliding + windows first emit at an offset-aligned boundary after a full window + can be formed. If unset, lifetime sliding windows and rolling + windows emit as soon as eligible source data exists. For sawtooth + windows, start_time must not be later than the time the Feature is + created. Not supported for rolling windows on Features with a stream + source. tumbling: $ref: '#/components/schemas/TumblingWindow' TimeseriesColumn: @@ -14400,6 +17561,20 @@ components: properties: window_duration: type: string + delay: + type: string + description: >- + Non-negative analytic lag that evaluates the window this far in the + past. Use this for timing variations unrelated to source lateness, + such as a 30-day count as of one week ago. If unset, the analytic + lag is zero. It composes with source.lateness when both are set. + offset: + type: string + description: >- + Non-negative phase shift from the default midnight UTC alignment. + For example, offset=22h on a 24h window produces boundaries at 22:00 + UTC (17:00 New York in standard time) instead of midnight UTC. If + unset, the offset is zero. Must be shorter than window_duration. required: - window_duration UcTraceLocation: @@ -14538,6 +17713,15 @@ components: - ``SYSTEM_TRANSITION``: For events performed as a side effect, such as archiving existing model versions in a stage. + BackfillOperationMetadataState: + type: string + x-enum: + - CANCELLED + - FAILED + - PENDING + - RUNNING + - SUCCEEDED + description: Lifecycle state of a backfill. CommentActivityAction: type: string x-enum: @@ -14567,6 +17751,99 @@ components: - ``EDIT_COMMENT``: Edit the comment - ``DELETE_COMMENT``: Delete the comment + CronScheduleMode: + type: string + x-enum: + - DERIVED + - MANUAL + description: The way a materialization schedule is arrived at. + ErrorCode: + type: string + x-enum: + - ABORTED + - ALREADY_EXISTS + - BAD_REQUEST + - CANCELLED + - CATALOG_ALREADY_EXISTS + - CATALOG_DOES_NOT_EXIST + - CATALOG_NOT_EMPTY + - COULD_NOT_ACQUIRE_LOCK + - CUSTOMER_UNAUTHORIZED + - DAC_ALREADY_EXISTS + - DAC_DOES_NOT_EXIST + - DATA_LOSS + - DEADLINE_EXCEEDED + - DEPLOYMENT_TIMEOUT + - DIRECTORY_NOT_EMPTY + - DIRECTORY_PROTECTED + - DRY_RUN_FAILED + - ENDPOINT_NOT_FOUND + - EXTERNAL_LOCATION_ALREADY_EXISTS + - EXTERNAL_LOCATION_DOES_NOT_EXIST + - FEATURE_DISABLED + - GIT_CONFLICT + - GIT_REMOTE_ERROR + - GIT_SENSITIVE_TOKEN_DETECTED + - GIT_UNKNOWN_REF + - GIT_URL_NOT_ON_ALLOW_LIST + - INSECURE_PARTNER_RESPONSE + - INTERNAL_ERROR + - INVALID_PARAMETER_VALUE + - INVALID_STATE + - INVALID_STATE_TRANSITION + - IO_ERROR + - IPYNB_FILE_IN_REPO + - MALFORMED_PARTNER_RESPONSE + - MALFORMED_REQUEST + - MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST + - MAX_BLOCK_SIZE_EXCEEDED + - MAX_CHILD_NODE_SIZE_EXCEEDED + - MAX_LIST_SIZE_EXCEEDED + - MAX_NOTEBOOK_SIZE_EXCEEDED + - MAX_READ_SIZE_EXCEEDED + - METASTORE_ALREADY_EXISTS + - METASTORE_DOES_NOT_EXIST + - METASTORE_NOT_EMPTY + - NOT_FOUND + - NOT_IMPLEMENTED + - PARTIAL_DELETE + - PERMISSION_DENIED + - PERMISSION_NOT_PROPAGATED + - PRINCIPAL_DOES_NOT_EXIST + - PROJECTS_OPERATION_TIMEOUT + - PROVIDER_ALREADY_EXISTS + - PROVIDER_DOES_NOT_EXIST + - PROVIDER_SHARE_NOT_ACCESSIBLE + - QUOTA_EXCEEDED + - RECIPIENT_ALREADY_EXISTS + - RECIPIENT_DOES_NOT_EXIST + - REQUEST_LIMIT_EXCEEDED + - RESOURCE_ALREADY_EXISTS + - RESOURCE_CONFLICT + - RESOURCE_DOES_NOT_EXIST + - RESOURCE_EXHAUSTED + - RESOURCE_LIMIT_EXCEEDED + - SCHEMA_ALREADY_EXISTS + - SCHEMA_DOES_NOT_EXIST + - SCHEMA_NOT_EMPTY + - SEARCH_QUERY_TOO_LONG + - SEARCH_QUERY_TOO_SHORT + - SERVICE_UNDER_MAINTENANCE + - SHARE_ALREADY_EXISTS + - SHARE_DOES_NOT_EXIST + - STORAGE_CREDENTIAL_ALREADY_EXISTS + - STORAGE_CREDENTIAL_DOES_NOT_EXIST + - TABLE_ALREADY_EXISTS + - TABLE_DOES_NOT_EXIST + - TEMPORARILY_UNAVAILABLE + - UNAUTHENTICATED + - UNAVAILABLE + - UNKNOWN + - UNPARSEABLE_HTTP_ERROR + - WORKSPACE_TEMPORARILY_UNAVAILABLE + description: >- + Error codes returned by Databricks APIs to indicate specific failure + conditions. ExperimentPermissionLevel: type: string x-enum: @@ -14619,27 +17896,119 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - FunctionFunctionType: + FunctionFunctionType: + type: string + x-enum: + - APPROX_COUNT_DISTINCT + - APPROX_PERCENTILE + - AVG + - COUNT + - FIRST + - FUNCTION_TYPE_UNSPECIFIED + - LAST + - MAX + - MIN + - STDDEV_POP + - STDDEV_SAMP + - SUM + - VAR_POP + - VAR_SAMP + description: |- + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + IssueSeverity: type: string x-enum: - - APPROX_COUNT_DISTINCT - - APPROX_PERCENTILE - - AVG - - COUNT - - FIRST - - LAST - - MAX - - MIN - - STDDEV_POP - - STDDEV_SAMP - - SUM - - VAR_POP - - VAR_SAMP + - HIGH + - LOW + - MEDIUM + description: How serious an Issue is, ordered LOW < MEDIUM < HIGH. + IssueSortKey: + type: string + x-enum: + - CREATE_TIME + - LAST_SEEN_TIME + - SEVERITY + - UPDATE_TIME description: >- - Deprecated: Use the function-specific messages in - AggregationFunction.function_type oneof + The field that search results are ordered by. SEVERITY breaks ties by + last_seen_time, in the - instead. Kept for backwards compatibility. + same direction. Results are grouped by status first (PENDING, RESOLVED, + then REJECTED, whatever + + the sort_order), and remaining ties are broken by issue ID, so paging is + stable. + IssueSourceType: + type: string + x-enum: + - ADHOC_RUN + - MANUAL + - SCHEDULED_RUN + - SINGLE_TRACE_ANALYSIS + description: >- + What created an Issue: ADHOC_RUN, an issue detection run started on + demand; SCHEDULED_RUN, one + + started by a schedule; SINGLE_TRACE_ANALYSIS, an analysis of a single + trace; or MANUAL, a + + person. + IssueStatus: + type: string + x-enum: + - PENDING + - REJECTED + - RESOLVED + description: >- + The triage status of an Issue: PENDING means open and awaiting triage, + RESOLVED means judged + + real and addressed, and REJECTED means judged not to be an issue. + IssueView: + type: string + x-enum: + - BASIC + - FULL + description: >- + Which fields each search result includes: BASIC has every field except + ``description``, and may + + omit large ``metadata`` entries; FULL has every field. LoggedModelStatus: type: string x-enum: @@ -14647,6 +18016,15 @@ components: - LOGGED_MODEL_READY - LOGGED_MODEL_UPLOAD_FAILED description: A LoggedModelStatus enum value represents the status of a logged model. + MaterializationSetOperationMetadataState: + type: string + x-enum: + - CANCELLED + - FAILED + - PENDING + - RUNNING + - SUCCEEDED + description: Lifecycle state of a materialization set operation. MaterializedFeaturePipelineScheduleState: type: string x-enum: @@ -14766,7 +18144,9 @@ components: Permission level of the requesting user on the object. For what is allowed at each level, see - [MLflow Model permissions](..). + `MLflow Model permissions + + `__. PublishSpecPublishMode: type: string x-enum: @@ -14810,6 +18190,22 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + PurgeFeatureEntitiesMetadataState: + type: string + x-enum: + - CANCELLED + - FAILED + - PENDING + - RUNNING + - SUCCEEDED + description: Lifecycle state of a feature entity purge. + PurgeFeatureEntitiesResultState: + type: string + x-enum: + - FAILED + - NOT_APPLICABLE + - SUCCEEDED + description: Terminal state of a purge for one store type. RegisteredModelPermissionLevel: type: string x-enum: @@ -14947,6 +18343,21 @@ components: - FORMAT_JSON - FORMAT_PROTOBUF description: Supported serialization formats for a schema registry schema. + SdpSourceState: + type: string + x-enum: + - ERROR + - PENDING + - RESOLVED + description: >- + State of the SDP source relative to pipeline execution and output table + validation. + SortOrder: + type: string + x-enum: + - ASCENDING + - DESCENDING + description: The direction of the ordering. Status: type: string x-enum: @@ -15006,6 +18417,12 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + TableTriggerTableTriggerCondition: + type: string + x-enum: + - TABLE_TRIGGER_CONDITION_ALL_UPDATED + - TABLE_TRIGGER_CONDITION_ANY_UPDATED + description: Which source table updates trigger a materialization run. UpdateRunStatus: type: string x-enum: @@ -15111,6 +18528,53 @@ components: update: [] delete: [] replace: [] + experiment_issues: + id: databricks_workspace.ml.experiment_issues + name: experiment_issues + title: Experiment Issues + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1mlflow~1experiments~1{experiment}~1issues/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1mlflow~1experiments~1{experiment}~1issues~1{issue}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1api~12.0~1mlflow~1experiments~1{experiment}~1issues~1{issue}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + search: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1mlflow~1experiments~1{experiment}~1issues:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiment_issues/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/experiment_issues/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/experiment_issues/methods/update' + delete: [] + replace: [] logged_models: id: databricks_workspace.ml.logged_models name: logged_models @@ -15153,13 +18617,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get_batch: - operation: - $ref: '#/paths/~1api~12.0~1mlflow~1logged-models:batchGet/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.models log_params: config: requestBodyTranslate: @@ -15190,7 +18647,6 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/logged_models/methods/get' - - $ref: '#/components/x-stackQL-resources/logged_models/methods/get_batch' insert: - $ref: '#/components/x-stackQL-resources/logged_models/methods/create' update: [] @@ -15454,18 +18910,17 @@ components: update: [] delete: [] replace: [] - feature_materialized: - id: databricks_workspace.ml.feature_materialized - name: feature_materialized - title: Feature Materialized + feature_engineering: + id: databricks_workspace.ml.feature_engineering + name: feature_engineering + title: Feature Engineering methods: - batch_create: + backfill_features: config: requestBodyTranslate: algorithm: naive operation: - $ref: >- - #/paths/~1api~12.0~1feature-engineering~1materialized-features:batchCreate/post + $ref: '#/paths/~1api~12.0~1feature-engineering~1features:backfill/post' response: mediaType: application/json openAPIDocKey: '200' @@ -15474,29 +18929,27 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: >- - #/paths/~1api~12.0~1feature-engineering~1materialized-features/post + $ref: '#/paths/~1api~12.0~1feature-engineering~1features/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1feature-engineering~1materialized-features/get' + $ref: '#/paths/~1api~12.0~1feature-engineering~1features/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.materialized_features + objectKey: $.features delete: operation: $ref: >- - #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/delete + #/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: >- - #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/get + $ref: '#/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -15506,55 +18959,77 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/patch + #/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + purge_feature_entities: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1features:purgeFeatureEntities/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_materialized/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_materialized/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_engineering/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_engineering/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/feature_materialized/methods/create + #/components/x-stackQL-resources/feature_engineering/methods/create update: - $ref: >- - #/components/x-stackQL-resources/feature_materialized/methods/update + #/components/x-stackQL-resources/feature_engineering/methods/update delete: - $ref: >- - #/components/x-stackQL-resources/feature_materialized/methods/delete + #/components/x-stackQL-resources/feature_engineering/methods/delete replace: [] - feature_engineering: - id: databricks_workspace.ml.feature_engineering - name: feature_engineering - title: Feature Engineering + feature_materialized: + id: databricks_workspace.ml.feature_materialized + name: feature_materialized + title: Feature Materialized methods: + batch_create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialized-features:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1feature-engineering~1features/post' + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialized-features/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1feature-engineering~1features/get' + $ref: '#/paths/~1api~12.0~1feature-engineering~1materialized-features/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.features + objectKey: $.materialized_features delete: operation: $ref: >- - #/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/delete + #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/get' + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -15564,23 +19039,48 @@ components: algorithm: naive operation: $ref: >- - #/paths/~1api~12.0~1feature-engineering~1features~1{full_name}/patch + #/paths/~1api~12.0~1feature-engineering~1materialized-features~1{materialized_feature_id}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_engineering/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_engineering/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_materialized/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_materialized/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/feature_engineering/methods/create + #/components/x-stackQL-resources/feature_materialized/methods/create update: - $ref: >- - #/components/x-stackQL-resources/feature_engineering/methods/update + #/components/x-stackQL-resources/feature_materialized/methods/update delete: - $ref: >- - #/components/x-stackQL-resources/feature_engineering/methods/delete + #/components/x-stackQL-resources/feature_materialized/methods/delete + replace: [] + feature_engineering_operations: + id: databricks_workspace.ml.feature_engineering_operations + name: feature_engineering_operations + title: Feature Engineering Operations + methods: + cancel: + operation: + $ref: '#/paths/~1api~12.0~1feature-engineering~1{name}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1feature-engineering~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_engineering_operations/methods/get + insert: [] + update: [] + delete: [] replace: [] feature_kafka_configs: id: databricks_workspace.ml.feature_kafka_configs @@ -15644,6 +19144,58 @@ components: - $ref: >- #/components/x-stackQL-resources/feature_kafka_configs/methods/delete replace: [] + feature_materialization_sets: + id: databricks_workspace.ml.feature_materialization_sets + name: feature_materialization_sets + title: Feature Materialization Sets + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1feature-engineering~1materialization-sets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialization-sets~1{materialization_set_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialization-sets~1{materialization_set_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1feature-engineering~1materialization-sets~1{materialization_set_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_materialization_sets/methods/get + insert: + - $ref: >- + #/components/x-stackQL-resources/feature_materialization_sets/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/feature_materialization_sets/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/feature_materialization_sets/methods/delete + replace: [] feature_engineering_streams: id: databricks_workspace.ml.feature_engineering_streams name: feature_engineering_streams diff --git a/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml b/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml index af68ea17..ad683741 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.oauth2 servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/accounts/servicePrincipals/{service_principal_id}/credentials/secrets: post: @@ -209,20 +226,9 @@ components: description: >- OAuth client-secret generated by the Databricks. If this is a confidential OAuth app client-secret will be generated. - client_secret_expire_time: - type: string - format: date-time - description: >- - The expiration time of the client secret. If not present, the secret - does not expire. integration_id: type: string description: Unique integration id for the custom OAuth app - principal_id: - type: integer - description: >- - The principal id of the service principal associated with this OAuth - app. CreatePublishedAppIntegrationOutput: type: object properties: @@ -287,6 +293,10 @@ components: request URL. oidc_policy: $ref: '#/components/schemas/OidcFederationPolicy' + description: >- + audit_mode INCLUDE is required on both this message field and its + leaf fields so the OIDC policy configuration is captured in + create/update audit logs (see go/auditlogs). policy_id: type: string description: The ID of the federation policy. Output only. @@ -323,11 +333,6 @@ components: name: type: string description: The display name of the custom OAuth app - principal_id: - type: integer - description: >- - The principal id of the service principal associated with this OAuth - app. redirect_urls: type: array items: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml b/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml index 617179bb..12915b5d 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.pipelines servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/pipelines/{pipeline_id}/environment/apply: post: @@ -93,15 +110,22 @@ paths: :param clone_mode: :class:`CloneMode` (optional) The type of clone to perform. Currently, only deep copies are supported :param clusters: List[:class:`PipelineCluster`] (optional) - Cluster settings for this pipeline deployment. + Cluster settings for this pipeline deployment. Applies to classic (non-serverless) pipelines. Omit + this field when ``serverless`` is ``true``. :param configuration: Dict[str,str] (optional) String-String configuration for this pipeline execution. :param continuous: bool (optional) Whether the pipeline is continuous or triggered. This replaces ``trigger``. + + Deprecated: wrap the pipeline in a continuous job instead, which also lets you take advantage of + job-level settings such as performance mode. When the pipeline is started by a continuous job, the + job's setting takes precedence and this field is ignored. :param deployment: :class:`PipelineDeployment` (optional) Deployment type of this pipeline. :param development: bool (optional) Whether the pipeline is in Development mode. Defaults to false. + + Deprecated: set development mode for each update instead. :param edition: str (optional) Pipeline product edition. :param environment: :class:`PipelinesEnvironment` (optional) @@ -128,12 +152,14 @@ paths: Friendly identifier for this pipeline. :param notifications: List[:class:`Notifications`] (optional) List of notification settings for this pipeline. + :param parent_path: str (optional) + Path of the pipeline parent folder in workspace file tree. + + If absent, the pipeline doesn't have a workspace object. :param photon: bool (optional) Whether Photon is enabled for this pipeline. :param restart_window: :class:`RestartWindow` (optional) Restart window of this pipeline. - :param rewind_generation_interval: :class:`PeriodicTrigger` (optional) - Interval at which rewind points are generated during pipeline execution. :param root_path: str (optional) Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline @@ -141,7 +167,10 @@ paths: :param schema: str (optional) The default schema (database) where tables are read from or published to. :param serverless: bool (optional) - Whether serverless compute is enabled for this pipeline. + Whether serverless compute is enabled for this pipeline. Serverless is the recommended compute for + new pipelines; set this to ``true`` to run the pipeline on serverless. For notebook/file pipelines, + omitting this field uses classic compute configured through the ``clusters`` field. When ``true``, + omit ``clusters``; Photon is always enabled. :param serverless_compute_id: str (optional) Serverless compute ID specified by the user for serverless pipelines. :param storage: str (optional) @@ -314,7 +343,9 @@ paths: type: string description: >- A label for the cluster specification, either - ``default`` to configure the default cluster, or + ``default`` to configure the default cluster settings + applied to both the update and maintenance clusters, + ``updates`` to configure the update cluster, or ``maintenance`` to configure the maintenance cluster. This field is optional. The default value is ``default``. @@ -381,7 +412,10 @@ paths: keys can be used to login with the user name ``ubuntu`` on port ``2200``. Up to 10 keys can be specified. - description: Cluster settings for this pipeline deployment. + description: >- + Cluster settings for this pipeline deployment. Applies to + classic (non-serverless) pipelines. Omit this field when + ``serverless`` is ``true``. configuration: type: object description: String-String configuration for this pipeline execution. @@ -389,7 +423,11 @@ paths: type: boolean description: >- Whether the pipeline is continuous or triggered. This - replaces ``trigger``. + replaces ``trigger``. Deprecated: wrap the pipeline in a + continuous job instead, which also lets you take advantage + of job-level settings such as performance mode. When the + pipeline is started by a continuous job, the job's setting + takes precedence and this field is ignored. deployment: type: object properties: @@ -429,7 +467,8 @@ paths: type: boolean description: >- Whether the pipeline is in Development mode. Defaults to - false. + false. Deprecated: set development mode for each update + instead. edition: type: string description: Pipeline product edition. @@ -867,17 +906,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -949,11 +977,8 @@ paths: schema: type: object properties: - source_schema: - type: string destination_catalog: type: string - description: Required. Destination catalog to store tables. destination_schema: type: string description: >- @@ -962,32 +987,9 @@ paths: tables are created in this destination schema. The pipeline fails If a table with the same name already exists. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. connector_options: type: object properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion api_source_connector_options: type: object properties: @@ -999,127 +1001,6 @@ paths: description: >- Connector-specific options for API Source connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. - description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the community connector. - description: >- - Options for community connectors with - arbitrary configuration. confluence_options: type: object properties: @@ -1139,8 +1020,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -1230,7 +1109,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -1272,54 +1150,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -1419,22 +1252,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -1558,7 +1375,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -1606,17 +1423,6 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. starting_offset: type: string description: >- @@ -1755,7 +1561,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -2014,6 +1820,96 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion + onedrive_options: + type: object + properties: + entity_type: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. outlook_options: type: object properties: @@ -2189,8 +2085,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -2281,7 +2175,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -2615,7 +2508,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -2667,21 +2560,20 @@ paths: per-record routing key. The key value becomes the table name: {destination_catalog}.{destination_schema}.{key_value}. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- The source catalog name. Might be optional depending on the type of source. + source_schema: + type: string + description: >- + Schema name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -2868,17 +2760,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -2945,47 +2826,20 @@ paths: override the table_configuration defined in the IngestionPipelineDefinition object. required: - - source_schema - destination_catalog - destination_schema description: Select all tables from a specific source schema. table: type: object properties: - source_table: - type: string destination_catalog: type: string - description: Required. Destination catalog to store table. destination_schema: type: string description: Required. Destination schema to store table. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. connector_options: type: object properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion api_source_connector_options: type: object properties: @@ -2997,127 +2851,6 @@ paths: description: >- Connector-specific options for API Source connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. - description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the community connector. - description: >- - Options for community connectors with - arbitrary configuration. confluence_options: type: object properties: @@ -3137,8 +2870,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -3228,7 +2959,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -3270,54 +3000,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -3417,22 +3102,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -3556,7 +3225,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -3604,18 +3273,7 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. - starting_offset: + starting_offset: type: string description: >- (Optional) Where to begin reading when @@ -3753,7 +3411,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -4012,6 +3670,96 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion + onedrive_options: + type: object + properties: + entity_type: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. outlook_options: type: object properties: @@ -4187,8 +3935,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -4279,7 +4025,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -4490,16 +4235,6 @@ paths: fails if a table with that name already exists. If not set, the source table name is used. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- @@ -4510,6 +4245,15 @@ paths: description: >- Schema name in the source database. Might be optional depending on the type of source. + source_table: + type: string + description: >- + Table name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -4696,17 +4440,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -4773,7 +4506,6 @@ paths: IngestionPipelineDefinition object and the SchemaSpec. required: - - source_table - destination_catalog - destination_schema description: Select a specific source table. @@ -4834,113 +4566,30 @@ paths: source_type: type: string x-enum: - - ADOBE_CAMPAIGNS - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AKAMAI_WAF - - AMPLITUDE - - API_SOURCE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - BIGQUERY - - BING_ADS - - CERIDIAN_DAYFORCE - - COMMUNITY - CONFLUENCE - - CROWDSTRIKE_EVENT_STREAM - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - FOREIGN_CATALOG - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - - GITHUB - - GITLAB - - GMAIL - - GONG - - GOOGLE_ADS - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - GOOGLE_DRIVE - - GOOGLE_SEARCH_CONSOLE - - GOOGLE_WORKSPACE - - GUIDEWIRE - - GURU - - HIBOB - - HUBSPOT - - IRONCLAD - JIRA - - KAFKA - - LINEAR - - LINKEDIN_ADS - - M365_AUDIT_LOGS - MANAGED_POSTGRESQL - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MICROSOFT_TEAMS - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - NETSUITE - - NOTION - - OKTA_SYSTEM_LOGS - - ONE_PASSWORD_EVENT_LOGS + - ONEDRIVE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - - OUTLOOK - - PAGERDUTY - - PARTNERSTACK - - PENDO - - PINTEREST_ADS - POSTGRESQL - - PROOFPOINT_SIEM - - QUICKBOOKS - RABBITMQ - - REDDIT_ADS - - REDSHIFT - SALESFORCE - - SALESFORCE_MARKETING_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - SHAREPOINT - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - - SLACK_AUDIT_LOGS - SMARTSHEET - - SNAPCHAT_ADS - - SPLUNK - - SQLDW - SQLSERVER - - SQUARE - TERADATA - TIKTOK_ADS - - VEEVA - - VEEVA_VAULT - - VERKADA - - WIZ_AUDIT_LOGS - - WORKDAY_ACTIVITY_LOGGING - - WORKDAY_HCM - WORKDAY_RAAS - - X_ADS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS description: >- The type of the foreign source. The source type will be inferred from the source connection or ingestion @@ -5110,17 +4759,6 @@ paths: description: >- (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is written and - maintained in the destination table. Mutually - exclusive with scd_type — a 400 error is returned if - both are set. table_properties: type: object description: >- @@ -5242,6 +4880,11 @@ paths: A list of email addresses notified when a configured alert is triggered. description: List of notification settings for this pipeline. + parent_path: + type: string + description: >- + Path of the pipeline parent folder in workspace file tree. + If absent, the pipeline doesn't have a workspace object. photon: type: boolean description: Whether Photon is enabled for this pipeline. @@ -5280,24 +4923,6 @@ paths: required: - start_hour description: Restart window of this pipeline. - rewind_generation_interval: - type: object - properties: - interval: - type: integer - description: >- - An integer value representing the interval quantity for - the schedule. - unit: - type: string - x-enum: - - DAYS - - HOURS - - WEEKS - description: A time unit for the schedule. - description: >- - Interval at which rewind points are generated during - pipeline execution. root_path: type: string description: >- @@ -5312,7 +4937,13 @@ paths: published to. serverless: type: boolean - description: Whether serverless compute is enabled for this pipeline. + description: >- + Whether serverless compute is enabled for this pipeline. + Serverless is the recommended compute for new pipelines; set + this to ``true`` to run the pipeline on serverless. For + notebook/file pipelines, omitting this field uses classic + compute configured through the ``clusters`` field. When + ``true``, omit ``clusters``; Photon is always enabled. serverless_compute_id: type: string description: >- @@ -5401,15 +5032,22 @@ paths: :param channel: str (optional) SDP Release Channel that specifies which version to use. :param clusters: List[:class:`PipelineCluster`] (optional) - Cluster settings for this pipeline deployment. + Cluster settings for this pipeline deployment. Applies to classic (non-serverless) pipelines. Omit + this field when ``serverless`` is ``true``. :param configuration: Dict[str,str] (optional) String-String configuration for this pipeline execution. :param continuous: bool (optional) Whether the pipeline is continuous or triggered. This replaces ``trigger``. + + Deprecated: wrap the pipeline in a continuous job instead, which also lets you take advantage of + job-level settings such as performance mode. When the pipeline is started by a continuous job, the + job's setting takes precedence and this field is ignored. :param deployment: :class:`PipelineDeployment` (optional) Deployment type of this pipeline. :param development: bool (optional) Whether the pipeline is in Development mode. Defaults to false. + + Deprecated: set development mode for each update instead. :param dry_run: bool (optional) :param edition: str (optional) @@ -5438,12 +5076,14 @@ paths: :param parameters: Dict[str,str] (optional) Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + :param parent_path: str (optional) + Path of the pipeline parent folder in workspace file tree. + + If absent, the pipeline doesn't have a workspace object. :param photon: bool (optional) Whether Photon is enabled for this pipeline. :param restart_window: :class:`RestartWindow` (optional) Restart window of this pipeline. - :param rewind_generation_interval: :class:`PeriodicTrigger` (optional) - Interval at which rewind points are generated during pipeline execution. :param root_path: str (optional) Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline @@ -5453,7 +5093,10 @@ paths: :param schema: str (optional) The default schema (database) where tables are read from or published to. :param serverless: bool (optional) - Whether serverless compute is enabled for this pipeline. + Whether serverless compute is enabled for this pipeline. Serverless is the recommended compute for + new pipelines; set this to ``true`` to run the pipeline on serverless. For notebook/file pipelines, + omitting this field uses classic compute configured through the ``clusters`` field. When ``true``, + omit ``clusters``; Photon is always enabled. :param serverless_compute_id: str (optional) Serverless compute ID specified by the user for serverless pipelines. :param storage: str (optional) @@ -5612,7 +5255,9 @@ paths: type: string description: >- A label for the cluster specification, either - ``default`` to configure the default cluster, or + ``default`` to configure the default cluster settings + applied to both the update and maintenance clusters, + ``updates`` to configure the update cluster, or ``maintenance`` to configure the maintenance cluster. This field is optional. The default value is ``default``. @@ -5679,7 +5324,10 @@ paths: keys can be used to login with the user name ``ubuntu`` on port ``2200``. Up to 10 keys can be specified. - description: Cluster settings for this pipeline deployment. + description: >- + Cluster settings for this pipeline deployment. Applies to + classic (non-serverless) pipelines. Omit this field when + ``serverless`` is ``true``. configuration: type: object description: String-String configuration for this pipeline execution. @@ -5687,7 +5335,11 @@ paths: type: boolean description: >- Whether the pipeline is continuous or triggered. This - replaces ``trigger``. + replaces ``trigger``. Deprecated: wrap the pipeline in a + continuous job instead, which also lets you take advantage + of job-level settings such as performance mode. When the + pipeline is started by a continuous job, the job's setting + takes precedence and this field is ignored. deployment: type: object properties: @@ -5727,7 +5379,8 @@ paths: type: boolean description: >- Whether the pipeline is in Development mode. Defaults to - false. + false. Deprecated: set development mode for each update + instead. dry_run: type: boolean edition: @@ -6161,17 +5814,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -6243,11 +5885,8 @@ paths: schema: type: object properties: - source_schema: - type: string destination_catalog: type: string - description: Required. Destination catalog to store tables. destination_schema: type: string description: >- @@ -6256,32 +5895,9 @@ paths: tables are created in this destination schema. The pipeline fails If a table with the same name already exists. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. connector_options: type: object properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion api_source_connector_options: type: object properties: @@ -6293,127 +5909,6 @@ paths: description: >- Connector-specific options for API Source connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. - description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the community connector. - description: >- - Options for community connectors with - arbitrary configuration. confluence_options: type: object properties: @@ -6433,8 +5928,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -6524,7 +6017,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -6566,54 +6058,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -6713,22 +6160,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -6852,7 +6283,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -6900,17 +6331,6 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. starting_offset: type: string description: >- @@ -7049,7 +6469,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -7308,62 +6728,152 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion - outlook_options: + onedrive_options: type: object properties: - attachment_mode: - type: string - x-enum: - - ALL - - INLINE_ONLY - - NONE - - NON_INLINE_ONLY - description: >- - (Optional) Controls which attachments to - ingest. If not specified, defaults to - ALL. - body_format: + entity_type: type: string x-enum: - - TEXT_HTML - - TEXT_PLAIN - description: >- - (Optional) Defines how the body_content - column is populated. TEXT_HTML: - Preserves full formatting, links, and - styling. TEXT_PLAIN: Converts body to - plain text. Recommended for AI/RAG - pipelines to reduce token usage and - noise. - folder_filter: - type: array - items: - type: string - description: Deprecated. Use include_folders instead. - include_folders: - type: array - items: - type: string - description: >- - (Optional) Filter mail folders to - include in the sync. If not specified, - all folders will be synced. Examples: - Inbox, Sent Items, Custom_Folder Filter - semantics: OR between different folders. - include_mailboxes: - type: array - items: - type: string - description: >- - (Optional) List of mailboxes to sync - (e.g. mailbox email addresses or - identifiers). If not specified, all - accessible mailboxes are ingested. - Filter semantics: OR between different - mailboxes. - include_senders: - type: array - items: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. + outlook_options: + type: object + properties: + attachment_mode: + type: string + x-enum: + - ALL + - INLINE_ONLY + - NONE + - NON_INLINE_ONLY + description: >- + (Optional) Controls which attachments to + ingest. If not specified, defaults to + ALL. + body_format: + type: string + x-enum: + - TEXT_HTML + - TEXT_PLAIN + description: >- + (Optional) Defines how the body_content + column is populated. TEXT_HTML: + Preserves full formatting, links, and + styling. TEXT_PLAIN: Converts body to + plain text. Recommended for AI/RAG + pipelines to reduce token usage and + noise. + folder_filter: + type: array + items: + type: string + description: Deprecated. Use include_folders instead. + include_folders: + type: array + items: + type: string + description: >- + (Optional) Filter mail folders to + include in the sync. If not specified, + all folders will be synced. Examples: + Inbox, Sent Items, Custom_Folder Filter + semantics: OR between different folders. + include_mailboxes: + type: array + items: + type: string + description: >- + (Optional) List of mailboxes to sync + (e.g. mailbox email addresses or + identifiers). If not specified, all + accessible mailboxes are ingested. + Filter semantics: OR between different + mailboxes. + include_senders: + type: array + items: type: string description: >- (Optional) Filter emails by sender @@ -7483,8 +6993,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -7575,7 +7083,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -7909,7 +7416,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -7961,21 +7468,20 @@ paths: per-record routing key. The key value becomes the table name: {destination_catalog}.{destination_schema}.{key_value}. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- The source catalog name. Might be optional depending on the type of source. + source_schema: + type: string + description: >- + Schema name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -8162,17 +7668,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -8239,47 +7734,20 @@ paths: override the table_configuration defined in the IngestionPipelineDefinition object. required: - - source_schema - destination_catalog - destination_schema description: Select all tables from a specific source schema. table: type: object properties: - source_table: - type: string destination_catalog: type: string - description: Required. Destination catalog to store table. destination_schema: type: string description: Required. Destination schema to store table. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. connector_options: type: object properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion api_source_connector_options: type: object properties: @@ -8291,127 +7759,6 @@ paths: description: >- Connector-specific options for API Source connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. - description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the community connector. - description: >- - Options for community connectors with - arbitrary configuration. confluence_options: type: object properties: @@ -8431,8 +7778,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -8522,7 +7867,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -8564,54 +7908,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -8711,22 +8010,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -8850,7 +8133,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -8898,17 +8181,6 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. starting_offset: type: string description: >- @@ -9047,7 +8319,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -9306,6 +8578,96 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion + onedrive_options: + type: object + properties: + entity_type: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. outlook_options: type: object properties: @@ -9481,8 +8843,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -9573,7 +8933,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -9784,16 +9143,6 @@ paths: fails if a table with that name already exists. If not set, the source table name is used. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- @@ -9804,6 +9153,15 @@ paths: description: >- Schema name in the source database. Might be optional depending on the type of source. + source_table: + type: string + description: >- + Table name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -9990,17 +9348,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -10067,7 +9414,6 @@ paths: IngestionPipelineDefinition object and the SchemaSpec. required: - - source_table - destination_catalog - destination_schema description: Select a specific source table. @@ -10128,113 +9474,30 @@ paths: source_type: type: string x-enum: - - ADOBE_CAMPAIGNS - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AKAMAI_WAF - - AMPLITUDE - - API_SOURCE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - BIGQUERY - - BING_ADS - - CERIDIAN_DAYFORCE - - COMMUNITY - CONFLUENCE - - CROWDSTRIKE_EVENT_STREAM - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - FOREIGN_CATALOG - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - - GITHUB - - GITLAB - - GMAIL - - GONG - - GOOGLE_ADS - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - GOOGLE_DRIVE - - GOOGLE_SEARCH_CONSOLE - - GOOGLE_WORKSPACE - - GUIDEWIRE - - GURU - - HIBOB - - HUBSPOT - - IRONCLAD - JIRA - - KAFKA - - LINEAR - - LINKEDIN_ADS - - M365_AUDIT_LOGS - MANAGED_POSTGRESQL - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MICROSOFT_TEAMS - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - NETSUITE - - NOTION - - OKTA_SYSTEM_LOGS - - ONE_PASSWORD_EVENT_LOGS + - ONEDRIVE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - - OUTLOOK - - PAGERDUTY - - PARTNERSTACK - - PENDO - - PINTEREST_ADS - POSTGRESQL - - PROOFPOINT_SIEM - - QUICKBOOKS - RABBITMQ - - REDDIT_ADS - - REDSHIFT - SALESFORCE - - SALESFORCE_MARKETING_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - SHAREPOINT - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - - SLACK_AUDIT_LOGS - SMARTSHEET - - SNAPCHAT_ADS - - SPLUNK - - SQLDW - SQLSERVER - - SQUARE - TERADATA - TIKTOK_ADS - - VEEVA - - VEEVA_VAULT - - VERKADA - - WIZ_AUDIT_LOGS - - WORKDAY_ACTIVITY_LOGGING - - WORKDAY_HCM - WORKDAY_RAAS - - X_ADS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS description: >- The type of the foreign source. The source type will be inferred from the source connection or ingestion @@ -10404,17 +9667,6 @@ paths: description: >- (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is written and - maintained in the destination table. Mutually - exclusive with scd_type — a 400 error is returned if - both are set. table_properties: type: object description: >- @@ -10541,6 +9793,11 @@ paths: description: >- Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + parent_path: + type: string + description: >- + Path of the pipeline parent folder in workspace file tree. + If absent, the pipeline doesn't have a workspace object. photon: type: boolean description: Whether Photon is enabled for this pipeline. @@ -10579,24 +9836,6 @@ paths: required: - start_hour description: Restart window of this pipeline. - rewind_generation_interval: - type: object - properties: - interval: - type: integer - description: >- - An integer value representing the interval quantity for - the schedule. - unit: - type: string - x-enum: - - DAYS - - HOURS - - WEEKS - description: A time unit for the schedule. - description: >- - Interval at which rewind points are generated during - pipeline execution. root_path: type: string description: >- @@ -10607,6 +9846,14 @@ paths: run_as: type: object properties: + group_name: + type: string + description: >- + Group name of an account group assigned to the + workspace. When set, the pipeline runs as the group and + the group's permissions are used for data access. + Setting this field requires being a member of the group, + or having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -10632,7 +9879,13 @@ paths: published to. serverless: type: boolean - description: Whether serverless compute is enabled for this pipeline. + description: >- + Whether serverless compute is enabled for this pipeline. + Serverless is the recommended compute for new pipelines; set + this to ``true`` to run the pipeline on serverless. For + notebook/file pipelines, omitting this field uses classic + compute configured through the ``clusters`` field. When + ``true``, omit ``clusters``; Photon is always enabled. serverless_compute_id: type: string description: >- @@ -10712,12 +9965,12 @@ paths: Composite filters are not supported. This field is optional. :param max_results: int (optional) The maximum number of entries to return in a single page. The system may return fewer than - max_results events in a response, even if there are more events available. This field is optional. - The default value is 25. The maximum value is 100. An error is returned if the value of max_results - is greater than 100. + max_results pipelines in a response, even if there are more pipelines available. This field is + optional. The default value is 25. The maximum value is 100. An error is returned if the value of + max_results is greater than 100. :param order_by: List[str] (optional) - A list of strings specifying the order of results. Supported order_by fields are id and name. The - default is id asc. This field is optional. + A list of strings specifying the order of results. The supported order_by field is id. The default + is id asc. This field is optional. :param page_token: str (optional) Page token returned by previous call @@ -10742,10 +9995,10 @@ paths: type: integer description: >- The maximum number of entries to return in a single page. The system - may return fewer than max_results events in a response, even if - there are more events available. This field is optional. The default - value is 25. The maximum value is 100. An error is returned if the - value of max_results is greater than 100. + may return fewer than max_results pipelines in a response, even if + there are more pipelines available. This field is optional. The + default value is 25. The maximum value is 100. An error is returned + if the value of max_results is greater than 100. - name: order_by in: query required: false @@ -10754,9 +10007,8 @@ paths: items: type: string description: >- - A list of strings specifying the order of results. Supported - order_by fields are id and name. The default is id asc. This field - is optional. + A list of strings specifying the order of results. The supported + order_by field is id. The default is id asc. This field is optional. - name: page_token in: query required: false @@ -10803,8 +10055,6 @@ paths: :param cascade: bool (optional) If false, pipeline deletion will not cascade to its datasets (MVs, STs, Views). By default, this parameter will be true and all tables will be deleted with the pipeline. - :param delete_datasets: bool (optional) - Deprecated: Use ``cascade`` instead. :param force: bool (optional) If true, deletion will proceed even if resource cleanup fails. By default, deletion will fail if resources cleanup is required but fails. @@ -10823,12 +10073,6 @@ paths: If false, pipeline deletion will not cascade to its datasets (MVs, STs, Views). By default, this parameter will be true and all tables will be deleted with the pipeline. - - name: delete_datasets - in: query - required: false - schema: - type: boolean - description: 'Deprecated: Use ``cascade`` instead.' - name: force in: query required: false @@ -10912,15 +10156,22 @@ paths: :param channel: str (optional) SDP Release Channel that specifies which version to use. :param clusters: List[:class:`PipelineCluster`] (optional) - Cluster settings for this pipeline deployment. + Cluster settings for this pipeline deployment. Applies to classic (non-serverless) pipelines. Omit + this field when ``serverless`` is ``true``. :param configuration: Dict[str,str] (optional) String-String configuration for this pipeline execution. :param continuous: bool (optional) Whether the pipeline is continuous or triggered. This replaces ``trigger``. + + Deprecated: wrap the pipeline in a continuous job instead, which also lets you take advantage of + job-level settings such as performance mode. When the pipeline is started by a continuous job, the + job's setting takes precedence and this field is ignored. :param deployment: :class:`PipelineDeployment` (optional) Deployment type of this pipeline. :param development: bool (optional) Whether the pipeline is in Development mode. Defaults to false. + + Deprecated: set development mode for each update instead. :param edition: str (optional) Pipeline product edition. :param environment: :class:`PipelinesEnvironment` (optional) @@ -10950,12 +10201,14 @@ paths: :param parameters: Dict[str,str] (optional) Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + :param parent_path: str (optional) + Path of the pipeline parent folder in workspace file tree. + + If absent, the pipeline doesn't have a workspace object. :param photon: bool (optional) Whether Photon is enabled for this pipeline. :param restart_window: :class:`RestartWindow` (optional) Restart window of this pipeline. - :param rewind_generation_interval: :class:`PeriodicTrigger` (optional) - Interval at which rewind points are generated during pipeline execution. :param root_path: str (optional) Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline @@ -10965,7 +10218,10 @@ paths: :param schema: str (optional) The default schema (database) where tables are read from or published to. :param serverless: bool (optional) - Whether serverless compute is enabled for this pipeline. + Whether serverless compute is enabled for this pipeline. Serverless is the recommended compute for + new pipelines; set this to ``true`` to run the pipeline on serverless. For notebook/file pipelines, + omitting this field uses classic compute configured through the ``clusters`` field. When ``true``, + omit ``clusters``; Photon is always enabled. :param serverless_compute_id: str (optional) Serverless compute ID specified by the user for serverless pipelines. :param storage: str (optional) @@ -11129,7 +10385,9 @@ paths: type: string description: >- A label for the cluster specification, either - ``default`` to configure the default cluster, or + ``default`` to configure the default cluster settings + applied to both the update and maintenance clusters, + ``updates`` to configure the update cluster, or ``maintenance`` to configure the maintenance cluster. This field is optional. The default value is ``default``. @@ -11196,7 +10454,10 @@ paths: keys can be used to login with the user name ``ubuntu`` on port ``2200``. Up to 10 keys can be specified. - description: Cluster settings for this pipeline deployment. + description: >- + Cluster settings for this pipeline deployment. Applies to + classic (non-serverless) pipelines. Omit this field when + ``serverless`` is ``true``. configuration: type: object description: String-String configuration for this pipeline execution. @@ -11204,7 +10465,11 @@ paths: type: boolean description: >- Whether the pipeline is continuous or triggered. This - replaces ``trigger``. + replaces ``trigger``. Deprecated: wrap the pipeline in a + continuous job instead, which also lets you take advantage + of job-level settings such as performance mode. When the + pipeline is started by a continuous job, the job's setting + takes precedence and this field is ignored. deployment: type: object properties: @@ -11244,7 +10509,8 @@ paths: type: boolean description: >- Whether the pipeline is in Development mode. Defaults to - false. + false. Deprecated: set development mode for each update + instead. edition: type: string description: Pipeline product edition. @@ -11682,17 +10948,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -11764,11 +11019,8 @@ paths: schema: type: object properties: - source_schema: - type: string destination_catalog: type: string - description: Required. Destination catalog to store tables. destination_schema: type: string description: >- @@ -11777,32 +11029,9 @@ paths: tables are created in this destination schema. The pipeline fails If a table with the same name already exists. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. - connector_options: - type: object - properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion + connector_options: + type: object + properties: api_source_connector_options: type: object properties: @@ -11814,127 +11043,6 @@ paths: description: >- Connector-specific options for API Source connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. - description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the community connector. - description: >- - Options for community connectors with - arbitrary configuration. confluence_options: type: object properties: @@ -11954,8 +11062,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -12045,7 +11151,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -12087,54 +11192,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -12234,22 +11294,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -12373,7 +11417,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -12421,17 +11465,6 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. starting_offset: type: string description: >- @@ -12570,7 +11603,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -12829,6 +11862,96 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion + onedrive_options: + type: object + properties: + entity_type: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. outlook_options: type: object properties: @@ -13004,8 +12127,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -13096,7 +12217,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -13430,7 +12550,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -13482,21 +12602,20 @@ paths: per-record routing key. The key value becomes the table name: {destination_catalog}.{destination_schema}.{key_value}. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- The source catalog name. Might be optional depending on the type of source. + source_schema: + type: string + description: >- + Schema name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -13683,17 +12802,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -13738,201 +12846,53 @@ paths: Value for the report parameter. Possible values it can take are these sql functions: 1. coalesce(current_offset(), - date("YYYY-MM-DD")) -> if - current_offset() is null, then the - passed date, else current_offset() 2. - current_date() 3. - date_sub(current_date(), x) -> subtract - x (some non-negative integer) days from - current date - description: >- - (Optional) Additional custom parameters - for Workday Report This field is - deprecated and should not be used. Use - ``parameters`` instead. - description: >- - (Optional) Additional custom parameters - for Workday Report - description: >- - Configuration settings to control the - ingestion of tables. These settings are - applied to all tables in this schema and - override the table_configuration defined in - the IngestionPipelineDefinition object. - required: - - source_schema - - destination_catalog - - destination_schema - description: Select all tables from a specific source schema. - table: - type: object - properties: - source_table: - type: string - destination_catalog: - type: string - description: Required. Destination catalog to store table. - destination_schema: - type: string - description: Required. Destination schema to store table. - confluence_options: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use - connector_options.confluence_options instead. - connector_options: - type: object - properties: - akamai_options: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration - IDs to ingest data from. A config ID is - a unique identifier for a security - configuration used to generate WAF logs. - description: Akamai specific options for ingestion - api_source_connector_options: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration - options for the API Source connector. - description: >- - Connector-specific options for API Source - connectors. - bing_ads_options: - type: object - properties: - custom_report_options: - type: object - properties: - report_type: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: >- - (Required) Microsoft Advertising report - type (e.g. CampaignPerformance, - KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the - report, given as Microsoft Advertising - column enum values for the selected - report type (e.g. AccountId, - CampaignName, TimePeriod, Impressions, - Clicks, Spend). Required key columns are - always included. Available columns are - report-type-specific. For the full list - supported by a given report type, see - its column value set (substitute the - report name, e.g. campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: >- - (Optional) Time granularity for report - aggregation. Defaults to DAILY. - required: - - report_type - - columns - description: >- - (Optional) Custom report definition. - When set, the table is treated as a - user-defined Bing Ads custom report. - When unset, the table must match one of - the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back - during incremental sync to capture - late-arriving conversion and attribution - data. If not specified, defaults to 7 - days. - sync_start_date: - type: string + date("YYYY-MM-DD")) -> if + current_offset() is null, then the + passed date, else current_offset() 2. + current_date() 3. + date_sub(current_date(), x) -> subtract + x (some non-negative integer) days from + current date description: >- - (Optional) Start date for the initial - sync in YYYY-MM-DD format. If not - specified, defaults to 2 years before - today. + (Optional) Additional custom parameters + for Workday Report This field is + deprecated and should not be used. Use + ``parameters`` instead. description: >- - Bing Ads specific options for ingestion - pipelines. - community_connector_options: + (Optional) Additional custom parameters + for Workday Report + description: >- + Configuration settings to control the + ingestion of tables. These settings are + applied to all tables in this schema and + override the table_configuration defined in + the IngestionPipelineDefinition object. + required: + - destination_catalog + - destination_schema + description: Select all tables from a specific source schema. + table: + type: object + properties: + destination_catalog: + type: string + destination_schema: + type: string + description: Required. Destination schema to store table. + connector_options: + type: object + properties: + api_source_connector_options: type: object properties: options: type: object description: >- Arbitrary key-value configuration - options for the community connector. + options for the API Source connector. description: >- - Options for community connectors with - arbitrary configuration. + Connector-specific options for API Source + connectors. confluence_options: type: object properties: @@ -13952,8 +12912,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: >- Create a collection of name/value pairs. @@ -14043,7 +13001,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -14085,54 +13042,9 @@ paths: https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints single_variant_column: type: string - scope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: >- - The scope of the Google Drive ingestion. - **ONLY ONE** of scope or url must be - specified. If scope is specified, we - will ingest files from the scope. If url - is specified, we will ingest files from - the url. url: type: string description: Google Drive URL. - github_options: - type: object - properties: - repository_branch_selections: - type: array - items: - type: object - properties: - repository_id: - type: string - description: >- - (Required) GitHub repository id - (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this - repository, e.g. ["main", "dev"]. - required: - - repository_id - description: >- - A repository and the branches to ingest - for it. - description: >- - (Optional) Branches to ingest per - repository. A repository not listed here - is ingested on its default branch. - description: GitHub-specific ingestion options. google_ads_options: type: object properties: @@ -14232,22 +13144,6 @@ paths: description: >- (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads - Jira's audit log to detect changes for - the tables it ingests. Reading the audit - log requires a paid Jira plan and - appropriate admin permissions. For - example, the issues table uses the audit - log to detect and propagate deletes: - when true, rows deleted in Jira are - removed from the destination table; when - false, the destination retains all - previously ingested rows and only - reflects inserts and updates. If not - specified, defaults to false. description: Jira specific options for ingestion kafka_options: type: object @@ -14371,7 +13267,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -14419,17 +13315,6 @@ paths: Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset - ranges are bin-packed into Spark input - partitions. Defaults to "auto" when - unset, which lets the engine choose the - input partition count from measured - throughput. Set to "none" to disable - bin-packing, so each offset range maps - to one input partition. starting_offset: type: string description: >- @@ -14568,7 +13453,7 @@ paths: description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, PERMISSIVE. - Defaults to FAILFAST. + Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -14827,6 +13712,96 @@ paths: description: >- Meta Marketing (Meta Ads) specific options for ingestion + onedrive_options: + type: object + properties: + entity_type: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. + file_ingestion_options: + type: object + properties: + corrupt_record_column: + type: string + file_filters: + type: array + items: + type: object + properties: + modified_after: + type: string + modified_before: + type: string + description: >- + Include files with modification times + occurring before the specified time. + Timestamp format: YYYY-MM-DDTHH:mm:ss + (e.g. 2020-06-01T13:00:00) Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + path_filter: + type: string + description: >- + Include files with file names matching + the pattern Based on + https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + description: Generic options + format: + type: string + x-enum: + - AVRO + - BINARYFILE + - CSV + - EXCEL + - JSON + - ORC + - PARQUET + - XML + description: required for TableSpec + format_options: + type: object + description: >- + Format-specific options Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + ignore_corrupt_files: + type: boolean + infer_column_types: + type: boolean + reader_case_sensitive: + type: boolean + description: >- + Column name case sensitivity + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + rescued_data_column: + type: string + schema_evolution_mode: + type: string + x-enum: + - ADD_NEW_COLUMNS + - ADD_NEW_COLUMNS_WITH_TYPE_WIDENING + - FAIL_ON_NEW_COLUMNS + - NONE + - RESCUE + description: >- + Based on + + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + schema_hints: + type: string + description: >- + Override inferred schema of specific + columns Based on + https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + single_variant_column: + type: string + description: >- + (Optional) File ingestion options for + processing files. + url: + type: string + description: Required. The OneDrive URL. outlook_options: type: object properties: @@ -15002,8 +13977,6 @@ paths: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: >- @@ -15094,7 +14067,6 @@ paths: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -15305,16 +14277,6 @@ paths: fails if a table with that name already exists. If not set, the source table name is used. - jira_options: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string - description: >- - Deprecated: Use connector_options.jira_options - instead. source_catalog: type: string description: >- @@ -15325,6 +14287,15 @@ paths: description: >- Schema name in the source database. Might be optional depending on the type of source. + source_table: + type: string + description: >- + Table name in the source database. Optional: + some source types (for example streaming or + message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. + Clients that assume it is always present + should handle its absence. table_configuration: type: object properties: @@ -15511,17 +14482,6 @@ paths: (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is - written and maintained in the destination - table. Mutually exclusive with scd_type — - a 400 error is returned if both are set. table_properties: type: object description: >- @@ -15588,7 +14548,6 @@ paths: IngestionPipelineDefinition object and the SchemaSpec. required: - - source_table - destination_catalog - destination_schema description: Select a specific source table. @@ -15649,113 +14608,30 @@ paths: source_type: type: string x-enum: - - ADOBE_CAMPAIGNS - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AKAMAI_WAF - - AMPLITUDE - - API_SOURCE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - BIGQUERY - - BING_ADS - - CERIDIAN_DAYFORCE - - COMMUNITY - CONFLUENCE - - CROWDSTRIKE_EVENT_STREAM - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - FOREIGN_CATALOG - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - - GITHUB - - GITLAB - - GMAIL - - GONG - - GOOGLE_ADS - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - GOOGLE_DRIVE - - GOOGLE_SEARCH_CONSOLE - - GOOGLE_WORKSPACE - - GUIDEWIRE - - GURU - - HIBOB - - HUBSPOT - - IRONCLAD - JIRA - - KAFKA - - LINEAR - - LINKEDIN_ADS - - M365_AUDIT_LOGS - MANAGED_POSTGRESQL - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MICROSOFT_TEAMS - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - NETSUITE - - NOTION - - OKTA_SYSTEM_LOGS - - ONE_PASSWORD_EVENT_LOGS + - ONEDRIVE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - - OUTLOOK - - PAGERDUTY - - PARTNERSTACK - - PENDO - - PINTEREST_ADS - POSTGRESQL - - PROOFPOINT_SIEM - - QUICKBOOKS - RABBITMQ - - REDDIT_ADS - - REDSHIFT - SALESFORCE - - SALESFORCE_MARKETING_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - SHAREPOINT - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - - SLACK_AUDIT_LOGS - SMARTSHEET - - SNAPCHAT_ADS - - SPLUNK - - SQLDW - SQLSERVER - - SQUARE - TERADATA - TIKTOK_ADS - - VEEVA - - VEEVA_VAULT - - VERKADA - - WIZ_AUDIT_LOGS - - WORKDAY_ACTIVITY_LOGGING - - WORKDAY_HCM - WORKDAY_RAAS - - X_ADS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS description: >- The type of the foreign source. The source type will be inferred from the source connection or ingestion @@ -15925,17 +14801,6 @@ paths: description: >- (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - (Optional) Defines how ingested data is written and - maintained in the destination table. Mutually - exclusive with scd_type — a 400 error is returned if - both are set. table_properties: type: object description: >- @@ -16062,6 +14927,11 @@ paths: description: >- Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + parent_path: + type: string + description: >- + Path of the pipeline parent folder in workspace file tree. + If absent, the pipeline doesn't have a workspace object. photon: type: boolean description: Whether Photon is enabled for this pipeline. @@ -16100,24 +14970,6 @@ paths: required: - start_hour description: Restart window of this pipeline. - rewind_generation_interval: - type: object - properties: - interval: - type: integer - description: >- - An integer value representing the interval quantity for - the schedule. - unit: - type: string - x-enum: - - DAYS - - HOURS - - WEEKS - description: A time unit for the schedule. - description: >- - Interval at which rewind points are generated during - pipeline execution. root_path: type: string description: >- @@ -16128,6 +14980,14 @@ paths: run_as: type: object properties: + group_name: + type: string + description: >- + Group name of an account group assigned to the + workspace. When set, the pipeline runs as the group and + the group's permissions are used for data access. + Setting this field requires being a member of the group, + or having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -16153,7 +15013,13 @@ paths: published to. serverless: type: boolean - description: Whether serverless compute is enabled for this pipeline. + description: >- + Whether serverless compute is enabled for this pipeline. + Serverless is the recommended compute for new pipelines; set + this to ``true`` to run the pipeline on serverless. For + notebook/file pipelines, omitting this field uses classic + compute configured through the ``clusters`` field. When + ``true``, omit ``clusters``; Photon is always enabled. serverless_compute_id: type: string description: >- @@ -16672,21 +15538,26 @@ paths: :param cause: :class:`StartUpdateCause` (optional) + :param development: bool (optional) + Whether the update is started in the development mode. This is recommended for interactive + development and testing. Reuses compute for faster iteration and disables automatic retries. Not + recommended for production. :param full_refresh: bool (optional) If true, this update will reset all tables before running. :param full_refresh_selection: List[str] (optional) A list of tables to update with fullRefresh. If both refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. + :param full_refresh_selection_by_path: List[str] (optional) + A list of file paths that identify the tables to update with a full refresh. :param parameters: Dict[str,str] (optional) Key/value map of parameters to pass to the pipeline execution - :param refresh_flow_selection: List[str] (optional) - Flow names to selectively refresh. These are unioned with other selective refresh options - (refresh_selection, full_refresh_selection, etc.) to determine the final set of flows to refresh. :param refresh_selection: List[str] (optional) A list of tables to update without fullRefresh. If both refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. + :param refresh_selection_by_path: List[str] (optional) + A list of file paths that identify the tables to update. :param replace_where_overrides: List[:class:`ReplaceWhereOverride`] (optional) A list of predicate overrides for replace_where flows in this update. Only replace_where flows may @@ -16725,6 +15596,13 @@ paths: - SERVICE_UPGRADE - USER_ACTION description: What triggered this update. + development: + type: boolean + description: >- + Whether the update is started in the development mode. This + is recommended for interactive development and testing. + Reuses compute for faster iteration and disables automatic + retries. Not recommended for production. full_refresh: type: boolean description: If true, this update will reset all tables before running. @@ -16737,20 +15615,18 @@ paths: refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. + full_refresh_selection_by_path: + type: array + items: + type: string + description: >- + A list of file paths that identify the tables to update with + a full refresh. parameters: type: object description: >- Key/value map of parameters to pass to the pipeline execution - refresh_flow_selection: - type: array - items: - type: string - description: >- - Flow names to selectively refresh. These are unioned with - other selective refresh options (refresh_selection, - full_refresh_selection, etc.) to determine the final set of - flows to refresh. refresh_selection: type: array items: @@ -16760,6 +15636,11 @@ paths: refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. + refresh_selection_by_path: + type: array + items: + type: string + description: A list of file paths that identify the tables to update. replace_where_overrides: type: array items: @@ -16809,92 +15690,40 @@ paths: The identifier of the dataset (e.g., "main.foo.tbl1"). reset_checkpoints: - type: boolean - description: Whether to reset checkpoints for this dataset. - description: Configuration for rewinding a specific dataset. - description: >- - List of datasets to rewind with specific configuration - for each. When not specified, all datasets will be - rewound with cascade = true and reset_checkpoints = - true. - dry_run: - type: boolean - description: >- - If true, this is a dry run and we should emit the - RewindSummary but not perform the rewind. - rewind_point_id: - type: string - description: >- - The ID of a previously generated rewind point to rewind - to (same as the originating event log ID). Exactly one - of rewind_timestamp or rewind_point_id must be - specified. - rewind_timestamp: - type: string - description: >- - The base timestamp to rewind to. Exactly one of - rewind_timestamp or rewind_point_id must be specified. - description: >- - The information about the requested rewind operation. If - specified this is a rewind mode update. - validate_only: - type: boolean - description: >- - If true, this update only validates the correctness of - pipeline source code but does not materialize or publish any - datasets. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/StartUpdateResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: PipelinesAPI - /api/2.0/pipelines/{pipeline_id}/restore: - post: - operationId: pipelines_restore_pipeline - summary: >- - Restores a pipeline that was previously deleted, if within the - restoration window. All tables deleted - tags: - - pipelines - description: >- - Restores a pipeline that was previously deleted, if within the - restoration window. All tables deleted - - at pipeline deletion will be undropped as well. - - - :param pipeline_id: str - The ID of the pipeline to restore - - :returns: :class:`RestorePipelineRequestResponse` - parameters: - - name: pipeline_id - in: path - required: true - schema: - type: string - description: The ID of the pipeline to restore + type: boolean + description: Whether to reset checkpoints for this dataset. + description: Configuration for rewinding a specific dataset. + description: >- + List of datasets to rewind with specific configuration + for each. When not specified, all datasets will be + rewound with cascade = true and reset_checkpoints = + true. + dry_run: + type: boolean + description: >- + If true, this is a dry run and we should emit the + RewindSummary but not perform the rewind. + rewind_timestamp: + type: string + description: >- + The base timestamp to rewind to. Exactly one of + rewind_timestamp or rewind_point_id must be specified. + description: >- + The information about the requested rewind operation. If + specified this is a rewind mode update. + validate_only: + type: boolean + description: >- + If true, this update only validates the correctness of + pipeline source code but does not materialize or publish any + datasets. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/RestorePipelineRequestResponse' + $ref: '#/components/schemas/StartUpdateResponse' default: description: Error response content: @@ -16955,18 +15784,6 @@ paths: x-stackql-sdk-source: PipelinesAPI components: schemas: - AkamaiOptions: - type: object - properties: - config_ids: - type: array - items: - type: integer - description: >- - (Required) List of Akamai configuration IDs to ingest data from. A - config ID is a unique identifier for a security configuration used - to generate WAF logs. - description: Akamai specific options for ingestion ApiSourceConnectorConfig: type: object properties: @@ -17023,76 +15840,11 @@ components: description: >- (Optional) Schema registry to resolve the Avro schema at runtime instead of providing it inline or via a file path. - BingAdsOptions: - type: object - properties: - custom_report_options: - $ref: '#/components/schemas/BingAdsOptionsBingCustomReportOptions' - description: >- - (Optional) Custom report definition. When set, the table is treated - as a user-defined Bing Ads custom report. When unset, the table must - match one of the connector's prebuilt sources. - lookback_window_days: - type: integer - description: >- - (Optional) Number of days to look back during incremental sync to - capture late-arriving conversion and attribution data. If not - specified, defaults to 7 days. - sync_start_date: - type: string - description: >- - (Optional) Start date for the initial sync in YYYY-MM-DD format. If - not specified, defaults to 2 years before today. - description: Bing Ads specific options for ingestion pipelines. - BingAdsOptionsBingCustomReportOptions: - type: object - properties: - report_type: - $ref: >- - #/components/schemas/BingAdsOptionsBingCustomReportOptionsBingAdsReportType - description: >- - (Required) Microsoft Advertising report type (e.g. - CampaignPerformance, KeywordPerformance). - columns: - type: array - items: - type: string - description: >- - (Required) Columns to include in the report, given as Microsoft - Advertising column enum values for the selected report type (e.g. - AccountId, CampaignName, TimePeriod, Impressions, Clicks, Spend). - Required key columns are always included. Available columns are - report-type-specific. For the full list supported by a given report - type, see its column value set (substitute the report name, e.g. - campaignperformance): - https://learn.microsoft.com/en-us/advertising/reporting-service/{reportname}reportcolumn?view=bingads-13 - granularity: - $ref: >- - #/components/schemas/BingAdsOptionsBingCustomReportOptionsBingAdsGranularity - description: >- - (Optional) Time granularity for report aggregation. Defaults to - DAILY. - required: - - report_type - - columns - description: >- - User-defined custom report options for the Bing Ads connector. Applies - only to the custom_report - table. ClonePipelineResponse: type: object properties: pipeline_id: type: string - CommunityConnectorOptions: - type: object - properties: - options: - type: object - description: >- - Arbitrary key-value configuration options for the community - connector. - description: Options for community connectors with arbitrary configuration. ConfluenceConnectorOptions: type: object properties: @@ -17115,21 +15867,13 @@ components: ConnectorOptions: type: object properties: - akamai_options: - $ref: '#/components/schemas/AkamaiOptions' api_source_connector_options: $ref: '#/components/schemas/ApiSourceConnectorOptions' description: Connector-specific options for API Source connectors. - bing_ads_options: - $ref: '#/components/schemas/BingAdsOptions' - community_connector_options: - $ref: '#/components/schemas/CommunityConnectorOptions' confluence_options: $ref: '#/components/schemas/ConfluenceConnectorOptions' gdrive_options: $ref: '#/components/schemas/GoogleDriveOptions' - github_options: - $ref: '#/components/schemas/GitHubConnectorOptions' google_ads_options: $ref: '#/components/schemas/GoogleAdsOptions' jira_options: @@ -17142,6 +15886,8 @@ components: $ref: '#/components/schemas/MarketoOptions' meta_ads_options: $ref: '#/components/schemas/MetaMarketingOptions' + onedrive_options: + $ref: '#/components/schemas/OneDriveOptions' outlook_options: $ref: '#/components/schemas/OutlookOptions' rabbitmq_options: @@ -17334,15 +16080,12 @@ components: effective_budget_policy_id: type: string description: Serverless budget policy ID of this pipeline. - effective_environment_version: - type: string - description: The effective environment version resolved for the pipeline. effective_publishing_mode: $ref: '#/components/schemas/PublishingMode' description: Publishing mode of the pipeline - effective_usage_policy_id: + effective_serverless_compute_id: type: string - description: Serverless usage policy ID of the pipeline. + description: Serverless compute ID resolved for the pipeline. health: $ref: '#/components/schemas/GetPipelineResponseHealth' description: The health of a pipeline. @@ -17392,34 +16135,6 @@ components: properties: update: $ref: '#/components/schemas/UpdateInfo' - GitHubConnectorOptions: - type: object - properties: - repository_branch_selections: - type: array - items: - $ref: >- - #/components/schemas/GitHubConnectorOptionsRepositoryBranchSelection - description: >- - (Optional) Branches to ingest per repository. A repository not - listed here is ingested on its default branch. - description: GitHub-specific ingestion options. - GitHubConnectorOptionsRepositoryBranchSelection: - type: object - properties: - repository_id: - type: string - description: (Required) GitHub repository id (immutable; survives repo renames). - branches: - type: array - items: - type: string - description: >- - (Required) Branches to ingest for this repository, e.g. ["main", - "dev"]. - required: - - repository_id - description: A repository and the branches to ingest for it. GoogleAdsConfig: type: object properties: @@ -17513,13 +16228,6 @@ components: $ref: '#/components/schemas/GoogleDriveOptionsGoogleDriveEntityType' file_ingestion_options: $ref: '#/components/schemas/FileIngestionOptions' - scope: - $ref: '#/components/schemas/GoogleDriveOptionsGoogleDriveIngestionScope' - description: >- - The scope of the Google Drive ingestion. **ONLY ONE** of scope or - url must be specified. If scope is specified, we will ingest files - from the scope. If url is specified, we will ingest files from the - url. url: type: string description: Google Drive URL. @@ -17639,13 +16347,6 @@ components: description: >- Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. - IngestionPipelineDefinitionConfluenceOptions: - type: object - properties: - include_confluence_spaces: - type: array - items: - type: string IngestionPipelineDefinitionFanoutOptions: type: object properties: @@ -17667,13 +16368,6 @@ components: Routes each input record to a destination table based on a routing key derived from the record. The key value becomes the table name suffix: {destination_catalog}.{destination_schema}.{key_value}. - IngestionPipelineDefinitionJiraOptions: - type: object - properties: - include_jira_spaces: - type: array - items: - type: string IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: type: object properties: @@ -17761,17 +16455,6 @@ components: items: type: string description: (Optional) Projects to filter Jira data on - use_audit_logs: - type: boolean - description: >- - (Optional) Whether the pipeline reads Jira's audit log to detect - changes for the tables it ingests. Reading the audit log requires a - paid Jira plan and appropriate admin permissions. For example, the - issues table uses the audit log to detect and propagate deletes: - when true, rows deleted in Jira are removed from the destination - table; when false, the destination retains all previously ingested - rows and only reflects inserts and updates. If not specified, - defaults to false. description: Jira specific options for ingestion JsonTransformerOptions: type: object @@ -17807,14 +16490,6 @@ components: description: >- Internal option to control the maximum number of offsets to process per trigger. - max_partitions: - type: string - description: >- - (Optional) Controls how Kafka offset ranges are bin-packed into - Spark input partitions. Defaults to "auto" when unset, which lets - the engine choose the input partition count from measured - throughput. Set to "none" to disable bin-packing, so each offset - range maps to one input partition. starting_offset: type: string description: >- @@ -17926,7 +16601,7 @@ components: type: array items: $ref: '#/components/schemas/PipelineStateInfo' - description: The list of events matching the request criteria. + description: The list of pipelines matching the request criteria. ListUpdatesResponse: type: object properties: @@ -18076,6 +16751,17 @@ components: description: >- A list of email addresses notified when a configured alert is triggered. + OneDriveOptions: + type: object + properties: + entity_type: + $ref: '#/components/schemas/OneDriveOptionsOneDriveEntityType' + file_ingestion_options: + $ref: '#/components/schemas/FileIngestionOptions' + description: (Optional) File ingestion options for processing files. + url: + type: string + description: Required. The OneDrive URL. OperationTimeWindow: type: object properties: @@ -18125,11 +16811,6 @@ components: flow_name: type: string description: The name of the flow. Not unique. - graph_id: - type: string - description: >- - The UUID of the graph associated with this event, corresponding to a - GRAPH_UPDATED event. host: type: string description: The optional host name where the event was triggered @@ -18267,18 +16948,6 @@ components: properties: include: type: string - PeriodicTrigger: - type: object - properties: - interval: - type: integer - description: >- - An integer value representing the interval quantity for the - schedule. - unit: - $ref: '#/components/schemas/PeriodicTriggerTimeUnit' - description: A time unit for the schedule. - description: Periodic (EVERY syntax) schedule trigger configuration for a pipeline. PipelineAccessControlRequest: type: object properties: @@ -18386,9 +17055,10 @@ components: type: string description: >- A label for the cluster specification, either ``default`` to - configure the default cluster, or ``maintenance`` to configure the - maintenance cluster. This field is optional. The default value is - ``default``. + configure the default cluster settings applied to both the update + and maintenance clusters, ``updates`` to configure the update + cluster, or ``maintenance`` to configure the maintenance cluster. + This field is optional. The default value is ``default``. node_type_id: type: string description: >- @@ -18598,7 +17268,10 @@ components: type: array items: $ref: '#/components/schemas/PipelineCluster' - description: Cluster settings for this pipeline deployment. + description: >- + Cluster settings for this pipeline deployment. Applies to classic + (non-serverless) pipelines. Omit this field when ``serverless`` is + ``true``. configuration: type: object description: String-String configuration for this pipeline execution. @@ -18606,13 +17279,19 @@ components: type: boolean description: >- Whether the pipeline is continuous or triggered. This replaces - ``trigger``. + ``trigger``. Deprecated: wrap the pipeline in a continuous job + instead, which also lets you take advantage of job-level settings + such as performance mode. When the pipeline is started by a + continuous job, the job's setting takes precedence and this field is + ignored. deployment: $ref: '#/components/schemas/PipelineDeployment' description: Deployment type of this pipeline. development: type: boolean - description: Whether the pipeline is in Development mode. Defaults to false. + description: >- + Whether the pipeline is in Development mode. Defaults to false. + Deprecated: set development mode for each update instead. edition: type: string description: Pipeline product edition. @@ -18652,17 +17331,17 @@ components: items: $ref: '#/components/schemas/Notifications' description: List of notification settings for this pipeline. + parent_path: + type: string + description: >- + Path of the pipeline parent folder in workspace file tree. If + absent, the pipeline doesn't have a workspace object. photon: type: boolean description: Whether Photon is enabled for this pipeline. restart_window: $ref: '#/components/schemas/RestartWindow' description: Restart window of this pipeline. - rewind_generation_interval: - $ref: '#/components/schemas/PeriodicTrigger' - description: >- - Interval at which rewind points are generated during pipeline - execution. root_path: type: string description: >- @@ -18677,7 +17356,13 @@ components: published to. serverless: type: boolean - description: Whether serverless compute is enabled for this pipeline. + description: >- + Whether serverless compute is enabled for this pipeline. Serverless + is the recommended compute for new pipelines; set this to ``true`` + to run the pipeline on serverless. For notebook/file pipelines, + omitting this field uses classic compute configured through the + ``clusters`` field. When ``true``, omit ``clusters``; Photon is + always enabled. serverless_compute_id: type: string description: >- @@ -18812,7 +17497,7 @@ components: $ref: '#/components/schemas/ParseMode' description: >- (Optional) Parse mode for Protobuf data. Valid values: FAILFAST, - PERMISSIVE. Defaults to FAILFAST. + PERMISSIVE. Defaults to PERMISSIVE. recursive_fields_max_depth: type: integer description: >- @@ -18942,9 +17627,6 @@ components: for details. If not specified, UTC will be used. required: - start_hour - RestorePipelineRequestResponse: - type: object - properties: {} RewindDatasetSpec: type: object properties: @@ -18976,12 +17658,6 @@ components: description: >- If true, this is a dry run and we should emit the RewindSummary but not perform the rewind. - rewind_point_id: - type: string - description: >- - The ID of a previously generated rewind point to rewind to (same as - the originating event log ID). Exactly one of rewind_timestamp or - rewind_point_id must be specified. rewind_timestamp: type: string description: >- @@ -18993,6 +17669,13 @@ components: RunAs: type: object properties: + group_name: + type: string + description: >- + Group name of an account group assigned to the workspace. When set, + the pipeline runs as the group and the group's permissions are used + for data access. Setting this field requires being a member of the + group, or having the ``Assume`` permission on the group. service_principal_name: type: string description: >- @@ -19031,11 +17714,8 @@ components: SchemaSpec: type: object properties: - source_schema: - type: string destination_catalog: type: string - description: Required. Destination catalog to store tables. destination_schema: type: string description: >- @@ -19043,9 +17723,6 @@ components: same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. - confluence_options: - $ref: '#/components/schemas/IngestionPipelineDefinitionConfluenceOptions' - description: 'Deprecated: Use connector_options.confluence_options instead.' connector_options: $ref: '#/components/schemas/ConnectorOptions' description: (Optional) Source Specific Connector Options @@ -19056,14 +17733,18 @@ components: set, records are routed to destination tables based on a per-record routing key. The key value becomes the table name: {destination_catalog}.{destination_schema}.{key_value}. - jira_options: - $ref: '#/components/schemas/IngestionPipelineDefinitionJiraOptions' - description: 'Deprecated: Use connector_options.jira_options instead.' source_catalog: type: string description: >- The source catalog name. Might be optional depending on the type of source. + source_schema: + type: string + description: >- + Schema name in the source database. Optional: some source types (for + example streaming or message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. Clients that assume it + is always present should handle its absence. table_configuration: $ref: '#/components/schemas/TableSpecificConfig' description: >- @@ -19072,7 +17753,6 @@ components: table_configuration defined in the IngestionPipelineDefinition object. required: - - source_schema - destination_catalog - destination_schema Sequencing: @@ -19167,17 +17847,11 @@ components: TableSpec: type: object properties: - source_table: - type: string destination_catalog: type: string - description: Required. Destination catalog to store table. destination_schema: type: string description: Required. Destination schema to store table. - confluence_options: - $ref: '#/components/schemas/IngestionPipelineDefinitionConfluenceOptions' - description: 'Deprecated: Use connector_options.confluence_options instead.' connector_options: $ref: '#/components/schemas/ConnectorOptions' description: (Optional) Source Specific Connector Options @@ -19186,9 +17860,6 @@ components: description: >- Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. - jira_options: - $ref: '#/components/schemas/IngestionPipelineDefinitionJiraOptions' - description: 'Deprecated: Use connector_options.jira_options instead.' source_catalog: type: string description: >- @@ -19199,6 +17870,13 @@ components: description: >- Schema name in the source database. Might be optional depending on the type of source. + source_table: + type: string + description: >- + Table name in the source database. Optional: some source types (for + example streaming or message-bus connectors) do not use it, so it + may be absent from a pipeline's definition. Clients that assume it + is always present should handle its absence. table_configuration: $ref: '#/components/schemas/TableSpecificConfig' description: >- @@ -19206,7 +17884,6 @@ components: settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. required: - - source_table - destination_catalog - destination_schema TableSpecificConfig: @@ -19291,12 +17968,6 @@ components: description: >- (Optional) Name of the struct column added to each ingested record to hold per row source metadata. - storage_mode: - $ref: '#/components/schemas/StorageMode' - description: >- - (Optional) Defines how ingested data is written and maintained in - the destination table. Mutually exclusive with scd_type — a 400 - error is returned if both are set. table_properties: type: object description: >- @@ -19462,6 +18133,13 @@ components: refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. + full_refresh_selection_by_path: + type: array + items: + type: string + description: >- + A list of file paths that identify the tables to update with a full + refresh. mode: $ref: '#/components/schemas/UpdateMode' description: >- @@ -19474,15 +18152,6 @@ components: pipeline_id: type: string description: The ID of the pipeline. - refresh_flow_selection: - type: array - items: - type: string - description: >- - Flow names to selectively refresh. These are unioned with other - selective refresh options (refresh_selection, - full_refresh_selection, etc.) to determine the final set of flows to - refresh. refresh_selection: type: array items: @@ -19492,12 +18161,11 @@ components: refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh. - rewind_spec: - $ref: '#/components/schemas/RewindSpec' - description: >- - The rewind specification for this update. If set, this update is a - rewind execution (the update will rewind the targeted datasets to - the requested timestamp instead of running a normal refresh). + refresh_selection_by_path: + type: array + items: + type: string + description: A list of file paths that identify the tables to update. state: $ref: '#/components/schemas/UpdateInfoState' description: The update state. @@ -19528,61 +18196,6 @@ components: This determines the earliest date from which to sync historical data. description: Zendesk Support specific options for ingestion - BingAdsOptionsBingCustomReportOptionsBingAdsGranularity: - type: string - x-enum: - - DAILY - - HOURLY - - MONTHLY - - SUMMARY - - WEEKLY - - YEARLY - description: Time granularity for Bing Ads report aggregation. - BingAdsOptionsBingCustomReportOptionsBingAdsReportType: - type: string - x-enum: - - ACCOUNT_PERFORMANCE - - AD_DYNAMIC_TEXT_PERFORMANCE - - AD_EXTENSION_BY_AD - - AD_EXTENSION_BY_KEYWORD - - AD_EXTENSION_DETAIL - - AD_GROUP_PERFORMANCE - - AD_PERFORMANCE - - AGE_GENDER_AUDIENCE - - APPS_PERFORMANCE - - ASSET_GROUP_PERFORMANCE - - ASSET_PERFORMANCE - - AUDIENCE_PERFORMANCE - - BID_STRATEGY - - BUDGET_SUMMARY - - CALL_DETAIL - - CAMPAIGN_PERFORMANCE - - COMBINATION_PERFORMANCE - - CONVERSION_PERFORMANCE - - DESTINATION_URL_PERFORMANCE - - DSA_AUTO_TARGET_PERFORMANCE - - DSA_CATEGORY_PERFORMANCE - - DSA_SEARCH_QUERY_PERFORMANCE - - GEOGRAPHIC_PERFORMANCE - - GOALS_AND_FUNNELS - - HOTEL_DIMENSION_PERFORMANCE - - HOTEL_GROUP_PERFORMANCE - - KEYWORD_PERFORMANCE - - MS_CLICK_ID_PERFORMANCE - - NEGATIVE_KEYWORD_CONFLICT - - PRODUCT_DIMENSION_PERFORMANCE - - PRODUCT_MATCH_COUNT - - PRODUCT_PARTITION_PERFORMANCE - - PRODUCT_PARTITION_UNIT_PERFORMANCE - - PRODUCT_SEARCH_QUERY_PERFORMANCE - - PROFESSIONAL_DEMOGRAPHICS_AUDIENCE - - PUBLISHER_USAGE_PERFORMANCE - - SEARCH_CAMPAIGN_CHANGE_HISTORY - - SEARCH_INSIGHT_PERFORMANCE - - SEARCH_QUERY_PERFORMANCE - - SHARE_OF_VOICE - - USER_LOCATION_PERFORMANCE - description: Supported Microsoft Advertising report types for custom reports. CloneMode: type: string x-enum: @@ -19639,7 +18252,6 @@ components: - BINARYFILE - CSV - EXCEL - - FILE - JSON - ORC - PARQUET @@ -19704,8 +18316,6 @@ components: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - PERMISSION description: |- Create a collection of name/value pairs. @@ -19742,200 +18352,36 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - GoogleDriveOptionsGoogleDriveIngestionScope: - type: string - x-enum: - - DOMAIN_ALL - - DOMAIN_SHARED_DRIVES - - DOMAIN_USER_DRIVES - - USER_ACCESSIBLE - - USER_DRIVE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. IngestionSourceType: type: string x-enum: - - ADOBE_CAMPAIGNS - - ADOBE_COMMERCE - - ADP_WORKFORCE_NOW - - AHA - - AIRTABLE - - AKAMAI_WAF - - AMPLITUDE - - API_SOURCE - - APPFIGURES - - APPLE_APP_STORE - - APPLE_SEARCH_ADS - - ATLASSIAN_ORGANIZATION - - AWIN - - AZURE_MONITOR_LOGS - BIGQUERY - - BING_ADS - - CERIDIAN_DAYFORCE - - COMMUNITY - CONFLUENCE - - CROWDSTRIKE_EVENT_STREAM - - DELIGHTED - DYNAMICS365 - - EPIC_CLARITY - FOREIGN_CATALOG - - FRESHSERVICE - - FRONT - GA4_RAW_DATA - - GENESYS - - GITHUB - - GITLAB - - GMAIL - - GONG - - GOOGLE_ADS - - GOOGLE_ANALYTICS - - GOOGLE_CALENDAR - GOOGLE_DRIVE - - GOOGLE_SEARCH_CONSOLE - - GOOGLE_WORKSPACE - - GUIDEWIRE - - GURU - - HIBOB - - HUBSPOT - - IRONCLAD - JIRA - - KAFKA - - LINEAR - - LINKEDIN_ADS - - M365_AUDIT_LOGS - MANAGED_POSTGRESQL - - MARKETO - META_MARKETING - - MICROSOFT_ENTRA_ID - - MICROSOFT_TEAMS - - MONDAY_COM - MYSQL - - NETSKOPE_LOGS - NETSUITE - - NOTION - - OKTA_SYSTEM_LOGS - - ONE_PASSWORD_EVENT_LOGS + - ONEDRIVE - ORACLE - - ORACLE_ELOQUA - - ORACLE_FUSION_CLOUD - - OUTLOOK - - PAGERDUTY - - PARTNERSTACK - - PENDO - - PINTEREST_ADS - POSTGRESQL - - PROOFPOINT_SIEM - - QUICKBOOKS - RABBITMQ - - REDDIT_ADS - - REDSHIFT - SALESFORCE - - SALESFORCE_MARKETING_CLOUD - - SALESLOFT - - SAP_SUCCESSFACTORS - - SAS - - SENDGRID - SERVICENOW - SHAREPOINT - - SHOPIFY - - SLACK_ACCESS_AND_INTEGRATION_LOGS - - SLACK_AUDIT_LOGS - SMARTSHEET - - SNAPCHAT_ADS - - SPLUNK - - SQLDW - SQLSERVER - - SQUARE - TERADATA - TIKTOK_ADS - - VEEVA - - VEEVA_VAULT - - VERKADA - - WIZ_AUDIT_LOGS - - WORKDAY_ACTIVITY_LOGGING - - WORKDAY_HCM - WORKDAY_RAAS - - X_ADS - - YOUTUBE_ANALYTICS - ZENDESK - - ZIP - - ZOHO_BOOKS - - ZOOM - - ZOOM_LOGS - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. + description: Type of source system that a managed ingestion pipeline reads from. LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsEntityGranularity: type: string x-enum: @@ -19971,6 +18417,12 @@ components: - EVOLVING - STABLE description: Maturity level for EventDetails. + OneDriveOptionsOneDriveEntityType: + type: string + x-enum: + - FILE + - FILE_METADATA + description: The type of OneDrive entity to ingest. OutlookAttachmentMode: type: string x-enum: @@ -19993,13 +18445,6 @@ components: description: >- Determines how errors encountered while deserializing records are handled. - PeriodicTriggerTimeUnit: - type: string - x-enum: - - DAYS - - HOURS - - WEEKS - description: Time unit enums for different time units. PipelineClusterAutoscaleMode: type: string x-enum: @@ -20054,8 +18499,6 @@ components: x-enum: - FILE - FILE_METADATA - - FILE_PERMISSION - - GROUP_MEMBERSHIP - LIST - PERMISSION description: |- @@ -20106,15 +18549,6 @@ components: - SERVICE_UPGRADE - USER_ACTION description: What triggered this update. - StorageMode: - type: string - x-enum: - - APPEND_ONLY - - SCD_TYPE_1 - - SCD_TYPE_2 - description: >- - Defines how ingested data is written and maintained in the destination - table. TableSpecificConfigScdType: type: string x-enum: @@ -20326,12 +18760,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - restore: - operation: - $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1restore/post' - response: - mediaType: application/json - openAPIDocKey: '200' stop: operation: $ref: '#/paths/~1api~12.0~1pipelines~1{pipeline_id}~1stop/post' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml b/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml index c088da66..b748ea1c 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml @@ -5,16 +5,30 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.postgres servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: - /api/2.0/postgres/{parent}/branches: + /api/2.0/postgres/projects/{project_id}/branches: post: operationId: postgres_create_branch summary: Creates a new database branch in the project. @@ -37,12 +51,13 @@ paths: :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Project where this Branch will be created. Format: projects/{project_id}' + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}`). The Project where + this Branch will be created. Format: projects/{project_id}' - name: branch_id in: query required: true @@ -63,132 +78,129 @@ paths: schema: type: object properties: - branch: + branch_id: + type: string + create_time: + type: string + format: date-time + description: A timestamp indicating when the branch was created. + name: + type: string + description: 'Output only. The full resource path of the branch. Format: projects/{project_id}/branches/{branch_id}' + parent: + type: string + description: 'The project containing this branch (API resource hierarchy). Format: projects/{project_id} + Note: This field indicates where the branch exists in the resource hierarchy. For point-in-time branching + from another branch, see ``status.source_branch``.' + spec: + type: object + properties: + expire_time: + type: string + format: date-time + is_protected: + type: boolean + description: When set to true, protects the branch from deletion and reset. Associated compute endpoints + and the project cannot be deleted while the branch is protected. + no_expiry: + type: boolean + description: Explicitly disable expiration. When set to true, the branch will not expire. If set to + false, the request is invalid; provide either ttl or expire_time instead. Mutually exclusive with + ``expire_time`` and ``ttl``. + source_branch: + type: string + description: 'The name of the source branch from which this branch was created (data lineage for point-in-time + recovery). If not specified, defaults to the project''s default branch. Format: projects/{project_id}/branches/{branch_id}' + source_branch_lsn: + type: string + description: The Log Sequence Number (LSN) on the source branch from which this branch was created. + source_branch_time: + type: string + format: date-time + description: The point in time on the source branch from which this branch was created. + source_snapshot: + type: string + description: 'The snapshot this branch was created from. When set, the branch''s data comes from the + snapshot rather than a source branch, so source_branch, source_branch_lsn, and source_branch_time + must be empty. The snapshot must be AVAILABLE and belong to this branch''s project. Format: projects/{project_id}/snapshots/{snapshot_id}' + ttl: + type: string + description: Relative time-to-live duration. When set, the branch will expire at creation_time + ttl. + Mutually exclusive with ``expire_time`` and ``no_expiry``. + description: The spec contains the branch configuration. + status: type: object properties: branch_id: type: string - create_time: + current_state: + type: string + x-enum: + - ARCHIVED + - DELETED + - IMPORTING + - INIT + - READY + - RESETTING + description: The branch's state, indicating if it is initializing, ready for use, or archived. + default: + type: boolean + description: Whether the branch is the project's default branch. + delete_time: type: string format: date-time - description: A timestamp indicating when the branch was created. - name: + description: A timestamp indicating when the branch was deleted. Empty if the branch is not deleted. + expire_time: type: string - description: 'Output only. The full resource path of the branch. Format: projects/{project_id}/branches/{branch_id}' - parent: + format: date-time + description: Absolute expiration time for the branch. Empty if expiration is disabled. + is_protected: + type: boolean + description: Whether the branch is protected. + logical_size_bytes: + type: integer + description: The logical size of the branch. + pending_state: type: string - description: 'The project containing this branch (API resource hierarchy). Format: projects/{project_id} - Note: This field indicates where the branch exists in the resource hierarchy. For point-in-time branching - from another branch, see ``status.source_branch``.' - spec: - type: object - properties: - expire_time: - type: string - format: date-time - is_protected: - type: boolean - description: When set to true, protects the branch from deletion and reset. Associated compute endpoints - and the project cannot be deleted while the branch is protected. - no_expiry: - type: boolean - description: Explicitly disable expiration. When set to true, the branch will not expire. If set - to false, the request is invalid; provide either ttl or expire_time instead. Mutually exclusive - with ``expire_time`` and ``ttl``. When updating, use ``spec.expiration`` in the update_mask. - source_branch: - type: string - description: 'The name of the source branch from which this branch was created (data lineage for - point-in-time recovery). If not specified, defaults to the project''s default branch. Format: - projects/{project_id}/branches/{branch_id}' - source_branch_lsn: - type: string - description: The Log Sequence Number (LSN) on the source branch from which this branch was created. - source_branch_time: - type: string - format: date-time - description: The point in time on the source branch from which this branch was created. - ttl: - type: string - description: Relative time-to-live duration. When set, the branch will expire at creation_time + - ttl. Mutually exclusive with ``expire_time`` and ``no_expiry``. When updating, use ``spec.expiration`` - in the update_mask. - description: The spec contains the branch configuration. - status: - type: object - properties: - branch_id: - type: string - current_state: - type: string - x-enum: - - ARCHIVED - - DELETED - - IMPORTING - - INIT - - READY - - RESETTING - description: The branch's state, indicating if it is initializing, ready for use, or archived. - default: - type: boolean - description: Whether the branch is the project's default branch. - delete_time: - type: string - format: date-time - description: A timestamp indicating when the branch was deleted. Empty if the branch is not deleted. - expire_time: - type: string - format: date-time - description: Absolute expiration time for the branch. Empty if expiration is disabled. - is_protected: - type: boolean - description: Whether the branch is protected. - logical_size_bytes: - type: integer - description: The logical size of the branch. - pending_state: - type: string - x-enum: - - ARCHIVED - - DELETED - - IMPORTING - - INIT - - READY - - RESETTING - description: The pending state of the branch, if a state transition is in progress. - purge_time: - type: string - format: date-time - description: A timestamp indicating when the branch is scheduled to be purged. Empty if the branch - is not deleted, otherwise set to a timestamp in the future. - source_branch: - type: string - description: 'The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}' - source_branch_lsn: - type: string - description: The Log Sequence Number (LSN) on the source branch from which this branch was created. - source_branch_time: - type: string - format: date-time - description: The point in time on the source branch from which this branch was created. - source_recovery_branch: - type: string - description: 'If this branch is a child of a recovery branch, this field identifies that recovery - source. For non-recovery-derived branches this is unset. Format: projects/{project_id}/preview/recovery-branches/{recovery_branch_id}' - state_change_time: - type: string - format: date-time - description: A timestamp indicating when the ``current_state`` began. - description: The current status of a Branch. - uid: + x-enum: + - ARCHIVED + - DELETED + - IMPORTING + - INIT + - READY + - RESETTING + description: The pending state of the branch, if a state transition is in progress. + purge_time: + type: string + format: date-time + description: A timestamp indicating when the branch is scheduled to be purged. Empty if the branch is + not deleted, otherwise set to a timestamp in the future. + source_branch: + type: string + description: 'The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}' + source_branch_lsn: type: string - description: System-generated unique ID for the branch. - update_time: + description: The Log Sequence Number (LSN) on the source branch from which this branch was created. + source_branch_time: type: string format: date-time - description: A timestamp indicating when the branch was last updated. - description: The Branch to create. - required: - - branch + description: The point in time on the source branch from which this branch was created. + source_snapshot: + type: string + description: 'The snapshot this branch was restored from. Set only for branches created by restoring + a snapshot; unset for all other branches. Format: projects/{project_id}/snapshots/{snapshot_id}' + state_change_time: + type: string + format: date-time + description: A timestamp indicating when the ``current_state`` began. + description: The current status of a Branch. + uid: + type: string + description: System-generated unique ID for the branch. + update_time: + type: string + format: date-time + description: A timestamp indicating when the branch was last updated. responses: '200': description: Success @@ -228,12 +240,13 @@ paths: :returns: Iterator over :class:`Branch` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Project that owns this collection of branches. Format: projects/{project_id}' + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}`). The Project that owns + this collection of branches. Format: projects/{project_id}' - name: page_size in: query required: false @@ -300,67 +313,62 @@ paths: schema: type: object properties: - catalog: + catalog_id: + type: string + create_time: + type: string + format: date-time + description: A timestamp indicating when the catalog was created. + name: + type: string + description: 'Output only. The full resource path of the catalog. Format: "catalogs/{catalog_id}".' + spec: type: object properties: - catalog_id: + postgres_database: type: string - create_time: + description: The name of the Postgres database inside the specified Lakebase project and branch to be + associated with the UC catalog. This database must already exist, unless create_database_if_missing + is set to true on creation. A database can only be registered with one UC catalog at a time. To re-register + a database with a different catalog, the existing catalog must be deleted first. A child branch inherits + the fact of parent's registration. This means the same-named database in a child branch cannot be + registered with a second catalog while the parent's registration exists. To allow registering the + database of a child branch, drop and recreate the database on the child branch. This removes the fact + of parent's registration from this branch only. Doing Point In Time Restore (PITR) prior to the moment + before the Postgres DB was registered in the Catalog drops the fact of registration of the database. + So the user should avoid doing so. + branch: type: string - format: date-time - description: A timestamp indicating when the catalog was created. - name: + description: 'The resource path of the branch associated with the catalog. Format: projects/{project_id}/branches/{branch_id}.' + create_database_if_missing: + type: boolean + description: If set to true, the specified postgres_database is created on behalf of the calling user + if it does not already exist. In this case, the calling user has a role created for them in Postgres + if they do not already have one. Defaults to false, meaning that the request fails if the specified + postgres_database does not already exist. + required: + - postgres_database + description: The desired state of the Catalog. + status: + type: object + properties: + branch: type: string - description: 'Output only. The full resource path of the catalog. Format: "catalogs/{catalog_id}".' - spec: - type: object - properties: - postgres_database: - type: string - description: The name of the Postgres database inside the specified Lakebase project and branch - to be associated with the UC catalog. This database must already exist, unless create_database_if_missing - is set to true on creation. A database can only be registered with one UC catalog at a time. To - re-register a database with a different catalog, the existing catalog must be deleted first. A - child branch inherits the fact of parent's registration. This means the same-named database in - a child branch cannot be registered with a second catalog while the parent's registration exists. - To allow registering the database of a child branch, drop and recreate the database on the child - branch. This removes the fact of parent's registration from this branch only. Doing Point In Time - Restore (PITR) prior to the moment before the Postgres DB was registered in the Catalog drops - the fact of registration of the database. So the user should avoid doing so. - branch: - type: string - description: 'The resource path of the branch associated with the catalog. Format: projects/{project_id}/branches/{branch_id}.' - create_database_if_missing: - type: boolean - description: If set to true, the specified postgres_database is created on behalf of the calling - user if it does not already exist. In this case, the calling user has a role created for them - in Postgres if they do not already have one. Defaults to false, meaning that the request fails - if the specified postgres_database does not already exist. - required: - - postgres_database - description: The desired state of the Catalog. - status: - type: object - properties: - branch: - type: string - description: 'The resource path of the branch associated with the catalog. Format: projects/{project_id}/branches/{branch_id}.' - postgres_database: - type: string - description: The name of the Postgres database associated with the catalog. - project: - type: string - description: 'The resource path of the project associated with the catalog. Format: projects/{project_id}.' - description: The observed state of the Catalog. - uid: + description: 'The resource path of the branch associated with the catalog. Format: projects/{project_id}/branches/{branch_id}.' + postgres_database: type: string - description: System-generated unique identifier for the catalog. - update_time: + description: The name of the Postgres database associated with the catalog. + project: type: string - format: date-time - description: A timestamp indicating when the catalog was last updated. - required: - - catalog + description: 'The resource path of the project associated with the catalog. Format: projects/{project_id}.' + description: The observed state of the Catalog. + uid: + type: string + description: System-generated unique identifier for the catalog. + update_time: + type: string + format: date-time + description: A timestamp indicating when the catalog was last updated. responses: '200': description: Success @@ -380,7 +388,7 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/cdf-configs: + /api/2.0/postgres/projects/{project}/branches/{branch}/databases/{database}/cdf-configs: post: operationId: postgres_create_cdf_config summary: Create a CDF configuration that materializes the change data feed for all tables in a Postgres schema @@ -395,20 +403,35 @@ paths: The parent database under which to create the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database} :param cdf_config: :class:`CdfConfig` - The CdfConfig to create. The catalog, schema, and postgres_schema fields are required; all other - fields are output only and ignored on input. + The CdfConfig to create. The catalog, schema, and postgres_schema fields are required; + service_principal is optional. All other fields are output only and ignored on input. :param cdf_config_id: str (optional) The user-specified id for the CdfConfig, forming the final segment of its resource name. Must match the pattern ``[a-z][a-z0-9_]{0,62}``. Defaults to the Postgres schema name when omitted. :returns: :class:`Operation` parameters: - - name: parent + - name: project + in: path + required: true + schema: + type: string + description: 'The `project` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database under which to create the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}' + - name: branch + in: path + required: true + schema: + type: string + description: 'The `branch` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database under which to create the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}' + - name: database in: path required: true schema: type: string - description: 'The parent database under which to create the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}' + description: 'The `database` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database under which to create the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}' - name: cdf_config_id in: query required: false @@ -422,40 +445,33 @@ paths: schema: type: object properties: - cdf_config: - type: object - properties: - catalog: - type: string - description: The Unity Catalog catalog that replicated tables are written into. Set at creation; the - CdfConfig is immutable. - schema: - type: string - description: The Unity Catalog schema that replicated tables are written into. Set at creation; the - CdfConfig is immutable. - postgres_schema: - type: string - description: The Postgres schema this CdfConfig replicates from. Unique within the parent database. - Set at creation; the CdfConfig is immutable. - cdf_config_id: - type: string - description: The user-specified id; equals the final segment of ``name``. Defaults to the Postgres schema - name for configs without an explicit id. - create_time: - type: string - format: date-time - description: When the CdfConfig was created. - name: - type: string - description: 'Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' - required: - - catalog - - schema - - postgres_schema - description: The CdfConfig to create. The catalog, schema, and postgres_schema fields are required; all - other fields are output only and ignored on input. + catalog: + type: string + description: The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig + is immutable. + schema: + type: string + description: The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig + is immutable. + postgres_schema: + type: string + description: The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set + at creation; the CdfConfig is immutable. + cdf_config_id: + type: string + description: The user-specified id; equals the final segment of ``name``. Defaults to the Postgres schema + name for configs without an explicit id. + create_time: + type: string + format: date-time + description: When the CdfConfig was created. + name: + type: string + description: 'Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' required: - - cdf_config + - catalog + - schema + - postgres_schema responses: '200': description: Success @@ -494,12 +510,27 @@ paths: :returns: Iterator over :class:`CdfConfig` parameters: - - name: parent + - name: project + in: path + required: true + schema: + type: string + description: 'The `project` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}' + - name: branch in: path required: true schema: type: string - description: 'The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}' + description: 'The `branch` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}' + - name: database + in: path + required: true + schema: + type: string + description: 'The `database` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}`). + The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}' - name: page_size in: query required: false @@ -531,7 +562,7 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/data-api: + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api: post: operationId: postgres_create_data_api summary: Enable Data API for a database. @@ -547,137 +578,138 @@ paths: :returns: :class:`Operation` parameters: - - name: parent + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: database_id in: path required: true schema: type: string - description: 'Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + description: 'The `database_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id}' requestBody: content: application/json: schema: type: object properties: - data_api: + create_time: + type: string + format: date-time + description: A timestamp indicating when the Data API was first enabled. + name: + type: string + description: 'Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + parent: + type: string + description: 'The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + spec: type: object properties: - create_time: + db_aggregates_enabled: + type: boolean + description: 'Enable aggregate functions (count, sum, avg, etc.) in Data API responses. Default: true.' + db_extra_search_path: + type: array + items: + type: string + description: Additional schemas to include in the PostgreSQL search path. Each entry must be a valid + PostgreSQL schema name. + db_max_rows: + type: integer + description: Maximum number of rows returned in a single Data API response. Must be a positive integer. + db_schemas: + type: array + items: + type: string + description: 'Database schemas exposed through the Data API. Each entry must be a valid PostgreSQL schema + name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Maximum 100 entries. Default: ["public"].' + jwt_cache_max_lifetime: type: string - format: date-time - description: A timestamp indicating when the Data API was first enabled. - name: + description: Maximum lifetime for cached JWT tokens. Zero duration disables caching. + jwt_role_claim_key: type: string - description: 'Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' - parent: + description: 'JSON path to the role claim in JWT tokens (e.g., ".sub"). Default: ".sub".' + openapi_mode: type: string - description: 'The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' - spec: - type: object - properties: - db_aggregates_enabled: - type: boolean - description: 'Enable aggregate functions (count, sum, avg, etc.) in Data API responses. Default: - true.' - db_anon_role: - type: string - description: 'The PostgreSQL role used for unauthenticated (anonymous) requests. Must be a valid - PostgreSQL role name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Default: "anonymous".' - db_extra_search_path: - type: array - items: - type: string - description: Additional schemas to include in the PostgreSQL search path. Each entry must be a valid - PostgreSQL schema name. - db_max_rows: - type: integer - description: Maximum number of rows returned in a single Data API response. Must be a positive integer. - db_schemas: - type: array - items: - type: string - description: 'Database schemas exposed through the Data API. Each entry must be a valid PostgreSQL - schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Maximum 100 entries. Default: ["public"].' - jwt_cache_max_lifetime: - type: string - description: Maximum lifetime for cached JWT tokens. Zero duration disables caching. - jwt_role_claim_key: - type: string - description: 'JSON path to the role claim in JWT tokens (e.g., ".sub"). Default: ".sub".' - openapi_mode: - type: string - x-enum: - - OPEN_API_MODE_DISABLED - - OPEN_API_MODE_IGNORE_PRIVILEGES - description: OpenAPI documentation mode for the Data API endpoint. - server_cors_allowed_origins: - type: array - items: - type: string - description: Allowed origins for CORS requests. Each entry should be a valid origin URL, or use - "*" to allow all origins. - server_timing_enabled: - type: boolean - description: Enable the Server-Timing header in Data API responses. - description: The desired Data API configuration. - status: - type: object - properties: - available_schemas: - type: array - items: - type: string - description: Schemas available in the database (for reference when configuring db_schemas). - db_aggregates_enabled: - type: boolean - description: Actual aggregate function setting read from the database. - db_anon_role: - type: string - description: Actual anonymous role name read from the database. - db_extra_search_path: - type: array - items: - type: string - description: Actual extra search path schemas read from the database. - db_max_rows: - type: integer - description: Actual max rows setting read from the database. - db_schemas: - type: array - items: - type: string - description: Actual exposed schemas read from the database. - jwt_cache_max_lifetime: - type: string - description: Actual JWT cache max lifetime read from the database. - jwt_role_claim_key: - type: string - description: Actual JWT role claim key read from the database. - openapi_mode: - type: string - x-enum: - - OPEN_API_MODE_DISABLED - - OPEN_API_MODE_IGNORE_PRIVILEGES - description: Actual OpenAPI mode read from the database. - server_cors_allowed_origins: - type: array - items: - type: string - description: Actual CORS allowed origins read from the database. - server_timing_enabled: - type: boolean - description: Actual Server-Timing header setting read from the database. - url: - type: string - description: Data API endpoint URL. - description: The observed Data API state (read-only). - update_time: + x-enum: + - OPEN_API_MODE_DISABLED + - OPEN_API_MODE_IGNORE_PRIVILEGES + description: OpenAPI documentation mode for the Data API endpoint. + server_cors_allowed_origins: + type: array + items: + type: string + description: Allowed origins for CORS requests. Each entry should be a valid origin URL, or use "*" + to allow all origins. + server_timing_enabled: + type: boolean + description: Enable the Server-Timing header in Data API responses. + description: The desired Data API configuration. + status: + type: object + properties: + available_schemas: + type: array + items: + type: string + description: Schemas available in the database (for reference when configuring db_schemas). + db_aggregates_enabled: + type: boolean + description: Actual aggregate function setting read from the database. + db_extra_search_path: + type: array + items: + type: string + description: Actual extra search path schemas read from the database. + db_max_rows: + type: integer + description: Actual max rows setting read from the database. + db_schemas: + type: array + items: + type: string + description: Actual exposed schemas read from the database. + jwt_cache_max_lifetime: type: string - format: date-time - description: A timestamp indicating when the Data API configuration was last updated. - description: The Data API configuration to create. - required: - - data_api + description: Actual JWT cache max lifetime read from the database. + jwt_role_claim_key: + type: string + description: Actual JWT role claim key read from the database. + openapi_mode: + type: string + x-enum: + - OPEN_API_MODE_DISABLED + - OPEN_API_MODE_IGNORE_PRIVILEGES + description: Actual OpenAPI mode read from the database. + server_cors_allowed_origins: + type: array + items: + type: string + description: Actual CORS allowed origins read from the database. + server_timing_enabled: + type: boolean + description: Actual Server-Timing header setting read from the database. + url: + type: string + description: Data API endpoint URL. + description: The observed Data API state (read-only). + update_time: + type: string + format: date-time + description: A timestamp indicating when the Data API configuration was last updated. responses: '200': description: Success @@ -697,109 +729,391 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/databases: - post: - operationId: postgres_create_database - summary: Create a Database. + delete: + operationId: postgres_delete_data_api + summary: Disable Data API for a database. tags: - postgres description: |- - Create a Database. - - Creates a database in the specified branch. A branch can have multiple databases. - - :param parent: str - The Branch where this Database will be created. Format: projects/{project_id}/branches/{branch_id} - :param database: :class:`Database` - The desired specification of a Database. - :param database_id: str (optional) - The ID to use for the Database, which will become the final component of the database's resource - name. This ID becomes the database name in postgres. - - This value should be 4-63 characters, and only use characters available in DNS names, as defined by - RFC-1123 + Disable Data API for a database. - If database_id is not specified in the request, it is generated automatically. - :param replace_existing: bool (optional) - If true, update the database if it already exists instead of returning an error. + :param name: str + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Branch where this Database will be created. Format: projects/{project_id}/branches/{branch_id}' - - name: database_id - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: branch_id + in: path + required: true schema: type: string - description: The ID to use for the Database, which will become the final component of the database's resource name. - This ID becomes the database name in postgres. This value should be 4-63 characters, and only use characters available - in DNS names, as defined by RFC-1123 If database_id is not specified in the request, it is generated automatically. - - name: replace_existing - in: query - required: false + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: database_id + in: path + required: true schema: - type: boolean - description: If true, update the database if it already exists instead of returning an error. - requestBody: - content: - application/json: - schema: - type: object - properties: - database: - type: object - properties: - create_time: + type: string + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_get_data_api + summary: Get Data API configuration for a database. + tags: + - postgres + description: |- + Get Data API configuration for a database. + + :param name: str + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api + + :returns: :class:`DataApi` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: database_id + in: path + required: true + schema: + type: string + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DataApi' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + patch: + operationId: postgres_update_data_api + summary: Update Data API configuration for a database. + tags: + - postgres + description: |- + Update Data API configuration for a database. + + :param name: str + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api + :param data_api: :class:`DataApi` + The Data API configuration to update. The data_api's ``name`` field identifies the resource. + :param update_mask: FieldMask + The list of fields to update. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: database_id + in: path + required: true + schema: + type: string + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api`). + Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: A timestamp indicating when the Data API was first enabled. + name: + type: string + description: 'Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api' + parent: + type: string + description: 'The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + spec: + type: object + properties: + db_aggregates_enabled: + type: boolean + description: 'Enable aggregate functions (count, sum, avg, etc.) in Data API responses. Default: true.' + db_extra_search_path: + type: array + items: + type: string + description: Additional schemas to include in the PostgreSQL search path. Each entry must be a valid + PostgreSQL schema name. + db_max_rows: + type: integer + description: Maximum number of rows returned in a single Data API response. Must be a positive integer. + db_schemas: + type: array + items: + type: string + description: 'Database schemas exposed through the Data API. Each entry must be a valid PostgreSQL schema + name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Maximum 100 entries. Default: ["public"].' + jwt_cache_max_lifetime: type: string - format: date-time - description: A timestamp indicating when the database was created. - database_id: + description: Maximum lifetime for cached JWT tokens. Zero duration disables caching. + jwt_role_claim_key: type: string - description: The part of the name, chosen by the user when the resource was created. - name: + description: 'JSON path to the role claim in JWT tokens (e.g., ".sub"). Default: ".sub".' + openapi_mode: type: string - description: 'The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' - parent: + x-enum: + - OPEN_API_MODE_DISABLED + - OPEN_API_MODE_IGNORE_PRIVILEGES + description: OpenAPI documentation mode for the Data API endpoint. + server_cors_allowed_origins: + type: array + items: + type: string + description: Allowed origins for CORS requests. Each entry should be a valid origin URL, or use "*" + to allow all origins. + server_timing_enabled: + type: boolean + description: Enable the Server-Timing header in Data API responses. + description: The desired Data API configuration. + status: + type: object + properties: + available_schemas: + type: array + items: + type: string + description: Schemas available in the database (for reference when configuring db_schemas). + db_aggregates_enabled: + type: boolean + description: Actual aggregate function setting read from the database. + db_extra_search_path: + type: array + items: + type: string + description: Actual extra search path schemas read from the database. + db_max_rows: + type: integer + description: Actual max rows setting read from the database. + db_schemas: + type: array + items: + type: string + description: Actual exposed schemas read from the database. + jwt_cache_max_lifetime: type: string - description: 'The branch containing this database. Format: projects/{project_id}/branches/{branch_id}' - spec: - type: object - properties: - role: - type: string - postgres_database: - type: string - description: The name of the Postgres database. This expects a valid Postgres identifier as specified - in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS - Required when creating the Database. To rename, pass a valid postgres identifier when updating - the Database. - required: - - role - description: The desired state of the Database. - status: - type: object - properties: - database_id: - type: string - postgres_database: - type: string - description: The name of the Postgres database. - role: - type: string - description: 'The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' - description: The observed state of the Database. - update_time: + description: Actual JWT cache max lifetime read from the database. + jwt_role_claim_key: type: string - format: date-time - description: A timestamp indicating when the database was last updated. - description: The desired specification of a Database. - required: - - database + description: Actual JWT role claim key read from the database. + openapi_mode: + type: string + x-enum: + - OPEN_API_MODE_DISABLED + - OPEN_API_MODE_IGNORE_PRIVILEGES + description: Actual OpenAPI mode read from the database. + server_cors_allowed_origins: + type: array + items: + type: string + description: Actual CORS allowed origins read from the database. + server_timing_enabled: + type: boolean + description: Actual Server-Timing header setting read from the database. + url: + type: string + description: Data API endpoint URL. + description: The observed Data API state (read-only). + update_time: + type: string + format: date-time + description: A timestamp indicating when the Data API configuration was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/databases: + post: + operationId: postgres_create_database + summary: Create a Database. + tags: + - postgres + description: |- + Create a Database. + + Creates a database in the specified branch. A branch can have multiple databases. + + :param parent: str + The Branch where this Database will be created. Format: projects/{project_id}/branches/{branch_id} + :param database: :class:`Database` + The desired specification of a Database. + :param database_id: str (optional) + The ID to use for the Database, which will become the final component of the database's resource + name. This ID becomes the database name in postgres. + + This value should be 4-63 characters, and only use characters available in DNS names, as defined by + RFC-1123 + + If database_id is not specified in the request, it is generated automatically. + :param replace_existing: bool (optional) + If true, update the database if it already exists instead of returning an error. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Database will be created. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Database will be created. Format: projects/{project_id}/branches/{branch_id}' + - name: database_id + in: query + required: false + schema: + type: string + description: The ID to use for the Database, which will become the final component of the database's resource name. + This ID becomes the database name in postgres. This value should be 4-63 characters, and only use characters available + in DNS names, as defined by RFC-1123 If database_id is not specified in the request, it is generated automatically. + - name: replace_existing + in: query + required: false + schema: + type: boolean + description: If true, update the database if it already exists instead of returning an error. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: A timestamp indicating when the database was created. + database_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + name: + type: string + description: 'The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + parent: + type: string + description: 'The branch containing this database. Format: projects/{project_id}/branches/{branch_id}' + spec: + type: object + properties: + role: + type: string + postgres_database: + type: string + description: The name of the Postgres database. This expects a valid Postgres identifier as specified + in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS + Required when creating the Database. To rename, pass a valid postgres identifier when updating the + Database. + required: + - role + description: The desired state of the Database. + status: + type: object + properties: + database_id: + type: string + postgres_database: + type: string + description: The name of the Postgres database. + role: + type: string + description: 'The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + description: The observed state of the Database. + update_time: + type: string + format: date-time + description: A timestamp indicating when the database was last updated. responses: '200': description: Success @@ -837,12 +1151,20 @@ paths: :returns: Iterator over :class:`Database` parameters: - - name: parent + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id in: path required: true schema: type: string - description: 'The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}' + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of databases. Format: projects/{project_id}/branches/{branch_id}' - name: page_size in: query required: false @@ -874,7 +1196,7 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/endpoints: + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/endpoints: post: operationId: postgres_create_endpoint summary: Creates a new compute endpoint in the branch. @@ -897,12 +1219,20 @@ paths: :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Branch where this Endpoint will be created. Format: projects/{project_id}/branches/{branch_id}' + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Endpoint will be created. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Endpoint will be created. Format: projects/{project_id}/branches/{branch_id}' - name: endpoint_id in: query required: true @@ -923,188 +1253,180 @@ paths: schema: type: object properties: - endpoint: - type: object - properties: - create_time: + create_time: + type: string + format: date-time + endpoint_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + name: + type: string + description: 'Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + parent: + type: string + description: 'The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}' + spec: + type: object + properties: + endpoint_type: type: string - format: date-time - endpoint_id: + x-enum: + - ENDPOINT_TYPE_READ_ONLY + - ENDPOINT_TYPE_READ_WRITE + description: The compute endpoint type. Either ``read_write`` or ``read_only``. + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units. The maximum value is 64. The difference between the + minimum and maximum Compute Units (max - min) must not exceed 16. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. Minimum value is 0.5. + disabled: + type: boolean + description: Whether to restrict connections to the compute endpoint. Enabling this option schedules + a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console + action. + group: + type: object + properties: + min: + type: integer + max: + type: integer + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: + type: boolean + description: Whether to allow read-only connections to read-write endpoints. Only relevant for read-write + endpoints where size.max > 1. + required: + - min + - max + description: Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults + to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write + endpoints). + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should be set + to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + settings: + type: object + properties: + pg_settings: + type: object + description: A raw representation of Postgres settings. + description: A collection of settings for a compute endpoint. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. If + specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + required: + - endpoint_type + description: The spec contains the compute endpoint configuration, including autoscaling limits, suspend + timeout, and disabled state. + status: + type: object + properties: + autoscaling_limit_max_cu: + type: number + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. + current_state: type: string - description: The part of the name, chosen by the user when the resource was created. - name: + x-enum: + - ACTIVE + - DEGRADED + - IDLE + - INIT + description: The state of the compute endpoint. + disabled: + type: boolean + description: Whether to restrict connections to the compute endpoint. Enabling this option schedules + a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console + action. + endpoint_id: type: string - description: 'Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' - parent: + description: Part of the resource name. + endpoint_type: type: string - description: 'The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}' - spec: + x-enum: + - ENDPOINT_TYPE_READ_ONLY + - ENDPOINT_TYPE_READ_WRITE + description: The endpoint type. A branch can only have one READ_WRITE endpoint. + group: type: object properties: - endpoint_type: - type: string - x-enum: - - ENDPOINT_TYPE_READ_ONLY - - ENDPOINT_TYPE_READ_WRITE - description: The compute endpoint type. Either ``read_write`` or ``read_only``. - autoscaling_limit_max_cu: - type: number - description: The maximum number of Compute Units. The maximum value is 64. The difference between - the minimum and maximum Compute Units (max - min) must not exceed 16. - autoscaling_limit_min_cu: - type: number - description: The minimum number of Compute Units. Minimum value is 0.5. - disabled: - type: boolean - description: Whether to restrict connections to the compute endpoint. Enabling this option schedules - a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or - console action. - group: - type: object - properties: - min: - type: integer - max: - type: integer - description: The maximum number of computes in the endpoint group. Currently, this must be equal - to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes - in an endpoint group, set disabled to true on the EndpointSpec. - enable_readable_secondaries: - type: boolean - description: Whether to allow read-only connections to read-write endpoints. Only relevant for - read-write endpoints where size.max > 1. - required: - - min - - max - description: Settings for optional HA configuration of the endpoint. If unspecified, the endpoint - defaults to non HA settings, with a single compute backing the endpoint (and no readable secondaries - for Read/Write endpoints). - no_suspension: + min: + type: integer + max: + type: integer + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: type: boolean - description: When set to true, explicitly disables automatic suspension (never suspend). Should - be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. When updating, - use ``spec.suspension`` in the update_mask. - settings: - type: object - properties: - pg_settings: - type: object - description: A raw representation of Postgres settings. - description: A collection of settings for a compute endpoint. - suspend_timeout_duration: - type: string - description: Duration of inactivity after which the compute endpoint is automatically suspended. - If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. - When updating, use ``spec.suspension`` in the update_mask. + description: Whether read-only connections to read-write endpoints are allowed. Only relevant if + read replicas are configured by specifying size.max > 1. required: - - endpoint_type - description: The spec contains the compute endpoint configuration, including autoscaling limits, suspend - timeout, and disabled state. - status: + - min + - max + description: Details on the HA configuration of the endpoint. + hosts: type: object properties: - autoscaling_limit_max_cu: - type: number - autoscaling_limit_min_cu: - type: number - description: The minimum number of Compute Units. - current_state: - type: string - x-enum: - - ACTIVE - - DEGRADED - - IDLE - - INIT - description: The state of the compute endpoint. - disabled: - type: boolean - description: Whether to restrict connections to the compute endpoint. Enabling this option schedules - a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or - console action. - endpoint_id: - type: string - description: Part of the resource name. - endpoint_type: + host: type: string - x-enum: - - ENDPOINT_TYPE_READ_ONLY - - ENDPOINT_TYPE_READ_WRITE - description: The endpoint type. A branch can only have one READ_WRITE endpoint. - group: - type: object - properties: - min: - type: integer - max: - type: integer - description: The maximum number of computes in the endpoint group. Currently, this must be equal - to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes - in an endpoint group, set disabled to true on the EndpointSpec. - enable_readable_secondaries: - type: boolean - description: Whether read-only connections to read-write endpoints are allowed. Only relevant - if read replicas are configured by specifying size.max > 1. - required: - - min - - max - description: Details on the HA configuration of the endpoint. - hosts: - type: object - properties: - host: - type: string - description: The hostname to connect to this endpoint. For read-write endpoints, this is a read-write - hostname which connects to the primary compute. For read-only endpoints, this is a read-only - hostname which allows read-only operations. - read_only_host: - type: string - description: An optionally defined read-only host for the endpoint, without pooling. For read-only - endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, - this attribute is defined if the enclosing endpoint is a group with greater than 1 computes - configured, and has readable secondaries enabled. - read_only_pooled_host: - type: string - description: The read-only hostname of the compute endpoint, with pooling. This attribute is - always defined for read-only endpoints, and may be defined for read-write endpoints if configured - with read replicas and allow read-only connections. - read_write_pooled_host: - type: string - description: The read-write hostname of the compute endpoint, with pooling. This attribute is - only defined for read-write endpoints. - description: Contains host information for connecting to the endpoint. - last_active_time: + description: The hostname to connect to this endpoint. For read-write endpoints, this is a read-write + hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname + which allows read-only operations. + read_only_host: type: string - format: date-time - description: A timestamp indicating when the compute endpoint was last active. - pending_state: + description: An optionally defined read-only host for the endpoint, without pooling. For read-only + endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, + this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, + and has readable secondaries enabled. + read_only_pooled_host: type: string - x-enum: - - ACTIVE - - DEGRADED - - IDLE - - INIT - description: The state of the compute endpoint. - settings: - type: object - properties: - pg_settings: - type: object - description: A raw representation of Postgres settings. - description: A collection of settings for a compute endpoint. - suspend_timeout_duration: + description: The read-only hostname of the compute endpoint, with pooling. This attribute is always + defined for read-only endpoints, and may be defined for read-write endpoints if configured with + read replicas and allow read-only connections. + read_write_pooled_host: type: string - description: Duration of inactivity after which the compute endpoint is automatically suspended. - description: Current operational status of the compute endpoint. - uid: - type: string - description: System-generated unique ID for the endpoint. - update_time: + description: The read-write hostname of the compute endpoint, with pooling. This attribute is only + defined for read-write endpoints. + description: Contains host information for connecting to the endpoint. + last_active_time: type: string format: date-time - description: A timestamp indicating when the compute endpoint was last updated. - description: The Endpoint to create. - required: - - endpoint + description: A timestamp indicating when the compute endpoint was last active. + pending_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - IDLE + - INIT + description: The state of the compute endpoint. + settings: + type: object + properties: + pg_settings: + type: object + description: A raw representation of Postgres settings. + description: A collection of settings for a compute endpoint. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. + description: Current operational status of the compute endpoint. + uid: + type: string + description: System-generated unique ID for the endpoint. + update_time: + type: string + format: date-time + description: A timestamp indicating when the compute endpoint was last updated. responses: '200': description: Success @@ -1142,12 +1464,20 @@ paths: :returns: Iterator over :class:`Endpoint` parameters: - - name: parent + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id in: path required: true schema: type: string - description: 'The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}' + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}' - name: page_size in: query required: false @@ -1212,309 +1542,1445 @@ paths: schema: type: object properties: - project: + create_time: + type: string + format: date-time + delete_time: + type: string + format: date-time + description: A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, + otherwise set to a timestamp in the past. + initial_branch_spec: type: object properties: - create_time: - type: string - format: date-time - delete_time: - type: string - format: date-time - description: A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, - otherwise set to a timestamp in the past. - initial_branch_spec: + is_protected: + type: boolean + description: Whether the initial default branch should be protected from deletion. + description: Configuration for the initial default branch created as part of project creation. Allows overriding + branch protection. These settings only apply at creation time and do not affect resources created after + project creation. + initial_endpoint_spec: + type: object + properties: + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units for the initial endpoint. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units for the initial endpoint. + group: type: object properties: - is_protected: + min: + type: integer + max: + type: integer + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: type: boolean - description: Whether the initial default branch should be protected from deletion. - description: Configuration for the initial default branch created as part of project creation. Allows - overriding branch protection. These settings only apply at creation time and do not affect resources - created after project creation. - initial_database_spec: - type: object - properties: - postgres_database: - type: string - description: The name of the Postgres database. This expects a valid Postgres identifier as specified - in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS - description: Configuration for the initial Postgres database created inside the initial branch for this - project. If omitted, the initial branch still gets an initial database with name ``databricks_postgres``. - The initial database is always owned by the initial role (caller-provided via ``initial_role_spec`` - or defaulted to the caller's identity). This field is input-only; to change databases after project - creation, use the standalone Database API. - initial_endpoint_spec: + description: Whether to allow read-only connections to read-write endpoints. Only relevant for read-write + endpoints where size.max > 1. + required: + - min + - max + description: Settings for HA configuration of the endpoint. + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should be set + to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the initial endpoint is automatically suspended. If + specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: Configuration settings for the initial Read/Write endpoint created inside the initial branch + for a newly created project. If omitted, the initial endpoint created will have default settings, without + high availability configured. This field does not apply to any endpoints created after project creation. + Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation. + name: + type: string + description: 'Output only. The full resource path of the project. Format: projects/{project_id}' + project_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + purge_time: + type: string + format: date-time + description: A timestamp indicating when the project is scheduled for permanent deletion. Empty if the project + is not deleted, otherwise set to a timestamp in the future. + spec: + type: object + properties: + budget_policy_id: + type: string + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. + To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear + all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing + tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags). + default_branch: + type: string + description: 'The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}' + default_endpoint_settings: type: object properties: autoscaling_limit_max_cu: type: number - description: The maximum number of Compute Units for the initial endpoint. + description: The maximum number of Compute Units. Minimum value is 0.5. autoscaling_limit_min_cu: type: number - description: The minimum number of Compute Units for the initial endpoint. - group: - type: object - properties: - min: - type: integer - max: - type: integer - description: The maximum number of computes in the endpoint group. Currently, this must be equal - to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes - in an endpoint group, set disabled to true on the EndpointSpec. - enable_readable_secondaries: - type: boolean - description: Whether to allow read-only connections to read-write endpoints. Only relevant for - read-write endpoints where size.max > 1. - required: - - min - - max - description: Settings for HA configuration of the endpoint. + description: The minimum number of Compute Units. Minimum value is 0.5. no_suspension: type: boolean description: When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. - suspend_timeout_duration: - type: string - description: Duration of inactivity after which the initial endpoint is automatically suspended. - If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with - ``no_suspension``. - description: Configuration settings for the initial Read/Write endpoint created inside the initial branch - for a newly created project. If omitted, the initial endpoint created will have default settings, - without high availability configured. This field does not apply to any endpoints created after project - creation. Use spec.default_endpoint_settings to configure default settings for endpoints created after - project creation. - initial_role_spec: - type: object - properties: - attributes: + pg_settings: type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: The desired API-exposed Postgres role attribute to associate with the role. Optional. - auth_method: - type: string - x-enum: - - LAKEBASE_OAUTH_V1 - - NO_LOGIN - - PG_PASSWORD_SCRAM_SHA_256 - description: 'Controls how the Postgres role authenticates when a client opens a database connection. - Supported values: - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth - access token derived from the backing managed identity (the Databricks user, service principal, - or group named by the role''s ``postgres_role``). No static password exists for roles using this - method. - PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres password verified - server-side using the SCRAM-SHA-256 mechanism. Lakebase generates a password for the role. - NO_LOGIN: - the role cannot open a Postgres session at all. Useful for roles that exist only to own objects - or to aggregate privileges that are then granted to other, loginable roles. If auth_method is - left unspecified, a meaningful authentication method is derived from the identity_type: - For - the managed identities, OAUTH is used. - For the regular postgres roles, authentication based - on postgres passwords is used. NOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1 - is the default auth method (group can login as well).' - identity_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: 'The type of role. When specifying a managed-identity, the chosen role_id must be a - valid: - application ID for SERVICE_PRINCIPAL - user email for USER - group name for GROUP' - membership_roles: - type: array - items: - type: string - x-enum: - - DATABRICKS_SUPERUSER - description: Roles that the DatabaseInstanceRole can be a member of. - description: An enum value for a standard role that this role is a member of. - postgres_role: + description: A raw representation of Postgres settings. + suspend_timeout_duration: type: string - description: 'The name of the Postgres role. This expects a valid Postgres identifier as specified - in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS - If you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role - must be one of the following: 1. user email for IdentityType.USER 2. app ID for IdentityType.SERVICE_PRINCIPAL - 3. group name for IdentityType.GROUP' - description: Configuration for the initial Postgres role created inside the initial branch for this - project. If omitted, the initial branch gets an initial role corresponding to the caller of the API - endpoint. This field is input-only; to change roles after project creation, use the standalone Role - API. - name: - type: string - description: 'Output only. The full resource path of the project. Format: projects/{project_id}' - project_id: + description: Duration of inactivity after which the compute endpoint is automatically suspended. + If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: A collection of settings for a compute endpoint. + display_name: type: string - description: The part of the name, chosen by the user when the resource was created. - purge_time: + description: Human-readable project name. Length should be between 1 and 256 characters. + enable_pg_native_login: + type: boolean + description: Whether to enable PG native password login on all endpoints in this project. Defaults to + false. + history_retention_duration: + type: string + description: The number of seconds to retain the shared history for point in time recovery for all branches + in this project. Value should be between 172800s (2 days) and 3024000s (35 days). + pg_version: + type: integer + description: The major Postgres version number. The set of supported versions may vary; consult the + API documentation for currently accepted values. + description: The spec contains the project configuration, including display_name, pg_version (Postgres version), + history_retention_duration, and default_endpoint_settings. + status: + type: object + properties: + branch_logical_size_limit_bytes: + type: integer + budget_policy_id: + type: string + description: The budget policy that is applied to the project. + compute_last_active_time: type: string format: date-time - description: A timestamp indicating when the project is scheduled for permanent deletion. Empty if the - project is not deleted, otherwise set to a timestamp in the future. - spec: + description: The most recent time when any endpoint of this project was active. + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: The effective custom tags associated with the project. + default_branch: + type: string + description: The full resource path of the default branch of the project + default_endpoint_settings: type: object properties: - budget_policy_id: - type: string - compute_provisioner: - type: string - description: The compute provisioner used to provision endpoints in this project. Overrides the - default provisioner when set. - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. - description: Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. - To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To - clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve - existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty - tags). - default_branch: - type: string - description: 'The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}' - default_endpoint_settings: - type: object - properties: - autoscaling_limit_max_cu: - type: number - description: The maximum number of Compute Units. Minimum value is 0.5. - autoscaling_limit_min_cu: - type: number - description: The minimum number of Compute Units. Minimum value is 0.5. - no_suspension: - type: boolean - description: When set to true, explicitly disables automatic suspension (never suspend). Should - be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. When updating, - use ``spec.project_default_settings.suspension`` in the update_mask. - pg_settings: - type: object - description: A raw representation of Postgres settings. - suspend_timeout_duration: - type: string - description: Duration of inactivity after which the compute endpoint is automatically suspended. - If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with - ``no_suspension``. When updating, use ``spec.project_default_settings.suspension`` in the - update_mask. - description: A collection of settings for a compute endpoint. - display_name: - type: string - description: Human-readable project name. Length should be between 1 and 256 characters. - enable_pg_native_login: + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units. Minimum value is 0.5. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. Minimum value is 0.5. + no_suspension: type: boolean - description: Whether to enable PG native password login on all endpoints in this project. Defaults - to false. - history_retention_duration: - type: string - description: The number of seconds to retain the shared history for point in time recovery for all - branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days). - pg_version: - type: integer - description: The major Postgres version number. The set of supported versions may vary; consult - the API documentation for currently accepted values. - description: The spec contains the project configuration, including display_name, pg_version (Postgres - version), history_retention_duration, and default_endpoint_settings. - status: - type: object - properties: - branch_logical_size_limit_bytes: - type: integer - budget_policy_id: - type: string - description: The budget policy that is applied to the project. - compute_last_active_time: - type: string - format: date-time - description: The most recent time when any endpoint of this project was active. - compute_provisioner: - type: string - description: The effective compute provisioner backing this project's endpoints. - custom_tags: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the custom tag. - description: The effective custom tags associated with the project. - default_branch: - type: string - description: The full resource path of the default branch of the project - default_endpoint_settings: + description: When set to true, explicitly disables automatic suspension (never suspend). Should + be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + pg_settings: type: object - properties: - autoscaling_limit_max_cu: - type: number - description: The maximum number of Compute Units. Minimum value is 0.5. - autoscaling_limit_min_cu: - type: number - description: The minimum number of Compute Units. Minimum value is 0.5. - no_suspension: - type: boolean - description: When set to true, explicitly disables automatic suspension (never suspend). Should - be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. When updating, - use ``spec.project_default_settings.suspension`` in the update_mask. - pg_settings: - type: object - description: A raw representation of Postgres settings. - suspend_timeout_duration: - type: string - description: Duration of inactivity after which the compute endpoint is automatically suspended. - If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with - ``no_suspension``. When updating, use ``spec.project_default_settings.suspension`` in the - update_mask. - description: The effective default endpoint settings. - display_name: - type: string - description: The effective human-readable project name. - enable_pg_native_login: - type: boolean - description: Whether to enable PG native password login on all endpoints in this project. - history_retention_duration: - type: string - description: The effective number of seconds to retain the shared history for point in time recovery. - owner: - type: string - description: The email of the project owner. - pg_version: - type: integer - description: The effective major Postgres version number. - project_id: - type: string - description: Part of the resource name. - replication_role: + description: A raw representation of Postgres settings. + suspend_timeout_duration: type: string - x-enum: - - REPLICATION_ROLE_PREVIEW_DEMOTING - - REPLICATION_ROLE_PREVIEW_PRIMARY - - REPLICATION_ROLE_PREVIEW_SECONDARY - description: The replication role of the project in this workspace. Populated only when cross-workspace - replication is configured. - synthetic_storage_size_bytes: - type: integer - description: The current space occupied by the project in storage. - description: The current status of a Project. - uid: + description: Duration of inactivity after which the compute endpoint is automatically suspended. + If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: The effective default endpoint settings. + display_name: type: string - description: System-generated unique ID for the project. - update_time: + description: The effective human-readable project name. + enable_pg_native_login: + type: boolean + description: Whether to enable PG native password login on all endpoints in this project. + history_retention_duration: type: string - format: date-time - description: A timestamp indicating when the project was last updated. - description: The Project to create. - required: - - project + description: The effective number of seconds to retain the shared history for point in time recovery. + owner: + type: string + description: The email of the project owner. + pg_version: + type: integer + description: The effective major Postgres version number. + project_id: + type: string + description: Part of the resource name. + synthetic_storage_size_bytes: + type: integer + description: The current space occupied by the project in storage. + description: The current status of a Project. + uid: + type: string + description: System-generated unique ID for the project. + update_time: + type: string + format: date-time + description: A timestamp indicating when the project was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_list_projects + summary: Returns a paginated list of database projects in the workspace that the user has permission to access. + tags: + - postgres + description: |- + Returns a paginated list of database projects in the workspace that the user has permission to access. + + :param page_size: int (optional) + Upper bound for items returned. Cannot be negative. The maximum value is 100. + :param page_token: str (optional) + Page token from a previous response. If not provided, returns the first page. + :param show_deleted: bool (optional) + Whether to include soft-deleted projects in the response. When true, soft-deleted projects are + included alongside active projects. Hard-deleted and already-purged projects are never returned. + + :returns: Iterator over :class:`Project` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + description: Upper bound for items returned. Cannot be negative. The maximum value is 100. + - name: page_token + in: query + required: false + schema: + type: string + description: Page token from a previous response. If not provided, returns the first page. + - name: show_deleted + in: query + required: false + schema: + type: boolean + description: Whether to include soft-deleted projects in the response. When true, soft-deleted projects are included + alongside active projects. Hard-deleted and already-purged projects are never returned. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListProjectsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/roles: + post: + operationId: postgres_create_role + summary: Creates a new Postgres role in the branch. + tags: + - postgres + description: |- + Creates a new Postgres role in the branch. + + :param parent: str + The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id} + :param role: :class:`Role` + The desired specification of a Role. + :param replace_existing: bool (optional) + If true, update the role if it already exists instead of returning an error. + + When the role already exists, the provided ``role`` spec fully replaces the existing one: + ``membership_roles`` is overwritten, not merged. Leaving ``membership_roles`` empty clears all of + the role's existing memberships, including ``DATABRICKS_SUPERUSER``. Always send the complete + desired list of memberships when using this field. + :param role_id: str (optional) + The ID to use for the Role, which will become the final component of the role's resource name. This + ID becomes the role in Postgres. + + This value should be 4-63 characters, and valid characters are lowercase letters, numbers, and + hyphens, as defined by RFC 1123. + + If role_id is not specified in the request, it is generated automatically. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id}' + - name: replace_existing + in: query + required: false + schema: + type: boolean + description: 'If true, update the role if it already exists instead of returning an error. When the role already exists, + the provided ``role`` spec fully replaces the existing one: ``membership_roles`` is overwritten, not merged. Leaving + ``membership_roles`` empty clears all of the role''s existing memberships, including ``DATABRICKS_SUPERUSER``. Always + send the complete desired list of memberships when using this field.' + - name: role_id + in: query + required: false + schema: + type: string + description: The ID to use for the Role, which will become the final component of the role's resource name. This ID + becomes the role in Postgres. This value should be 4-63 characters, and valid characters are lowercase letters, + numbers, and hyphens, as defined by RFC 1123. If role_id is not specified in the request, it is generated automatically. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + name: + type: string + description: 'Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + parent: + type: string + description: 'The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}' + role_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + spec: + type: object + properties: + attributes: + type: object + properties: + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: |- + Attributes that can be granted to a Postgres role. We are only implementing a subset for now, + see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres + keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical + underscores between words. + auth_method: + type: string + x-enum: + - LAKEBASE_OAUTH_V1 + - NO_LOGIN + - PG_PASSWORD_SCRAM_SHA_256 + description: 'Controls how the Postgres role authenticates when a client opens a database connection. + Supported values: - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth access + token derived from the backing managed identity (the Databricks user, service principal, or group + named by the role''s ``postgres_role``). No static password exists for roles using this method. - + PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres password verified server-side using + the SCRAM-SHA-256 mechanism. Lakebase generates a password for the role. - NO_LOGIN: the role cannot + open a Postgres session at all. Useful for roles that exist only to own objects or to aggregate privileges + that are then granted to other, loginable roles. If auth_method is left unspecified, a meaningful + authentication method is derived from the identity_type: - For the managed identities, OAUTH is used. + - For the regular postgres roles, authentication based on postgres passwords is used. NOTE: for the + Databricks identity type GROUP, LAKEBASE_OAUTH_V1 is the default auth method (group can login as well).' + identity_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: 'The type of role. When specifying a managed-identity, the chosen role_id must be a valid: + - application ID for SERVICE_PRINCIPAL - user email for USER - group name for GROUP' + membership_roles: + type: array + items: + type: string + x-enum: + - DATABRICKS_SUPERUSER + description: Roles that the DatabaseInstanceRole can be a member of. + description: An enum value for a standard role that this role is a member of. + postgres_role: + type: string + description: 'The name of the Postgres role. This expects a valid Postgres identifier as specified in + the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS + Required when creating the Role. If you wish to create a Postgres Role backed by a managed Databricks + identity, then postgres_role must be one of the following: 1. user email for IdentityType.USER 2. + app ID for IdentityType.SERVICE_PRINCIPAL 3. group name for IdentityType.GROUP' + description: The spec contains the role configuration, including identity type, authentication method, and + role attributes. + status: + type: object + properties: + attributes: + type: object + properties: + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: |- + Attributes that can be granted to a Postgres role. We are only implementing a subset for now, + see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres + keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical + underscores between words. + auth_method: + type: string + x-enum: + - LAKEBASE_OAUTH_V1 + - NO_LOGIN + - PG_PASSWORD_SCRAM_SHA_256 + description: How the role is authenticated when connecting to Postgres. + identity_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the role. + membership_roles: + type: array + items: + type: string + x-enum: + - DATABRICKS_SUPERUSER + description: Roles that the DatabaseInstanceRole can be a member of. + description: An enum value for a standard role that this role is a member of. + postgres_role: + type: string + description: The name of the Postgres role. + role_id: + type: string + description: Part of the resource name. + description: Current status of the role, including its identity type, authentication method, and role attributes. + update_time: + type: string + format: date-time + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_list_roles + summary: Returns a paginated list of Postgres roles in the branch. + tags: + - postgres + description: |- + Returns a paginated list of Postgres roles in the branch. + + :param parent: str + The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id} + :param page_size: int (optional) + Upper bound for items returned. Cannot be negative. + :param page_token: str (optional) + Page token from a previous response. If not provided, returns the first page. + + :returns: Iterator over :class:`Role` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `parent` resource name (`projects/{project_id}/branches/{branch_id}`). + The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}' + - name: page_size + in: query + required: false + schema: + type: integer + description: Upper bound for items returned. Cannot be negative. + - name: page_token + in: query + required: false + schema: + type: string + description: Page token from a previous response. If not provided, returns the first page. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project_id}/snapshots: + post: + operationId: postgres_create_snapshot + summary: Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. + tags: + - postgres + description: |- + Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. + + :param parent: str + The project in which to create the snapshot. Format: projects/{project_id} + :param snapshot: :class:`Snapshot` + The snapshot to create. + :param snapshot_id: str + Client-chosen ID for the snapshot. It becomes the final segment of the snapshot resource name and + cannot be changed after creation. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}`). The project in which + to create the snapshot. Format: projects/{project_id}' + - name: snapshot_id + in: query + required: true + schema: + type: string + description: Client-chosen ID for the snapshot. It becomes the final segment of the snapshot resource name and cannot + be changed after creation. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: When the snapshot was created. + name: + type: string + description: 'The resource name of the snapshot. Format: projects/{project_id}/snapshots/{snapshot_id}' + snapshot_id: + type: string + description: The user-chosen ID; the final segment of ``name``. + spec: + type: object + properties: + source_branch: + type: string + description: 'The source branch to snapshot. Format: projects/{project_id}/branches/{branch_id}' + expire_time: + type: string + format: date-time + description: Absolute time at which the snapshot is deleted. Mutually exclusive with ``ttl`` and ``no_expiry``. + no_expiry: + type: boolean + description: If true, the snapshot never expires. Mutually exclusive with ``ttl`` and ``expire_time``. + source_branch_lsn: + type: string + description: LSN to snapshot from, e.g. ``16/B374D848``. Mutually exclusive with ``source_branch_time``. + source_branch_time: + type: string + format: date-time + description: Timestamp to snapshot from. Mutually exclusive with ``source_branch_lsn``. + ttl: + type: string + description: Time-to-live. The snapshot expires this long after it is created. Mutually exclusive with + ``expire_time`` and ``no_expiry``. Reads report the resolved absolute ``expire_time`` instead. + required: + - source_branch + description: Client-provided configuration of the snapshot. + status: + type: object + properties: + diff_size_bytes: + type: integer + description: Incremental storage size in bytes since the previous snapshot. Unset when the snapshot + is not billed on incremental usage. + expire_time: + type: string + format: date-time + description: Absolute time at which the snapshot is deleted. + full_size_bytes: + type: integer + description: Full logical size of the snapshot, in bytes. + no_expiry: + type: boolean + description: True if the snapshot never expires. + source_branch: + type: string + description: 'The source branch the snapshot was taken from. Format: projects/{project_id}/branches/{branch_id}' + description: Server-observed state of the snapshot. + uid: + type: string + description: Unique system-generated ID for the snapshot. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_list_snapshots + summary: Returns a paginated list of snapshots in the project. + tags: + - postgres + description: |- + Returns a paginated list of snapshots in the project. + + :param parent: str + The project that owns the snapshots. Format: projects/{project_id} + :param page_size: int (optional) + Maximum number of snapshots to return per page. + :param page_token: str (optional) + Page token from a previous response; omit for the first page. + + :returns: Iterator over :class:`Snapshot` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `parent` resource name (`projects/{project_id}`). The project that owns + the snapshots. Format: projects/{project_id}' + - name: page_size + in: query + required: false + schema: + type: integer + description: Maximum number of snapshots to return per page. + - name: page_token + in: query + required: false + schema: + type: string + description: Page token from a previous response; omit for the first page. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListSnapshotsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/synced_tables: + post: + operationId: postgres_create_synced_table + summary: Create a Synced Table. + tags: + - postgres + description: |- + Create a Synced Table. + + :param synced_table: :class:`SyncedTable` + :param synced_table_id: str + The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource + name. ID is required and is the synced table name, containing (catalog, schema, table) tuple. + Elements of the tuple are the UC entity names. + + Example: "{catalog}.{schema}.{table}" + + synced_table_id represents both of the following: + + 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation. + 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database + + :returns: :class:`Operation` + parameters: + - name: synced_table_id + in: query + required: true + schema: + type: string + description: 'The ID to use for the Synced Table. This becomes the final component of the SyncedTable''s resource + name. ID is required and is the synced table name, containing (catalog, schema, table) tuple. Elements of the tuple + are the UC entity names. Example: "{catalog}.{schema}.{table}" synced_table_id represents both of the following: + 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation. 2. Postgres table + named "{table}" in schema "{schema}" in the connected Postgres database' + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + name: + type: string + description: Output only. The Full resource name of the synced table in Postgres where (catalog, schema, + table) are the UC entity names. Format "synced_tables/{catalog}.{schema}.{table}" For the corresponding + source table in the Unity catalog look for the "source_table_full_name" attribute. + spec: + type: object + properties: + accelerated_sync: + type: boolean + branch: + type: string + description: 'The full resource name the branch associated with the table. Format: "projects/{project_id}/branches/{branch_id}".' + create_database_objects_if_missing: + type: boolean + description: If true, the synced table's logical database and schema resources in PG will be created + if they do not already exist. The request will fail if this is false and the database/schema do not + exist. Defaults to true if omitted. + existing_pipeline_id: + type: string + description: ID of an existing pipeline to bin-pack this synced table into. At most one of existing_pipeline_id + and new_pipeline_spec should be defined. The pipeline used for the synced table is returned via the + top level pipeline_id attribute. + extra_columns: + type: array + items: + type: object + properties: + column_name: + type: string + description: Name of the column. + column_type: + type: string + description: PostgreSQL type of the column, for example "tsvector" or "vector(1024)". + compute: + type: string + description: SQL expression used to compute the column's value, for example "to_tsvector('english', + content)". + maintenance: + type: string + x-enum: + - STORED_GENERATED + description: How the column's value is populated and kept up to date. + required: + - column_name + - column_type + description: An extra PostgreSQL column to add to the synced table. + description: Extra PostgreSQL-only columns to add to the synced table. + new_pipeline_spec: + type: object + properties: + budget_policy_id: + type: string + pipeline_channel: + type: string + x-enum: + - CURRENT + - PREVIEW + description: Release channel of the underlying pipeline's runtime. Some source table configurations + (e.g., read-time CDF) require PREVIEW. Defaults to CURRENT if not specified. + storage_catalog: + type: string + description: UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). + This needs to be a standard catalog where the user has permissions to create Delta tables. + storage_schema: + type: string + description: UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). + This needs to be in the standard catalog where the user has permissions to create Delta tables. + description: Specification for creating a new pipeline. At most one of existing_pipeline_id and new_pipeline_spec + should be defined. The pipeline used for the synced table is returned via the top level pipeline_id + attribute. + postgres_database: + type: string + description: The Postgres database name where the synced table will be created in. If this synced table + is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred from + the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, + the value must match. A value must be specified when creating a synced table inside a Standard Catalog. + primary_key_columns: + type: array + items: + type: string + description: Primary Key columns to be used for data insert/update in the destination. + scheduling_policy: + type: string + x-enum: + - CONTINUOUS + - SNAPSHOT + - TRIGGERED + description: Scheduling policy of the underlying pipeline. + source_table_full_name: + type: string + description: 'Three-part (catalog, schema, table) name of the source Delta table. For the corresponding + destination table, use any of the two: - synced_table_id used at the creation of the SyncedTable - + "name" consisting of "synced_tables/" prefix and the full name of the destination table.' + timeseries_key: + type: string + description: Time series key to deduplicate (tie-break) rows with the same primary key. + type_overrides: + type: array + items: + type: object + properties: + column_name: + type: string + description: Name of the source column whose target PostgreSQL type should be overridden. + pg_type: + type: string + x-enum: + - PG_SPECIFIC_TYPE_HALFVEC + - PG_SPECIFIC_TYPE_VARCHAR + - PG_SPECIFIC_TYPE_VECTOR + description: PostgreSQL-specific target type to use for the column. + size: + type: integer + description: Size parameter for the target type, for types that take one (e.g. vector dimension, + varchar length). Required when the chosen pg_type needs a size. + required: + - column_name + - pg_type + description: Overrides the default Delta-to-PostgreSQL type mapping for a single column. + description: Override the default Delta->PG type mapping for specific columns. A TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED + is rejected; a valid pg_type must be set. + description: Configuration details of the synced table, such as the source table, scheduling policy, etc. + status: + type: object + properties: + detailed_state: + type: string + x-enum: + - SYNCED_TABLE_OFFLINE + - SYNCED_TABLE_OFFLINE_FAILED + - SYNCED_TABLE_ONLINE + - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE + - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE + - SYNCED_TABLE_ONLINE_PIPELINE_FAILED + - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE + - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES + - SYNCED_TABLE_PROVISIONING + - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT + - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES + description: The state of a synced table. + last_processed_commit_version: + type: integer + description: The last source table Delta version that was successfully synced to the synced table. + last_sync: + type: object + properties: + delta_table_sync_info: + type: object + properties: + delta_commit_time: + type: string + format: date-time + delta_commit_version: + type: integer + description: The Delta Lake commit version that was last successfully synced. + sync_end_time: + type: string + format: date-time + description: The end timestamp of the most recent successful synchronization. This is the time when + the data is available in the synced table. + sync_start_time: + type: string + format: date-time + description: The starting timestamp of the most recent successful synchronization from the source + table to the destination (synced) table. Note this is the starting timestamp of the sync operation, + not the end time. E.g., for a batch, this is the time when the sync operation started. + description: Summary of the last successful synchronization from source to destination. + last_sync_time: + type: string + format: date-time + description: The end timestamp of the last time any data was synchronized from the source table to the + synced table. This is when the data is available in the synced table. + message: + type: string + description: A text description of the current state of the synced table. + ongoing_sync_progress: + type: object + properties: + estimated_completion_time_seconds: + type: number + description: The estimated time remaining to complete this update in seconds. + latest_version_currently_processing: + type: integer + description: The source table Delta version that was last processed by the pipeline. The pipeline + may not have completely processed this version yet. + sync_progress_completion: + type: number + description: The completion ratio of this update. This is a number between 0 and 1. + synced_row_count: + type: integer + description: The number of rows that have been synced in this update. + total_row_count: + type: integer + description: The total number of rows that need to be synced in this update. This number may be + an estimate. + description: Progress information of the Synced Table data synchronization pipeline. + pipeline_id: + type: string + description: ID of the associated pipeline. + project: + type: string + description: 'The full resource name of the project associated with the table. Format: "projects/{project_id}".' + provisioning_phase: + type: string + x-enum: + - PROVISIONING_PHASE_INDEX_SCAN + - PROVISIONING_PHASE_INDEX_SORT + - PROVISIONING_PHASE_MAIN + description: The current phase of the data synchronization pipeline. + unity_catalog_provisioning_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - DELETING + - FAILED + - PROVISIONING + - UPDATING + description: The provisioning state of the synced table entity in Unity Catalog. + description: Synced Table data synchronization status. + synced_table_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + uid: + type: string + description: The Unity Catalog table ID for this synced table. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}: + delete: + operationId: postgres_delete_branch + summary: Deletes the specified database branch. + tags: + - postgres + description: |- + Deletes the specified database branch. + + :param name: str + The full resource path of the branch to delete. Format: projects/{project_id}/branches/{branch_id} + :param purge: bool (optional) + If true, permanently delete the branch; if false, soft delete. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to delete. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to delete. Format: projects/{project_id}/branches/{branch_id}' + - name: purge + in: query + required: false + schema: + type: boolean + description: If true, permanently delete the branch; if false, soft delete. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_get_branch + summary: Retrieves information about the specified database branch. + tags: + - postgres + description: |- + Retrieves information about the specified database branch. + + :param name: str + The full resource path of the branch to retrieve. Format: projects/{project_id}/branches/{branch_id} + + :returns: :class:`Branch` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to retrieve. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to retrieve. Format: projects/{project_id}/branches/{branch_id}' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Branch' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + patch: + operationId: postgres_update_branch + summary: Updates the specified database branch. You can set this branch as the project's default branch, or + tags: + - postgres + description: |- + Updates the specified database branch. You can set this branch as the project's default branch, or + protect/unprotect it. + + :param name: str + Output only. The full resource path of the branch. Format: + projects/{project_id}/branches/{branch_id} + :param branch: :class:`Branch` + The Branch to update. + + The branch's ``name`` field is used to identify the branch to update. Format: + projects/{project_id}/branches/{branch_id} + :param update_mask: FieldMask + The list of fields to update. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + Output only. The full resource path of the branch. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + Output only. The full resource path of the branch. Format: projects/{project_id}/branches/{branch_id}' + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. + requestBody: + content: + application/json: + schema: + type: object + properties: + branch_id: + type: string + create_time: + type: string + format: date-time + description: A timestamp indicating when the branch was created. + name: + type: string + description: 'Output only. The full resource path of the branch. Format: projects/{project_id}/branches/{branch_id}' + parent: + type: string + description: 'The project containing this branch (API resource hierarchy). Format: projects/{project_id} + Note: This field indicates where the branch exists in the resource hierarchy. For point-in-time branching + from another branch, see ``status.source_branch``.' + spec: + type: object + properties: + expire_time: + type: string + format: date-time + is_protected: + type: boolean + description: When set to true, protects the branch from deletion and reset. Associated compute endpoints + and the project cannot be deleted while the branch is protected. + no_expiry: + type: boolean + description: Explicitly disable expiration. When set to true, the branch will not expire. If set to + false, the request is invalid; provide either ttl or expire_time instead. Mutually exclusive with + ``expire_time`` and ``ttl``. + source_branch: + type: string + description: 'The name of the source branch from which this branch was created (data lineage for point-in-time + recovery). If not specified, defaults to the project''s default branch. Format: projects/{project_id}/branches/{branch_id}' + source_branch_lsn: + type: string + description: The Log Sequence Number (LSN) on the source branch from which this branch was created. + source_branch_time: + type: string + format: date-time + description: The point in time on the source branch from which this branch was created. + source_snapshot: + type: string + description: 'The snapshot this branch was created from. When set, the branch''s data comes from the + snapshot rather than a source branch, so source_branch, source_branch_lsn, and source_branch_time + must be empty. The snapshot must be AVAILABLE and belong to this branch''s project. Format: projects/{project_id}/snapshots/{snapshot_id}' + ttl: + type: string + description: Relative time-to-live duration. When set, the branch will expire at creation_time + ttl. + Mutually exclusive with ``expire_time`` and ``no_expiry``. + description: The spec contains the branch configuration. + status: + type: object + properties: + branch_id: + type: string + current_state: + type: string + x-enum: + - ARCHIVED + - DELETED + - IMPORTING + - INIT + - READY + - RESETTING + description: The branch's state, indicating if it is initializing, ready for use, or archived. + default: + type: boolean + description: Whether the branch is the project's default branch. + delete_time: + type: string + format: date-time + description: A timestamp indicating when the branch was deleted. Empty if the branch is not deleted. + expire_time: + type: string + format: date-time + description: Absolute expiration time for the branch. Empty if expiration is disabled. + is_protected: + type: boolean + description: Whether the branch is protected. + logical_size_bytes: + type: integer + description: The logical size of the branch. + pending_state: + type: string + x-enum: + - ARCHIVED + - DELETED + - IMPORTING + - INIT + - READY + - RESETTING + description: The pending state of the branch, if a state transition is in progress. + purge_time: + type: string + format: date-time + description: A timestamp indicating when the branch is scheduled to be purged. Empty if the branch is + not deleted, otherwise set to a timestamp in the future. + source_branch: + type: string + description: 'The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}' + source_branch_lsn: + type: string + description: The Log Sequence Number (LSN) on the source branch from which this branch was created. + source_branch_time: + type: string + format: date-time + description: The point in time on the source branch from which this branch was created. + source_snapshot: + type: string + description: 'The snapshot this branch was restored from. Set only for branches created by restoring + a snapshot; unset for all other branches. Format: projects/{project_id}/snapshots/{snapshot_id}' + state_change_time: + type: string + format: date-time + description: A timestamp indicating when the ``current_state`` began. + description: The current status of a Branch. + uid: + type: string + description: System-generated unique ID for the branch. + update_time: + type: string + format: date-time + description: A timestamp indicating when the branch was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/catalogs/{catalog_id}: + delete: + operationId: postgres_delete_catalog + summary: Delete a Database Catalog. + tags: + - postgres + description: |- + Delete a Database Catalog. + + :param name: str + The full resource path of the catalog to delete. + + Format: "catalogs/{catalog_id}". + + :returns: :class:`Operation` + parameters: + - name: catalog_id + in: path + required: true + schema: + type: string + description: 'The `catalog_id` segment of the `name` resource name (`catalogs/{catalog_id}`). The full resource path + of the catalog to delete. Format: "catalogs/{catalog_id}".' + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_get_catalog + summary: Get a Database Catalog. + tags: + - postgres + description: |- + Get a Database Catalog. + + :param name: str + The full resource path of the catalog to retrieve. + + Format: "catalogs/{catalog_id}". + + :returns: :class:`Catalog` + parameters: + - name: catalog_id + in: path + required: true + schema: + type: string + description: 'The `catalog_id` segment of the `name` resource name (`catalogs/{catalog_id}`). The full resource path + of the catalog to retrieve. Format: "catalogs/{catalog_id}".' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Catalog' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}: + delete: + operationId: postgres_delete_cdf_config + summary: Delete a CDF configuration and stop materializing the change data feed. When force=true, also drops + tags: + - postgres + description: |- + Delete a CDF configuration and stop materializing the change data feed. When force=true, also drops + the Delta tables in Unity Catalog. When force=false (default), the existing tables are preserved at + their last state. + + :param name: str + The resource name of the CdfConfig to delete. Format: + projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config} + :param force: bool (optional) + When true, also drops the replicated Delta tables in Unity Catalog. When false (the default), the + replicated tables are preserved at their last synced state. + + :returns: :class:`Operation` + parameters: + - name: project + in: path + required: true + schema: + type: string + description: 'The `project` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to delete. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: branch + in: path + required: true + schema: + type: string + description: 'The `branch` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to delete. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: database + in: path + required: true + schema: + type: string + description: 'The `database` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to delete. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: cdf_config + in: path + required: true + schema: + type: string + description: 'The `cdf_config` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to delete. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: force + in: query + required: false + schema: + type: boolean + description: When true, also drops the replicated Delta tables in Unity Catalog. When false (the default), the replicated + tables are preserved at their last synced state. responses: '200': description: Success @@ -1535,49 +3001,55 @@ paths: type: string x-stackql-sdk-source: PostgresAPI get: - operationId: postgres_list_projects - summary: Returns a paginated list of database projects in the workspace that the user has permission to access. + operationId: postgres_get_cdf_config + summary: Get a single Lakebase CDF configuration, including the source Postgres schema and target Unity Catalog tags: - postgres description: |- - Returns a paginated list of database projects in the workspace that the user has permission to access. + Get a single Lakebase CDF configuration, including the source Postgres schema and target Unity Catalog + schema. - :param page_size: int (optional) - Upper bound for items returned. Cannot be negative. The maximum value is 100. - :param page_token: str (optional) - Page token from a previous response. If not provided, returns the first page. - :param show_deleted: bool (optional) - Whether to include soft-deleted projects in the response. When true, soft-deleted projects are - included alongside active projects. Hard-deleted and already-purged projects are never returned. + :param name: str + The resource name of the CdfConfig to retrieve. Format: + projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config} - :returns: Iterator over :class:`Project` + :returns: :class:`CdfConfig` parameters: - - name: page_size - in: query - required: false + - name: project + in: path + required: true schema: - type: integer - description: Upper bound for items returned. Cannot be negative. The maximum value is 100. - - name: page_token - in: query - required: false + type: string + description: 'The `project` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: branch + in: path + required: true schema: type: string - description: Page token from a previous response. If not provided, returns the first page. - - name: show_deleted - in: query - required: false + description: 'The `branch` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: database + in: path + required: true schema: - type: boolean - description: Whether to include soft-deleted projects in the response. When true, soft-deleted projects are included - alongside active projects. Hard-deleted and already-purged projects are never returned. + type: string + description: 'The `database` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: cdf_config + in: path + required: true + schema: + type: string + description: 'The `cdf_config` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The resource name of the CdfConfig to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListProjectsResponse' + $ref: '#/components/schemas/CdfConfig' default: description: Error response content: @@ -1590,109 +3062,42 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/preview/replication-groups: - post: - operationId: postgres_create_replication_group_preview - summary: Creates a new replication group for the project. + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/databases/{database_id}: + delete: + operationId: postgres_delete_database + summary: Delete a Database. tags: - postgres description: |- - Creates a new replication group for the project. + Delete a Database. - :param parent: str - :param replication_group_preview: :class:`ReplicationGroupPreview` - :param replication_group_preview_id: str - :param request_id: str (optional) + :param name: str + The resource name of the postgres database. Format: + projects/{project_id}/branches/{branch_id}/databases/{database_id} :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - - name: replication_group_preview_id - in: query + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the postgres database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: branch_id + in: path required: true schema: type: string - - name: request_id - in: query - required: false + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the postgres database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: database_id + in: path + required: true schema: type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - replication_group_preview: - type: object - properties: - replication_mode: - type: string - x-enum: - - REPLICATION_MODE_PREVIEW_LIVE - - REPLICATION_MODE_PREVIEW_PERIODIC - description: |- - How changes are propagated from the primary workspace to its secondaries in a replication group: - on a fixed schedule or continuously as they occur. - workspaces: - type: array - items: - type: string - description: The workspaces participating in this replication group. Phase 1 requires exactly 2 entries. - create_time: - type: string - format: date-time - description: Server-generated timestamps. - etag: - type: string - description: Optional optimistic concurrency token for update and delete. - name: - type: string - description: 'The resource name of the replication group. Format: projects/{project_id}/preview/replication-groups/{replication_group_id}' - observed_metrics: - type: object - properties: - as_of_time: - type: string - format: date-time - bytes_lag: - type: integer - description: The most recent observed byte lag. - throughput_bytes_per_second: - type: integer - description: The most recent observed replication throughput. - time_lag: - type: string - description: The most recent observed time lag. - description: The latest observed replication metrics for this group. - parent: - type: string - description: 'The parent project that owns this replication group. Format: projects/{project_id}' - primary_workspace: - type: string - description: The workspace currently serving writes. Server-owned. - state: - type: string - x-enum: - - REPLICATION_GROUP_PREVIEW_STATE_DEGRADED - - REPLICATION_GROUP_PREVIEW_STATE_DELETING - - REPLICATION_GROUP_PREVIEW_STATE_FAILING_OVER - - REPLICATION_GROUP_PREVIEW_STATE_PROVISIONING - - REPLICATION_GROUP_PREVIEW_STATE_READY - - REPLICATION_GROUP_PREVIEW_STATE_SWITCHING_OVER - description: The lifecycle state of the replication group. - update_time: - type: string - format: date-time - required: - - replication_mode - - workspaces - required: - - replication_group_preview + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the postgres database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' responses: '200': description: Success @@ -1713,41 +3118,47 @@ paths: type: string x-stackql-sdk-source: PostgresAPI get: - operationId: postgres_list_replication_group_previews - summary: Returns a paginated list of replication groups for the project. + operationId: postgres_get_database + summary: Get a Database. tags: - postgres description: |- - Returns a paginated list of replication groups for the project. + Get a Database. - :param parent: str - :param page_size: int (optional) - :param page_token: str (optional) + :param name: str + The name of the Database to retrieve. Format: + projects/{project_id}/branches/{branch_id}/databases/{database_id} - :returns: Iterator over :class:`ReplicationGroupPreview` + :returns: :class:`Database` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - - name: page_size - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The name of the Database to retrieve. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: branch_id + in: path + required: true schema: - type: integer - - name: page_token - in: query - required: false + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The name of the Database to retrieve. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: database_id + in: path + required: true schema: type: string + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The name of the Database to retrieve. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListReplicationGroupPreviewsResponse' + $ref: '#/components/schemas/Database' default: description: Error response content: @@ -1760,194 +3171,158 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/roles: - post: - operationId: postgres_create_role - summary: Creates a new Postgres role in the branch. + patch: + operationId: postgres_update_database + summary: Update a Database. tags: - postgres description: |- - Creates a new Postgres role in the branch. - - :param parent: str - The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id} - :param role: :class:`Role` - The desired specification of a Role. - :param replace_existing: bool (optional) - If true, update the role if it already exists instead of returning an error. - - When the role already exists, the provided ``role`` spec fully replaces the existing one: - ``membership_roles`` is overwritten, not merged. Leaving ``membership_roles`` empty clears all of - the role's existing memberships, including ``DATABRICKS_SUPERUSER``. Always send the complete - desired list of memberships when using this field. - :param role_id: str (optional) - The ID to use for the Role, which will become the final component of the role's resource name. This - ID becomes the role in Postgres. + Update a Database. - This value should be 4-63 characters, and valid characters are lowercase letters, numbers, and - hyphens, as defined by RFC 1123. + :param name: str + The resource name of the database. Format: + projects/{project_id}/branches/{branch_id}/databases/{database_id} + :param database: :class:`Database` + The Database to update. - If role_id is not specified in the request, it is generated automatically. + The database's ``name`` field is used to identify the database to update. Format: + projects/{project_id}/branches/{branch_id}/databases/{database_id} + :param update_mask: FieldMask + The list of fields to update. :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Branch where this Role is created. Format: projects/{project_id}/branches/{branch_id}' - - name: replace_existing - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: branch_id + in: path + required: true schema: - type: boolean - description: 'If true, update the role if it already exists instead of returning an error. When the role already exists, - the provided ``role`` spec fully replaces the existing one: ``membership_roles`` is overwritten, not merged. Leaving - ``membership_roles`` empty clears all of the role''s existing memberships, including ``DATABRICKS_SUPERUSER``. Always - send the complete desired list of memberships when using this field.' - - name: role_id - in: query - required: false + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: database_id + in: path + required: true schema: type: string - description: The ID to use for the Role, which will become the final component of the role's resource name. This ID - becomes the role in Postgres. This value should be 4-63 characters, and valid characters are lowercase letters, - numbers, and hyphens, as defined by RFC 1123. If role_id is not specified in the request, it is generated automatically. + description: 'The `database_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/databases/{database_id}`). + The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. requestBody: content: application/json: schema: type: object properties: - role: + create_time: + type: string + format: date-time + description: A timestamp indicating when the database was created. + database_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + name: + type: string + description: 'The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}' + parent: + type: string + description: 'The branch containing this database. Format: projects/{project_id}/branches/{branch_id}' + spec: type: object properties: - create_time: + role: type: string - format: date-time - name: + postgres_database: type: string - description: 'Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' - parent: + description: The name of the Postgres database. This expects a valid Postgres identifier as specified + in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS + Required when creating the Database. To rename, pass a valid postgres identifier when updating the + Database. + required: + - role + description: The desired state of the Database. + status: + type: object + properties: + database_id: type: string - description: 'The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}' - role_id: + postgres_database: type: string - description: The part of the name, chosen by the user when the resource was created. - spec: - type: object - properties: - attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: |- - Attributes that can be granted to a Postgres role. We are only implementing a subset for now, - see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres - keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical - underscores between words. - auth_method: - type: string - x-enum: - - LAKEBASE_OAUTH_V1 - - NO_LOGIN - - PG_PASSWORD_SCRAM_SHA_256 - description: 'Controls how the Postgres role authenticates when a client opens a database connection. - Supported values: - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth - access token derived from the backing managed identity (the Databricks user, service principal, - or group named by the role''s ``postgres_role``). No static password exists for roles using this - method. - PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres password verified - server-side using the SCRAM-SHA-256 mechanism. Lakebase generates a password for the role. - NO_LOGIN: - the role cannot open a Postgres session at all. Useful for roles that exist only to own objects - or to aggregate privileges that are then granted to other, loginable roles. If auth_method is - left unspecified, a meaningful authentication method is derived from the identity_type: - For - the managed identities, OAUTH is used. - For the regular postgres roles, authentication based - on postgres passwords is used. NOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1 - is the default auth method (group can login as well).' - identity_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: 'The type of role. When specifying a managed-identity, the chosen role_id must be a - valid: - application ID for SERVICE_PRINCIPAL - user email for USER - group name for GROUP' - membership_roles: - type: array - items: - type: string - x-enum: - - DATABRICKS_SUPERUSER - description: Roles that the DatabaseInstanceRole can be a member of. - description: An enum value for a standard role that this role is a member of. - postgres_role: - type: string - description: 'The name of the Postgres role. This expects a valid Postgres identifier as specified - in the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS - Required when creating the Role. If you wish to create a Postgres Role backed by a managed Databricks - identity, then postgres_role must be one of the following: 1. user email for IdentityType.USER - 2. app ID for IdentityType.SERVICE_PRINCIPAL 3. group name for IdentityType.GROUP' - description: The spec contains the role configuration, including identity type, authentication method, - and role attributes. - status: - type: object - properties: - attributes: - type: object - properties: - bypassrls: - type: boolean - createdb: - type: boolean - createrole: - type: boolean - description: |- - Attributes that can be granted to a Postgres role. We are only implementing a subset for now, - see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres - keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical - underscores between words. - auth_method: - type: string - x-enum: - - LAKEBASE_OAUTH_V1 - - NO_LOGIN - - PG_PASSWORD_SCRAM_SHA_256 - description: How the role is authenticated when connecting to Postgres. - identity_type: - type: string - x-enum: - - GROUP - - SERVICE_PRINCIPAL - - USER - description: The type of the role. - membership_roles: - type: array - items: - type: string - x-enum: - - DATABRICKS_SUPERUSER - description: Roles that the DatabaseInstanceRole can be a member of. - description: An enum value for a standard role that this role is a member of. - postgres_role: - type: string - description: The name of the Postgres role. - role_id: - type: string - description: Part of the resource name. - description: Current status of the role, including its identity type, authentication method, and role - attributes. - update_time: + description: The name of the Postgres database. + role: type: string - format: date-time - description: The desired specification of a Role. - required: - - role + description: 'The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + description: The observed state of the Database. + update_time: + type: string + format: date-time + description: A timestamp indicating when the database was last updated. + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}: + delete: + operationId: postgres_delete_endpoint + summary: Deletes the specified compute endpoint. + tags: + - postgres + description: |- + Deletes the specified compute endpoint. + + :param name: str + The full resource path of the endpoint to delete. Format: + projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to delete. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to delete. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: endpoint_id + in: path + required: true + schema: + type: string + description: 'The `endpoint_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to delete. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' responses: '200': description: Success @@ -1968,47 +3343,48 @@ paths: type: string x-stackql-sdk-source: PostgresAPI get: - operationId: postgres_list_roles - summary: Returns a paginated list of Postgres roles in the branch. + operationId: postgres_get_endpoint + summary: Retrieves information about the specified compute endpoint, including its connection details and tags: - postgres description: |- - Returns a paginated list of Postgres roles in the branch. + Retrieves information about the specified compute endpoint, including its connection details and + operational state. - :param parent: str - The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id} - :param page_size: int (optional) - Upper bound for items returned. Cannot be negative. - :param page_token: str (optional) - Page token from a previous response. If not provided, returns the first page. + :param name: str + The full resource path of the endpoint to retrieve. Format: + projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - :returns: Iterator over :class:`Role` + :returns: :class:`Endpoint` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Branch that owns this collection of roles. Format: projects/{project_id}/branches/{branch_id}' - - name: page_size - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to retrieve. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: branch_id + in: path + required: true schema: - type: integer - description: Upper bound for items returned. Cannot be negative. - - name: page_token - in: query - required: false + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to retrieve. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: endpoint_id + in: path + required: true schema: type: string - description: Page token from a previous response. If not provided, returns the first page. + description: 'The `endpoint_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + The full resource path of the endpoint to retrieve. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListRolesResponse' + $ref: '#/components/schemas/Endpoint' default: description: Error response content: @@ -2021,129 +3397,235 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/snapshots: - post: - operationId: postgres_create_snapshot - summary: Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. + patch: + operationId: postgres_update_endpoint + summary: Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or tags: - postgres description: |- - Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. + Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or + enable/disable the compute endpoint. - :param parent: str - The project in which to create the snapshot. Format: projects/{project_id} - :param snapshot: :class:`Snapshot` - The snapshot to create. - :param snapshot_id: str (optional) - Client-chosen ID for the snapshot. If omitted, the server generates one. + :param name: str + Output only. The full resource path of the endpoint. Format: + projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + :param endpoint: :class:`Endpoint` + The Endpoint to update. + + The endpoint's ``name`` field is used to identify the endpoint to update. Format: + projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + :param update_mask: FieldMask + The list of fields to update. :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The project in which to create the snapshot. Format: projects/{project_id}' - - name: snapshot_id - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: endpoint_id + in: path + required: true schema: type: string - description: Client-chosen ID for the snapshot. If omitted, the server generates one. + description: 'The `endpoint_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`). + Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. requestBody: content: application/json: schema: type: object properties: - snapshot: + create_time: + type: string + format: date-time + endpoint_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + name: + type: string + description: 'Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}' + parent: + type: string + description: 'The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}' + spec: type: object properties: - create_time: + endpoint_type: type: string - format: date-time - description: When the snapshot was created. - name: - type: string - description: 'The resource name of the snapshot. Format: projects/{project_id}/snapshots/{snapshot_id}' - snapshot_id: - type: string - description: The user-chosen ID; the final segment of ``name``. - spec: + x-enum: + - ENDPOINT_TYPE_READ_ONLY + - ENDPOINT_TYPE_READ_WRITE + description: The compute endpoint type. Either ``read_write`` or ``read_only``. + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units. The maximum value is 64. The difference between the + minimum and maximum Compute Units (max - min) must not exceed 16. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. Minimum value is 0.5. + disabled: + type: boolean + description: Whether to restrict connections to the compute endpoint. Enabling this option schedules + a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console + action. + group: type: object properties: - source_branch: - type: string - description: 'The source branch to snapshot. Format: projects/{project_id}/branches/{branch_id}' - expire_time: - type: string - format: date-time - description: Absolute time at which the snapshot is deleted. Mutually exclusive with ``ttl`` and - ``no_expiry``. - no_expiry: + min: + type: integer + max: + type: integer + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: type: boolean - description: If true, the snapshot never expires. Mutually exclusive with ``ttl`` and ``expire_time``. - source_branch_lsn: - type: string - description: LSN to snapshot from, e.g. ``16/B374D848``. Mutually exclusive with ``source_branch_time``. - source_branch_time: - type: string - format: date-time - description: Timestamp to snapshot from. Mutually exclusive with ``source_branch_lsn``. - ttl: - type: string - description: Time-to-live. The snapshot expires this long after it is created. Mutually exclusive - with ``expire_time`` and ``no_expiry``. + description: Whether to allow read-only connections to read-write endpoints. Only relevant for read-write + endpoints where size.max > 1. required: - - source_branch - description: Client-provided configuration of the snapshot. - status: + - min + - max + description: Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults + to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write + endpoints). + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should be set + to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + settings: type: object properties: - current_state: - type: string - x-enum: - - AVAILABLE - - CREATING - - DELETING - - FAILED - description: The snapshot's current state. - diff_size_bytes: + pg_settings: + type: object + description: A raw representation of Postgres settings. + description: A collection of settings for a compute endpoint. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. If + specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + required: + - endpoint_type + description: The spec contains the compute endpoint configuration, including autoscaling limits, suspend + timeout, and disabled state. + status: + type: object + properties: + autoscaling_limit_max_cu: + type: number + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. + current_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - IDLE + - INIT + description: The state of the compute endpoint. + disabled: + type: boolean + description: Whether to restrict connections to the compute endpoint. Enabling this option schedules + a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console + action. + endpoint_id: + type: string + description: Part of the resource name. + endpoint_type: + type: string + x-enum: + - ENDPOINT_TYPE_READ_ONLY + - ENDPOINT_TYPE_READ_WRITE + description: The endpoint type. A branch can only have one READ_WRITE endpoint. + group: + type: object + properties: + min: type: integer - description: Incremental storage size in bytes since the previous snapshot. Unset when the snapshot - is not billed on incremental usage. - expire_time: - type: string - format: date-time - description: Absolute time at which the snapshot is deleted. - full_size_bytes: + max: type: integer - description: Full logical size of the snapshot, in bytes. - no_expiry: + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: type: boolean - description: True if the snapshot never expires. - source_branch: + description: Whether read-only connections to read-write endpoints are allowed. Only relevant if + read replicas are configured by specifying size.max > 1. + required: + - min + - max + description: Details on the HA configuration of the endpoint. + hosts: + type: object + properties: + host: type: string - description: 'The source branch the snapshot was taken from. Format: projects/{project_id}/branches/{branch_id}' - source_branch_lsn: + description: The hostname to connect to this endpoint. For read-write endpoints, this is a read-write + hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname + which allows read-only operations. + read_only_host: type: string - description: The LSN at which the snapshot was taken. - source_branch_time: + description: An optionally defined read-only host for the endpoint, without pooling. For read-only + endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, + this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, + and has readable secondaries enabled. + read_only_pooled_host: type: string - format: date-time - description: The point in time at which the snapshot was taken. - description: Server-observed state of the snapshot. - uid: - type: string - description: Unique system-generated ID for the snapshot. - update_time: + description: The read-only hostname of the compute endpoint, with pooling. This attribute is always + defined for read-only endpoints, and may be defined for read-write endpoints if configured with + read replicas and allow read-only connections. + read_write_pooled_host: + type: string + description: The read-write hostname of the compute endpoint, with pooling. This attribute is only + defined for read-write endpoints. + description: Contains host information for connecting to the endpoint. + last_active_time: type: string format: date-time - description: When the snapshot was last updated. - description: The snapshot to create. - required: - - snapshot + description: A timestamp indicating when the compute endpoint was last active. + pending_state: + type: string + x-enum: + - ACTIVE + - DEGRADED + - IDLE + - INIT + description: The state of the compute endpoint. + settings: + type: object + properties: + pg_settings: + type: object + description: A raw representation of Postgres settings. + description: A collection of settings for a compute endpoint. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. + description: Current operational status of the compute endpoint. + uid: + type: string + description: System-generated unique ID for the endpoint. + update_time: + type: string + format: date-time + description: A timestamp indicating when the compute endpoint was last updated. responses: '200': description: Success @@ -2163,48 +3645,42 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - get: - operationId: postgres_list_snapshots - summary: Returns a paginated list of snapshots in the project. + /api/2.0/postgres/projects/{project_id}: + delete: + operationId: postgres_delete_project + summary: Deletes the specified database project. tags: - postgres description: |- - Returns a paginated list of snapshots in the project. + Deletes the specified database project. - :param parent: str - The project that owns the snapshots. Format: projects/{project_id} - :param page_size: int (optional) - Maximum number of snapshots to return per page. - :param page_token: str (optional) - Page token from a previous response; omit for the first page. + :param name: str + The full resource path of the project to delete. Format: projects/{project_id} + :param purge: bool (optional) + If true, permanently deletes the project (hard delete). If false or unset, performs a soft delete. - :returns: Iterator over :class:`Snapshot` + :returns: :class:`Operation` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The project that owns the snapshots. Format: projects/{project_id}' - - name: page_size - in: query - required: false - schema: - type: integer - description: Maximum number of snapshots to return per page. - - name: page_token + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}`). The full resource path + of the project to delete. Format: projects/{project_id}' + - name: purge in: query required: false schema: - type: string - description: Page token from a previous response; omit for the first page. + type: boolean + description: If true, permanently deletes the project (hard delete). If false or unset, performs a soft delete. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListSnapshotsResponse' + type: object default: description: Error response content: @@ -2215,317 +3691,35 @@ paths: error: type: string message: - type: string - x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/synced_tables: - post: - operationId: postgres_create_synced_table - summary: Create a Synced Table. - tags: - - postgres - description: |- - Create a Synced Table. - - :param synced_table: :class:`SyncedTable` - :param synced_table_id: str - The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource - name. ID is required and is the synced table name, containing (catalog, schema, table) tuple. - Elements of the tuple are the UC entity names. - - Example: "{catalog}.{schema}.{table}" - - synced_table_id represents both of the following: - - 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation. - 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database - - :returns: :class:`Operation` - parameters: - - name: synced_table_id - in: query - required: true - schema: - type: string - description: 'The ID to use for the Synced Table. This becomes the final component of the SyncedTable''s resource - name. ID is required and is the synced table name, containing (catalog, schema, table) tuple. Elements of the tuple - are the UC entity names. Example: "{catalog}.{schema}.{table}" synced_table_id represents both of the following: - 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation. 2. Postgres table - named "{table}" in schema "{schema}" in the connected Postgres database' - requestBody: - content: - application/json: - schema: - type: object - properties: - synced_table: - type: object - properties: - create_time: - type: string - format: date-time - name: - type: string - description: Output only. The Full resource name of the synced table in Postgres where (catalog, schema, - table) are the UC entity names. Format "synced_tables/{catalog}.{schema}.{table}" For the corresponding - source table in the Unity catalog look for the "source_table_full_name" attribute. - spec: - type: object - properties: - accelerated_sync: - type: boolean - branch: - type: string - description: 'The full resource name the branch associated with the table. Format: "projects/{project_id}/branches/{branch_id}".' - create_database_objects_if_missing: - type: boolean - description: If true, the synced table's logical database and schema resources in PG will be created - if they do not already exist. The request will fail if this is false and the database/schema do - not exist. Defaults to true if omitted. - existing_pipeline_id: - type: string - description: ID of an existing pipeline to bin-pack this synced table into. At most one of existing_pipeline_id - and new_pipeline_spec should be defined. The pipeline used for the synced table is returned via - the top level pipeline_id attribute. - extra_columns: - type: array - items: - type: object - properties: - column_name: - type: string - description: Name of the column. - column_type: - type: string - description: PostgreSQL type of the column, for example "tsvector" or "vector(1024)". - compute: - type: string - description: SQL expression used to compute the column's value, for example "to_tsvector('english', - content)". - maintenance: - type: string - x-enum: - - DEFAULT_VALUE - - STORED_GENERATED - description: How the column's value is populated and kept up to date. - required: - - column_name - - column_type - description: An extra PostgreSQL column to add to the synced table. - description: Extra PostgreSQL-only columns to add to the synced table. - extra_index_definitions: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the index as it will appear in PostgreSQL. - definition: - type: string - description: 'The definition portion of a CREATE INDEX statement, placed after ON table_name. - For example: USING hnsw (embedding vector_cosine_ops) WITH (m = 16, ef_construction = 64).' - creation_point: - type: string - x-enum: - - CREATION_POINT_AFTER_DATA_LOAD - description: When the index should be created relative to the initial data load. - required: - - name - - definition - description: Definition of a secondary index to create on the synced table. - description: Secondary indexes to create on the synced table. - new_pipeline_spec: - type: object - properties: - budget_policy_id: - type: string - pipeline_channel: - type: string - x-enum: - - CURRENT - - PREVIEW - description: Release channel of the underlying pipeline's runtime. Some source table configurations - (e.g., read-time CDF) require PREVIEW. Defaults to CURRENT if not specified. - storage_catalog: - type: string - description: UC catalog for the pipeline to store intermediate files (checkpoints, event logs - etc). This needs to be a standard catalog where the user has permissions to create Delta tables. - storage_schema: - type: string - description: UC schema for the pipeline to store intermediate files (checkpoints, event logs - etc). This needs to be in the standard catalog where the user has permissions to create Delta - tables. - description: Specification for creating a new pipeline. At most one of existing_pipeline_id and - new_pipeline_spec should be defined. The pipeline used for the synced table is returned via the - top level pipeline_id attribute. - postgres_database: - type: string - description: The Postgres database name where the synced table will be created in. If this synced - table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred - from the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase - Catalog, the value must match. A value must be specified when creating a synced table inside a - Standard Catalog. - primary_key_columns: - type: array - items: - type: string - description: Primary Key columns to be used for data insert/update in the destination. - scheduling_policy: - type: string - x-enum: - - CONTINUOUS - - SNAPSHOT - - TRIGGERED - description: Scheduling policy of the underlying pipeline. - source_table_full_name: - type: string - description: 'Three-part (catalog, schema, table) name of the source Delta table. For the corresponding - destination table, use any of the two: - synced_table_id used at the creation of the SyncedTable - - "name" consisting of "synced_tables/" prefix and the full name of the destination table.' - timeseries_key: - type: string - description: Time series key to deduplicate (tie-break) rows with the same primary key. - type_overrides: - type: array - items: - type: object - properties: - column_name: - type: string - description: Name of the source column whose target PostgreSQL type should be overridden. - pg_type: - type: string - x-enum: - - PG_SPECIFIC_TYPE_HALFVEC - - PG_SPECIFIC_TYPE_VARCHAR - - PG_SPECIFIC_TYPE_VECTOR - description: PostgreSQL-specific target type to use for the column. - size: - type: integer - description: Size parameter for the target type, for types that take one (e.g. vector dimension, - varchar length). Required when the chosen pg_type needs a size. - required: - - column_name - - pg_type - description: Overrides the default Delta-to-PostgreSQL type mapping for a single column. - description: Override the default Delta->PG type mapping for specific columns. A TypeOverride with - PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set. - description: Configuration details of the synced table, such as the source table, scheduling policy, - etc. This attribute is specified at creation time and most fields are returned as is on subsequent - queries. - status: - type: object - properties: - detailed_state: - type: string - x-enum: - - SYNCED_TABLE_OFFLINE - - SYNCED_TABLE_OFFLINE_FAILED - - SYNCED_TABLE_ONLINE - - SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE - - SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE - - SYNCED_TABLE_ONLINE_PIPELINE_FAILED - - SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE - - SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES - - SYNCED_TABLE_PROVISIONING - - SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT - - SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES - description: The state of a synced table. - last_processed_commit_version: - type: integer - description: The last source table Delta version that was successfully synced to the synced table. - last_sync: - type: object - properties: - delta_table_sync_info: - type: object - properties: - delta_commit_time: - type: string - format: date-time - delta_commit_version: - type: integer - description: The Delta Lake commit version that was last successfully synced. - sync_end_time: - type: string - format: date-time - description: The end timestamp of the most recent successful synchronization. This is the time - when the data is available in the synced table. - sync_start_time: - type: string - format: date-time - description: The starting timestamp of the most recent successful synchronization from the source - table to the destination (synced) table. Note this is the starting timestamp of the sync operation, - not the end time. E.g., for a batch, this is the time when the sync operation started. - description: Summary of the last successful synchronization from source to destination. - last_sync_time: - type: string - format: date-time - description: The end timestamp of the last time any data was synchronized from the source table - to the synced table. This is when the data is available in the synced table. - message: - type: string - description: A text description of the current state of the synced table. - ongoing_sync_progress: - type: object - properties: - estimated_completion_time_seconds: - type: number - description: The estimated time remaining to complete this update in seconds. - latest_version_currently_processing: - type: integer - description: The source table Delta version that was last processed by the pipeline. The pipeline - may not have completely processed this version yet. - sync_progress_completion: - type: number - description: The completion ratio of this update. This is a number between 0 and 1. - synced_row_count: - type: integer - description: The number of rows that have been synced in this update. - total_row_count: - type: integer - description: The total number of rows that need to be synced in this update. This number may - be an estimate. - description: Progress information of the Synced Table data synchronization pipeline. - pipeline_id: - type: string - description: ID of the associated pipeline. - project: - type: string - description: 'The full resource name of the project associated with the table. Format: "projects/{project_id}".' - provisioning_phase: - type: string - x-enum: - - PROVISIONING_PHASE_INDEX_SCAN - - PROVISIONING_PHASE_INDEX_SORT - - PROVISIONING_PHASE_MAIN - description: The current phase of the data synchronization pipeline. - unity_catalog_provisioning_state: - type: string - x-enum: - - ACTIVE - - DEGRADED - - DELETING - - FAILED - - PROVISIONING - - UPDATING - description: The provisioning state of the synced table entity in Unity Catalog. - description: Synced Table data synchronization status. - synced_table_id: - type: string - description: The part of the name, chosen by the user when the resource was created. - uid: - type: string - description: The Unity Catalog table ID for this synced table. - required: - - synced_table + type: string + x-stackql-sdk-source: PostgresAPI + get: + operationId: postgres_get_project + summary: Retrieves information about the specified database project. + tags: + - postgres + description: |- + Retrieves information about the specified database project. + + :param name: str + The full resource path of the project to retrieve. Format: projects/{project_id} + + :returns: :class:`Project` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}`). The full resource path + of the project to retrieve. Format: projects/{project_id}' responses: '200': description: Success content: application/json: schema: - type: object + $ref: '#/components/schemas/Project' default: description: Error response content: @@ -2538,58 +3732,255 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/tables: - post: - operationId: postgres_create_table - summary: Create a Table (non-synced database table for Autoscaling v2 Lakebase projects). + patch: + operationId: postgres_update_project + summary: Updates the specified database project. tags: - postgres description: |- - Create a Table (non-synced database table for Autoscaling v2 Lakebase projects). + Updates the specified database project. + + :param name: str + Output only. The full resource path of the project. Format: projects/{project_id} + :param project: :class:`Project` + The Project to update. - :param table: :class:`Table` + The project's ``name`` field is used to identify the project to update. Format: + projects/{project_id} + :param update_mask: FieldMask + The list of fields to update. - :returns: :class:`Table` + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}`). Output only. The full + resource path of the project. Format: projects/{project_id}' + - name: update_mask + in: query + required: true + schema: + type: object + description: The list of fields to update. requestBody: content: application/json: schema: type: object properties: - table: + create_time: + type: string + format: date-time + delete_time: + type: string + format: date-time + description: A timestamp indicating when the project was soft-deleted. Empty if the project is not deleted, + otherwise set to a timestamp in the past. + initial_branch_spec: + type: object + properties: + is_protected: + type: boolean + description: Whether the initial default branch should be protected from deletion. + description: Configuration for the initial default branch created as part of project creation. Allows overriding + branch protection. These settings only apply at creation time and do not affect resources created after + project creation. + initial_endpoint_spec: type: object properties: - name: + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units for the initial endpoint. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units for the initial endpoint. + group: + type: object + properties: + min: + type: integer + max: + type: integer + description: The maximum number of computes in the endpoint group. Currently, this must be equal + to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes + in an endpoint group, set disabled to true on the EndpointSpec. + enable_readable_secondaries: + type: boolean + description: Whether to allow read-only connections to read-write endpoints. Only relevant for read-write + endpoints where size.max > 1. + required: + - min + - max + description: Settings for HA configuration of the endpoint. + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should be set + to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + suspend_timeout_duration: type: string - description: Full three-part (catalog, schema, table) name of the table. - database: + description: Duration of inactivity after which the initial endpoint is automatically suspended. If + specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: Configuration settings for the initial Read/Write endpoint created inside the initial branch + for a newly created project. If omitted, the initial endpoint created will have default settings, without + high availability configured. This field does not apply to any endpoints created after project creation. + Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation. + name: + type: string + description: 'Output only. The full resource path of the project. Format: projects/{project_id}' + project_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + purge_time: + type: string + format: date-time + description: A timestamp indicating when the project is scheduled for permanent deletion. Empty if the project + is not deleted, otherwise set to a timestamp in the future. + spec: + type: object + properties: + budget_policy_id: type: string - description: 'The project and branch scoped database to which this table belongs. Of the format: projects/{project_id}/branches/{branch_id}/databases/{database_id} - where database_id is the name of the logical database in Postgres.' - branch: + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. + To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To clear + all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing + tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags). + default_branch: type: string - description: The id of the database branch associated with the table. Of the format projects/{project_id}/branches/{branch_id}. - project: + description: 'The full resource path for the default branch of the project Format: projects/{project_id}/branches/{branch_id}' + default_endpoint_settings: + type: object + properties: + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units. Minimum value is 0.5. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. Minimum value is 0.5. + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should + be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + pg_settings: + type: object + description: A raw representation of Postgres settings. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. + If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: A collection of settings for a compute endpoint. + display_name: type: string - description: The id of the database project associated with the table. Of the format projects/{project_id}. - table_serving_url: + description: Human-readable project name. Length should be between 1 and 256 characters. + enable_pg_native_login: + type: boolean + description: Whether to enable PG native password login on all endpoints in this project. Defaults to + false. + history_retention_duration: type: string - description: REST API URL for serving data from this table. - required: - - name - - database - description: |- - Table represents a non-synced database table in a Lakebase project. Unlike SyncedTable, this - does not have a data synchronization pipeline. - required: - - table + description: The number of seconds to retain the shared history for point in time recovery for all branches + in this project. Value should be between 172800s (2 days) and 3024000s (35 days). + pg_version: + type: integer + description: The major Postgres version number. The set of supported versions may vary; consult the + API documentation for currently accepted values. + description: The spec contains the project configuration, including display_name, pg_version (Postgres version), + history_retention_duration, and default_endpoint_settings. + status: + type: object + properties: + branch_logical_size_limit_bytes: + type: integer + budget_policy_id: + type: string + description: The budget policy that is applied to the project. + compute_last_active_time: + type: string + format: date-time + description: The most recent time when any endpoint of this project was active. + custom_tags: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. + description: The effective custom tags associated with the project. + default_branch: + type: string + description: The full resource path of the default branch of the project + default_endpoint_settings: + type: object + properties: + autoscaling_limit_max_cu: + type: number + description: The maximum number of Compute Units. Minimum value is 0.5. + autoscaling_limit_min_cu: + type: number + description: The minimum number of Compute Units. Minimum value is 0.5. + no_suspension: + type: boolean + description: When set to true, explicitly disables automatic suspension (never suspend). Should + be set to true when provided. Mutually exclusive with ``suspend_timeout_duration``. + pg_settings: + type: object + description: A raw representation of Postgres settings. + suspend_timeout_duration: + type: string + description: Duration of inactivity after which the compute endpoint is automatically suspended. + If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. + description: The effective default endpoint settings. + display_name: + type: string + description: The effective human-readable project name. + enable_pg_native_login: + type: boolean + description: Whether to enable PG native password login on all endpoints in this project. + history_retention_duration: + type: string + description: The effective number of seconds to retain the shared history for point in time recovery. + owner: + type: string + description: The email of the project owner. + pg_version: + type: integer + description: The effective major Postgres version number. + project_id: + type: string + description: Part of the resource name. + synthetic_storage_size_bytes: + type: integer + description: The current space occupied by the project in storage. + description: The current status of a Project. + uid: + type: string + description: System-generated unique ID for the project. + update_time: + type: string + format: date-time + description: A timestamp indicating when the project was last updated. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Table' + type: object default: description: Error response content: @@ -2602,28 +3993,54 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{name}: + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/roles/{role_id}: delete: - operationId: postgres_delete_synced_table - summary: Delete a Synced Table. + operationId: postgres_delete_role + summary: Deletes the specified Postgres role. tags: - postgres description: |- - Delete a Synced Table. + Deletes the specified Postgres role. :param name: str - The Full resource name of the synced table, of the format - "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table) are the UC entity names. + The full resource path of the role to delete. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} + :param reassign_owned_to: str (optional) + Reassign objects. If this is set, all objects owned by the role are reassigned to the role specified + in this parameter. + + NOTE: setting this requires spinning up a compute to succeed, since it involves running SQL queries. :returns: :class:`Operation` parameters: - - name: name + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to delete. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to delete. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: role_id in: path required: true schema: type: string - description: The Full resource name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}", - where (catalog, schema, table) are the UC entity names. + description: 'The `role_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to delete. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: reassign_owned_to + in: query + required: false + schema: + type: string + description: 'Reassign objects. If this is set, all objects owned by the role are reassigned to the role specified + in this parameter. NOTE: setting this requires spinning up a compute to succeed, since it involves running SQL queries.' responses: '200': description: Success @@ -2644,33 +4061,48 @@ paths: type: string x-stackql-sdk-source: PostgresAPI get: - operationId: postgres_get_synced_table - summary: Get a Synced Table. + operationId: postgres_get_role + summary: Retrieves information about the specified Postgres role, including its authentication method and tags: - postgres description: |- - Get a Synced Table. + Retrieves information about the specified Postgres role, including its authentication method and + permissions. :param name: str - The Full resource name of the synced table. Format: "synced_tables/{catalog}.{schema}.{table}", - where (catalog, schema, table) are the entity names in the Unity Catalog. + The full resource path of the role to retrieve. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} - :returns: :class:`SyncedTable` + :returns: :class:`Role` parameters: - - name: name + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to retrieve. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to retrieve. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: role_id in: path required: true schema: type: string - description: 'The Full resource name of the synced table. Format: "synced_tables/{catalog}.{schema}.{table}", where - (catalog, schema, table) are the entity names in the Unity Catalog.' + description: 'The `role_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role to retrieve. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/SyncedTable' + $ref: '#/components/schemas/Role' default: description: Error response content: @@ -2684,190 +4116,186 @@ paths: type: string x-stackql-sdk-source: PostgresAPI patch: - operationId: postgres_update_snapshot_schedule - summary: Sets the snapshot schedule for a branch. The ``schedule`` field is replaced wholesale; an empty + operationId: postgres_update_role + summary: Update a role for a branch. tags: - postgres description: |- - Sets the snapshot schedule for a branch. The ``schedule`` field is replaced wholesale; an empty - schedule disables automatic snapshots. + Update a role for a branch. :param name: str - The resource name of the branch's snapshot schedule. Format: - projects/{project_id}/branches/{branch_id}/snapshot-schedule - :param snapshot_schedule: :class:`SnapshotSchedule` - The snapshot schedule to set. Its ``name`` identifies the branch. Format: - projects/{project_id}/branches/{branch_id}/snapshot-schedule + Output only. The full resource path of the role. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} + :param role: :class:`Role` + The Postgres Role to update. + + The role's ``name`` field is used to identify the role to update. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} :param update_mask: FieldMask - Fields to update. The only updatable path is ``schedule``, which replaces the entire set of - cadences. + The list of fields to update. - :returns: :class:`SnapshotSchedule` + :returns: :class:`Operation` parameters: - - name: name + - name: project_id + in: path + required: true + schema: + type: string + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: role_id in: path required: true schema: type: string - description: 'The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + description: 'The `role_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' - name: update_mask in: query required: true schema: type: object - description: Fields to update. The only updatable path is ``schedule``, which replaces the entire set of cadences. + description: The list of fields to update. requestBody: content: application/json: schema: type: object properties: - snapshot_schedule: + create_time: + type: string + format: date-time + name: + type: string + description: 'Output only. The full resource path of the role. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + parent: + type: string + description: 'The Branch where this Role exists. Format: projects/{project_id}/branches/{branch_id}' + role_id: + type: string + description: The part of the name, chosen by the user when the resource was created. + spec: type: object properties: - name: + attributes: + type: object + properties: + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: |- + Attributes that can be granted to a Postgres role. We are only implementing a subset for now, + see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres + keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical + underscores between words. + auth_method: type: string - description: 'The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' - schedule: + x-enum: + - LAKEBASE_OAUTH_V1 + - NO_LOGIN + - PG_PASSWORD_SCRAM_SHA_256 + description: 'Controls how the Postgres role authenticates when a client opens a database connection. + Supported values: - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth access + token derived from the backing managed identity (the Databricks user, service principal, or group + named by the role''s ``postgres_role``). No static password exists for roles using this method. - + PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres password verified server-side using + the SCRAM-SHA-256 mechanism. Lakebase generates a password for the role. - NO_LOGIN: the role cannot + open a Postgres session at all. Useful for roles that exist only to own objects or to aggregate privileges + that are then granted to other, loginable roles. If auth_method is left unspecified, a meaningful + authentication method is derived from the identity_type: - For the managed identities, OAUTH is used. + - For the regular postgres roles, authentication based on postgres passwords is used. NOTE: for the + Databricks identity type GROUP, LAKEBASE_OAUTH_V1 is the default auth method (group can login as well).' + identity_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: 'The type of role. When specifying a managed-identity, the chosen role_id must be a valid: + - application ID for SERVICE_PRINCIPAL - user email for USER - group name for GROUP' + membership_roles: type: array items: - type: object - properties: - retention: - type: string - description: How long snapshots from this cadence are kept before automatic deletion. Must be - at least 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only - later snapshots. - daily_schedule: - type: object - properties: - hour: - type: integer - description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. - description: Take a snapshot once per day. - monthly_schedule: - type: object - properties: - day: - type: integer - description: The day of the month on which to take the snapshot, in [1, 31]. In shorter months - the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), - so every month gets exactly one snapshot. - hour: - type: integer - description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. - required: - - day - description: Take a snapshot once per month. - weekly_schedule: - type: object - properties: - day_of_week: - type: string - x-enum: - - FRIDAY - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - description: The day of the week on which to take the snapshot. - hour: - type: integer - description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. - required: - - day_of_week - description: Take a snapshot once per week. - required: - - retention - description: One cadence at which automatic snapshots are taken. - description: The cadences at which automatic snapshots are taken. Update replaces the whole set; an - empty set disables automatic snapshots. Order is not significant. When several cadences fire together, - one snapshot is taken, retained for the longest of their retentions. - description: 'The snapshot schedule to set. Its ``name`` identifies the branch. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' - required: - - snapshot_schedule - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotSchedule' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/forward-etl/configuration: - delete: - operationId: postgres_delete_forward_etl_configuration - summary: Hard delete a Forward ETL configuration and all associated table mappings. Unlike DisableForwardEtl, - tags: - - postgres - description: |- - Hard delete a Forward ETL configuration and all associated table mappings. Unlike DisableForwardEtl, - this permanently removes the config and mapping rows. - - :param parent: str - The Branch to delete Forward ETL configuration for. Format: - projects/{project_id}/branches/{branch_id} - :param pg_database_oid: int (optional) - PostgreSQL database OID to delete configuration for. - :param pg_schema_oid: int (optional) - PostgreSQL schema OID to delete configuration for. - :param tenant_id: str (optional) - Tenant ID (dashless UUID format). - :param timeline_id: str (optional) - Timeline ID (dashless UUID format). - - :returns: :class:`DeleteForwardEtlConfigurationResponse` - parameters: - - name: parent - in: path - required: true - schema: - type: string - description: 'The Branch to delete Forward ETL configuration for. Format: projects/{project_id}/branches/{branch_id}' - - name: pg_database_oid - in: query - required: false - schema: - type: integer - description: PostgreSQL database OID to delete configuration for. - - name: pg_schema_oid - in: query - required: false - schema: - type: integer - description: PostgreSQL schema OID to delete configuration for. - - name: tenant_id - in: query - required: false - schema: - type: string - description: Tenant ID (dashless UUID format). - - name: timeline_id - in: query - required: false - schema: - type: string - description: Timeline ID (dashless UUID format). + type: string + x-enum: + - DATABRICKS_SUPERUSER + description: Roles that the DatabaseInstanceRole can be a member of. + description: An enum value for a standard role that this role is a member of. + postgres_role: + type: string + description: 'The name of the Postgres role. This expects a valid Postgres identifier as specified in + the link below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS + Required when creating the Role. If you wish to create a Postgres Role backed by a managed Databricks + identity, then postgres_role must be one of the following: 1. user email for IdentityType.USER 2. + app ID for IdentityType.SERVICE_PRINCIPAL 3. group name for IdentityType.GROUP' + description: The spec contains the role configuration, including identity type, authentication method, and + role attributes. + status: + type: object + properties: + attributes: + type: object + properties: + bypassrls: + type: boolean + createdb: + type: boolean + createrole: + type: boolean + description: |- + Attributes that can be granted to a Postgres role. We are only implementing a subset for now, + see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres + keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical + underscores between words. + auth_method: + type: string + x-enum: + - LAKEBASE_OAUTH_V1 + - NO_LOGIN + - PG_PASSWORD_SCRAM_SHA_256 + description: How the role is authenticated when connecting to Postgres. + identity_type: + type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER + description: The type of the role. + membership_roles: + type: array + items: + type: string + x-enum: + - DATABRICKS_SUPERUSER + description: Roles that the DatabaseInstanceRole can be a member of. + description: An enum value for a standard role that this role is a member of. + postgres_role: + type: string + description: The name of the Postgres role. + role_id: + type: string + description: Part of the resource name. + description: Current status of the role, including its identity type, authentication method, and role attributes. + update_time: + type: string + format: date-time responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/DeleteForwardEtlConfigurationResponse' + type: object default: description: Error response content: @@ -2880,65 +4308,41 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/tables/{name}: + /api/2.0/postgres/projects/{project_id}/snapshots/{snapshot_id}: delete: - operationId: postgres_delete_table - summary: Delete a Table (non-synced database table for Autoscaling v2 Lakebase projects). + operationId: postgres_delete_snapshot + summary: Deletes the specified snapshot. tags: - postgres description: |- - Delete a Table (non-synced database table for Autoscaling v2 Lakebase projects). + Deletes the specified snapshot. :param name: str - Full three-part (catalog, schema, table) name of the table. + The resource name of the snapshot to delete. Format: projects/{project_id}/snapshots/{snapshot_id} + + :returns: :class:`Operation` parameters: - - name: name + - name: project_id in: path required: true schema: type: string - description: Full three-part (catalog, schema, table) name of the table. - responses: - '200': - description: Success - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: PostgresAPI - get: - operationId: postgres_get_table - summary: Get a Table (non-synced database table for Autoscaling v2 Lakebase projects). - tags: - - postgres - description: |- - Get a Table (non-synced database table for Autoscaling v2 Lakebase projects). - - :param name: str - Full three-part (catalog, schema, table) name of the table. - - :returns: :class:`Table` - parameters: - - name: name + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/snapshots/{snapshot_id}`). + The resource name of the snapshot to delete. Format: projects/{project_id}/snapshots/{snapshot_id}' + - name: snapshot_id in: path required: true schema: type: string - description: Full three-part (catalog, schema, table) name of the table. + description: 'The `snapshot_id` segment of the `name` resource name (`projects/{project_id}/snapshots/{snapshot_id}`). + The resource name of the snapshot to delete. Format: projects/{project_id}/snapshots/{snapshot_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Table' + type: object default: description: Error response content: @@ -2951,65 +4355,40 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/forward-etl: - delete: - operationId: postgres_disable_forward_etl - summary: Disable Forward ETL for a branch. + get: + operationId: postgres_get_snapshot + summary: Retrieves information about the specified snapshot. tags: - postgres description: |- - Disable Forward ETL for a branch. + Retrieves information about the specified snapshot. - :param parent: str - The Branch to disable Forward ETL for. Format: projects/{project_id}/branches/{branch_id} - :param pg_database_oid: int (optional) - PostgreSQL database OID to disable. - :param pg_schema_oid: int (optional) - PostgreSQL schema OID to disable. - :param tenant_id: str (optional) - Tenant ID (dashless UUID format). - :param timeline_id: str (optional) - Timeline ID (dashless UUID format). - - :returns: :class:`DisableForwardEtlResponse` + :param name: str + The resource name of the snapshot to retrieve. Format: projects/{project_id}/snapshots/{snapshot_id} + + :returns: :class:`Snapshot` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The Branch to disable Forward ETL for. Format: projects/{project_id}/branches/{branch_id}' - - name: pg_database_oid - in: query - required: false - schema: - type: integer - description: PostgreSQL database OID to disable. - - name: pg_schema_oid - in: query - required: false - schema: - type: integer - description: PostgreSQL schema OID to disable. - - name: tenant_id - in: query - required: false - schema: - type: string - description: Tenant ID (dashless UUID format). - - name: timeline_id - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/snapshots/{snapshot_id}`). + The resource name of the snapshot to retrieve. Format: projects/{project_id}/snapshots/{snapshot_id}' + - name: snapshot_id + in: path + required: true schema: type: string - description: Timeline ID (dashless UUID format). + description: 'The `snapshot_id` segment of the `name` resource name (`projects/{project_id}/snapshots/{snapshot_id}`). + The resource name of the snapshot to retrieve. Format: projects/{project_id}/snapshots/{snapshot_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/DisableForwardEtlResponse' + $ref: '#/components/schemas/Snapshot' default: description: Error response content: @@ -3022,48 +4401,36 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - get: - operationId: postgres_get_forward_etl_status - summary: Get Forward ETL configuration and status for a branch. + /api/2.0/postgres/synced_tables/{full_name}: + delete: + operationId: postgres_delete_synced_table + summary: Delete a Synced Table. tags: - postgres description: |- - Get Forward ETL configuration and status for a branch. + Delete a Synced Table. - :param parent: str - The Branch to get Forward ETL status for. Format: projects/{project_id}/branches/{branch_id} - :param tenant_id: str (optional) - Tenant ID (dashless UUID format). - :param timeline_id: str (optional) - Timeline ID (dashless UUID format). + :param name: str + The Full resource name of the synced table, of the format + "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table) are the UC entity names. - :returns: :class:`ForwardEtlStatus` + :returns: :class:`Operation` parameters: - - name: parent + - name: full_name in: path required: true schema: type: string - description: 'The Branch to get Forward ETL status for. Format: projects/{project_id}/branches/{branch_id}' - - name: tenant_id - in: query - required: false - schema: - type: string - description: Tenant ID (dashless UUID format). - - name: timeline_id - in: query - required: false - schema: - type: string - description: Timeline ID (dashless UUID format). + description: The `full_name` segment of the `name` resource name (`synced_tables/{full_name}`). The Full resource + name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table) + are the UC entity names. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ForwardEtlStatus' + type: object default: description: Error response content: @@ -3076,48 +4443,35 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{name}/failover: - post: - operationId: postgres_failover_replication_group_preview - summary: Fails over the replication group to a target workspace, promoting the secondary to primary. + get: + operationId: postgres_get_synced_table + summary: Get a Synced Table. tags: - postgres description: |- - Fails over the replication group to a target workspace, promoting the secondary to primary. + Get a Synced Table. :param name: str - :param target_workspace: str - :param etag: str (optional) - :param request_id: str (optional) + The Full resource name of the synced table. Format: "synced_tables/{catalog}.{schema}.{table}", + where (catalog, schema, table) are the entity names in the Unity Catalog. - :returns: :class:`Operation` + :returns: :class:`SyncedTable` parameters: - - name: name + - name: full_name in: path required: true schema: type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - target_workspace: - type: string - etag: - type: string - request_id: - type: string - required: - - target_workspace + description: 'The `full_name` segment of the `name` resource name (`synced_tables/{full_name}`). The Full resource + name of the synced table. Format: "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table) are + the entity names in the Unity Catalog.' responses: '200': description: Success content: application/json: schema: - type: object + $ref: '#/components/schemas/SyncedTable' default: description: Error response content: @@ -3147,9 +4501,6 @@ paths: :param expire_time: Timestamp (optional) Timestamp in UTC of when this credential should expire. Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time. - :param group_name: str (optional) - Databricks workspace group name. When provided, credentials are generated with permissions scoped to - this group. :param ttl: Duration (optional) The requested time-to-live for the generated credential token. Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour). @@ -3223,10 +4574,6 @@ paths: format: date-time description: Timestamp in UTC of when this credential should expire. Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time. - group_name: - type: string - description: Databricks workspace group name. When provided, credentials are generated with permissions - scoped to this group. ttl: type: string description: The requested time-to-live for the generated credential token. Must be at least 300 seconds @@ -3252,49 +4599,64 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/forward-etl/metadata: - get: - operationId: postgres_get_forward_etl_metadata - summary: Get Forward ETL metadata (database and schema OIDs). + ? /api/2.0/postgres/projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} + : get: + operationId: postgres_get_cdf_status + summary: Get the CDF status of a single table within a Lakebase CDF configuration, including its current state tags: - postgres description: |- - Get Forward ETL metadata (database and schema OIDs). + Get the CDF status of a single table within a Lakebase CDF configuration, including its current state + and the last committed position in the feed. - :param parent: str - The Branch to get metadata for. Format: projects/{project_id}/branches/{branch_id} - :param tenant_id: str (optional) - Tenant ID (dashless UUID format). - :param timeline_id: str (optional) - Timeline ID (dashless UUID format). + :param name: str + The resource name of the CdfStatus to retrieve. Format: + projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} - :returns: :class:`ForwardEtlMetadata` + :returns: :class:`CdfStatus` parameters: - - name: parent + - name: project in: path required: true schema: type: string - description: 'The Branch to get metadata for. Format: projects/{project_id}/branches/{branch_id}' - - name: tenant_id - in: query - required: false + description: 'The `project` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}`). + The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}' + - name: branch + in: path + required: true schema: type: string - description: Tenant ID (dashless UUID format). - - name: timeline_id - in: query - required: false + description: 'The `branch` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}`). + The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}' + - name: database + in: path + required: true + schema: + type: string + description: 'The `database` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}`). + The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}' + - name: cdf_config + in: path + required: true + schema: + type: string + description: 'The `cdf_config` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}`). + The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}' + - name: cdf_status + in: path + required: true schema: type: string - description: Timeline ID (dashless UUID format). + description: 'The `cdf_status` segment of the `name` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}`). + The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ForwardEtlMetadata' + $ref: '#/components/schemas/CdfStatus' default: description: Error response content: @@ -3307,20 +4669,17 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{name}/inspect: - post: - operationId: postgres_inspect_recovery_branch_preview - summary: Materializes a temporary inspection branch from the specified recovery branch for data examination. + /api/2.0/postgres/{name}: + get: + operationId: postgres_get_operation + summary: Retrieves the status of a long-running operation. tags: - postgres description: |- - Materializes a temporary inspection branch from the specified recovery branch for data examination. + Retrieves the status of a long-running operation. :param name: str - The recovery branch from which to create the inspection branch. - :param branch_id: str - Caller-supplied id for the inspection Branch this custom method materializes. - :param request_id: str (optional) + The name of the operation resource. :returns: :class:`Operation` parameters: @@ -3329,27 +4688,14 @@ paths: required: true schema: type: string - description: The recovery branch from which to create the inspection branch. - requestBody: - content: - application/json: - schema: - type: object - properties: - branch_id: - type: string - description: Caller-supplied id for the inspection Branch this custom method materializes. - request_id: - type: string - required: - - branch_id + description: The name of the operation resource. responses: '200': description: Success content: application/json: schema: - type: object + $ref: '#/components/schemas/Operation' default: description: Error response content: @@ -3362,51 +4708,168 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/cdf-statuses: + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/snapshot-schedule: get: - operationId: postgres_list_cdf_statuses - summary: List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a + operationId: postgres_get_snapshot_schedule + summary: Retrieves the snapshot schedule for a branch. A branch with no configured schedule returns an empty tags: - postgres description: |- - List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a - table's change data feed is snapshotting, streaming, or skipped. + Retrieves the snapshot schedule for a branch. A branch with no configured schedule returns an empty + schedule (not NOT_FOUND). - :param parent: str - The parent CdfConfig to list CdfStatuses for. Format: - projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config} - :param page_size: int (optional) - Maximum number of CdfStatuses to return. - :param page_token: str (optional) - Pagination token returned by a previous ListCdfStatuses call. Empty on the first page. + :param name: str + The resource name of the branch's snapshot schedule. Format: + projects/{project_id}/branches/{branch_id}/snapshot-schedule - :returns: Iterator over :class:`CdfStatus` + :returns: :class:`SnapshotSchedule` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - description: 'The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' - - name: page_size - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/snapshot-schedule`). + The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + - name: branch_id + in: path + required: true schema: - type: integer - description: Maximum number of CdfStatuses to return. - - name: page_token - in: query - required: false + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/snapshot-schedule`). + The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotSchedule' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: PostgresAPI + patch: + operationId: postgres_update_snapshot_schedule + summary: Sets the snapshot schedule for a branch. The ``schedule`` field is replaced wholesale; an empty + tags: + - postgres + description: |- + Sets the snapshot schedule for a branch. The ``schedule`` field is replaced wholesale; an empty + schedule disables automatic snapshots. + + :param name: str + The resource name of the branch's snapshot schedule. Format: + projects/{project_id}/branches/{branch_id}/snapshot-schedule + :param snapshot_schedule: :class:`SnapshotSchedule` + The snapshot schedule to set. Its ``name`` identifies the branch. Format: + projects/{project_id}/branches/{branch_id}/snapshot-schedule + :param update_mask: FieldMask + Fields to update. The only updatable path is ``schedule``, which replaces the entire set of + cadences. + + :returns: :class:`Operation` + parameters: + - name: project_id + in: path + required: true schema: type: string - description: Pagination token returned by a previous ListCdfStatuses call. Empty on the first page. + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/snapshot-schedule`). + The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/snapshot-schedule`). + The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + - name: update_mask + in: query + required: true + schema: + type: object + description: Fields to update. The only updatable path is ``schedule``, which replaces the entire set of cadences. + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: 'The resource name of the branch''s snapshot schedule. Format: projects/{project_id}/branches/{branch_id}/snapshot-schedule' + schedule: + type: array + items: + type: object + properties: + retention: + type: string + description: How long snapshots from this cadence are kept before automatic deletion. Must be at least + 1 hour. Applied when a snapshot is taken; not retroactive, so changing it affects only later snapshots. + daily_schedule: + type: object + properties: + hour: + type: integer + description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. + description: Take a snapshot once per day. + monthly_schedule: + type: object + properties: + day: + type: integer + description: The day of the month on which to take the snapshot, in [1, 31]. In shorter months + the snapshot is taken on the last day instead (day 31 runs on Feb 28 or 29, and on Apr 30), + so every month gets exactly one snapshot. + hour: + type: integer + description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. + required: + - day + description: Take a snapshot once per month. + weekly_schedule: + type: object + properties: + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + description: The day of the week on which to take the snapshot. + hour: + type: integer + description: The hour of the day, in UTC, at which to take the snapshot, in [0, 23]. + required: + - day_of_week + description: Take a snapshot once per week. + required: + - retention + description: One cadence at which automatic snapshots are taken. + description: The cadences at which automatic snapshots are taken. Update replaces the whole set; an empty + set disables automatic snapshots. Order is not significant. When several cadences fire together, one snapshot + is taken, retained for the longest of their retentions. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListCdfStatusesResponse' + type: object default: description: Error response content: @@ -3419,61 +4882,73 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/compute-instances: + /api/2.0/postgres/projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses: get: - operationId: postgres_list_compute_instances - summary: 'Lists all compute instances that have been created under the specified endpoint. Note:' + operationId: postgres_list_cdf_statuses + summary: List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a tags: - postgres description: |- - Lists all compute instances that have been created under the specified endpoint. Note: - ComputeInstances are managed via the parent Endpoint resource, and cannot be created, updated, or - deleted directly. + List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a + table's change data feed is snapshotting, streaming, or skipped. :param parent: str - The parent, which owns the compute instances. + The parent CdfConfig to list CdfStatuses for. Format: + projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config} :param page_size: int (optional) - The maximum number of compute instances to return. The service may return fewer than this value. - - If unspecified, at most 50 compute instances will be returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. + Maximum number of CdfStatuses to return. :param page_token: str (optional) - A page token, received from a previous ``ListInstances`` call. Provide this to retrieve the - subsequent page. - - When paginating, all other parameters provided to ``ListInstances`` must match the call that - provided the page token. + Pagination token returned by a previous ListCdfStatuses call. Empty on the first page. - :returns: Iterator over :class:`ComputeInstance` + :returns: Iterator over :class:`CdfStatus` parameters: - - name: parent + - name: project + in: path + required: true + schema: + type: string + description: 'The `project` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: branch in: path required: true schema: type: string - description: The parent, which owns the compute instances. + description: 'The `branch` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: database + in: path + required: true + schema: + type: string + description: 'The `database` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' + - name: cdf_config + in: path + required: true + schema: + type: string + description: 'The `cdf_config` segment of the `parent` resource name (`projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}`). + The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}' - name: page_size in: query required: false schema: type: integer - description: The maximum number of compute instances to return. The service may return fewer than this value. If unspecified, - at most 50 compute instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + description: Maximum number of CdfStatuses to return. - name: page_token in: query required: false schema: type: string - description: A page token, received from a previous ``ListInstances`` call. Provide this to retrieve the subsequent - page. When paginating, all other parameters provided to ``ListInstances`` must match the call that provided the - page token. + description: Pagination token returned by a previous ListCdfStatuses call. Empty on the first page. responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListComputeInstancesResponse' + $ref: '#/components/schemas/ListCdfStatusesResponse' default: description: Error response content: @@ -3486,43 +4961,49 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{parent}/preview/recovery-branches: - get: - operationId: postgres_list_recovery_branch_previews - summary: Returns a paginated list of recovery branches for the project. + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/roles/{role_id}/password: + post: + operationId: postgres_reveal_role_password + summary: Reveals the current password for a password-authenticated Postgres role. tags: - postgres description: |- - Returns a paginated list of recovery branches for the project. + Reveals the current password for a password-authenticated Postgres role. - :param parent: str - :param page_size: int (optional) - :param page_token: str (optional) + :param name: str + The full resource path of the role whose password should be revealed. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} - :returns: Iterator over :class:`RecoveryBranchPreview` + :returns: :class:`RevealRolePasswordResponse` parameters: - - name: parent + - name: project_id in: path required: true schema: type: string - - name: page_size - in: query - required: false + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role whose password should be revealed. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: branch_id + in: path + required: true schema: - type: integer - - name: page_token - in: query - required: false + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role whose password should be revealed. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' + - name: role_id + in: path + required: true schema: type: string + description: 'The `role_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}/roles/{role_id}`). + The full resource path of the role whose password should be revealed. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/ListRecoveryBranchPreviewsResponse' + $ref: '#/components/schemas/RevealRolePasswordResponse' default: description: Error response content: @@ -3535,41 +5016,34 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{name}/switchover: + /api/2.0/postgres/projects/{project_id}/branches/{branch_id}/undelete: post: - operationId: postgres_switchover_replication_group_preview - summary: Switches over the replication group to a target workspace with a coordinated failover. + operationId: postgres_undelete_branch + summary: Undeletes the specified database branch. tags: - postgres description: |- - Switches over the replication group to a target workspace with a coordinated failover. + Undeletes the specified database branch. :param name: str - :param target_workspace: str - :param etag: str (optional) - :param request_id: str (optional) + The full resource path of the branch to undelete. Format: projects/{project_id}/branches/{branch_id} :returns: :class:`Operation` parameters: - - name: name + - name: project_id in: path required: true schema: type: string - requestBody: - content: - application/json: - schema: - type: object - properties: - target_workspace: - type: string - etag: - type: string - request_id: - type: string - required: - - target_workspace + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to undelete. Format: projects/{project_id}/branches/{branch_id}' + - name: branch_id + in: path + required: true + schema: + type: string + description: 'The `branch_id` segment of the `name` resource name (`projects/{project_id}/branches/{branch_id}`). + The full resource path of the branch to undelete. Format: projects/{project_id}/branches/{branch_id}' responses: '200': description: Success @@ -3589,7 +5063,7 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI - /api/2.0/postgres/{name}/undelete: + /api/2.0/postgres/projects/{project_id}/undelete: post: operationId: postgres_undelete_project summary: Undeletes a soft-deleted project. @@ -3603,12 +5077,13 @@ paths: :returns: :class:`Operation` parameters: - - name: name + - name: project_id in: path required: true schema: type: string - description: 'The full resource path of the project to undelete. Format: projects/{project_id}' + description: 'The `project_id` segment of the `name` resource name (`projects/{project_id}`). The full resource path + of the project to undelete. Format: projects/{project_id}' responses: '200': description: Success @@ -3676,8 +5151,7 @@ components: no_expiry: type: boolean description: Explicitly disable expiration. When set to true, the branch will not expire. If set to false, the request - is invalid; provide either ttl or expire_time instead. Mutually exclusive with ``expire_time`` and ``ttl``. When - updating, use ``spec.expiration`` in the update_mask. + is invalid; provide either ttl or expire_time instead. Mutually exclusive with ``expire_time`` and ``ttl``. source_branch: type: string description: 'The name of the source branch from which this branch was created (data lineage for point-in-time recovery). @@ -3689,10 +5163,15 @@ components: type: string format: date-time description: The point in time on the source branch from which this branch was created. + source_snapshot: + type: string + description: 'The snapshot this branch was created from. When set, the branch''s data comes from the snapshot rather + than a source branch, so source_branch, source_branch_lsn, and source_branch_time must be empty. The snapshot + must be AVAILABLE and belong to this branch''s project. Format: projects/{project_id}/snapshots/{snapshot_id}' ttl: type: string description: Relative time-to-live duration. When set, the branch will expire at creation_time + ttl. Mutually exclusive - with ``expire_time`` and ``no_expiry``. When updating, use ``spec.expiration`` in the update_mask. + with ``expire_time`` and ``no_expiry``. BranchStatus: type: object properties: @@ -3736,10 +5215,10 @@ components: type: string format: date-time description: The point in time on the source branch from which this branch was created. - source_recovery_branch: + source_snapshot: type: string - description: 'If this branch is a child of a recovery branch, this field identifies that recovery source. For non-recovery-derived - branches this is unset. Format: projects/{project_id}/preview/recovery-branches/{recovery_branch_id}' + description: 'The snapshot this branch was restored from. Set only for branches created by restoring a snapshot; + unset for all other branches. Format: projects/{project_id}/snapshots/{snapshot_id}' state_change_time: type: string format: date-time @@ -3883,38 +5362,6 @@ components: description: |- The read-only replication status of a single Postgres table replicated under a CdfConfig. One status exists per replicated table. It is created automatically and cannot be modified. - ComputeInstance: - type: object - properties: - name: - type: string - compute_instance_id: - type: string - description: The unique ID for this compute. - compute_host: - type: string - description: A host scoped directly to the enclosing compute. This host is guaranteed to resolve to the specific - compute instance. - current_state: - $ref: '#/components/schemas/ComputeInstanceComputeState' - description: The current state of the compute. - pending_state: - $ref: '#/components/schemas/ComputeInstanceComputeState' - description: The desired pending state of the compute, if a state transition is in progress. - role: - $ref: '#/components/schemas/ComputeInstanceComputeType' - description: The role of this compute within the endpoint. - start_time: - type: string - format: date-time - description: A timestamp indicating when the compute was last started. - suspend_time: - type: string - format: date-time - description: A timestamp indicating when the compute was last suspended. - required: - - name - - compute_instance_id DailySchedule: type: object properties: @@ -3954,10 +5401,6 @@ components: db_aggregates_enabled: type: boolean description: 'Enable aggregate functions (count, sum, avg, etc.) in Data API responses. Default: true.' - db_anon_role: - type: string - description: 'The PostgreSQL role used for unauthenticated (anonymous) requests. Must be a valid PostgreSQL role - name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Default: "anonymous".' db_extra_search_path: type: array items: @@ -4003,9 +5446,6 @@ components: db_aggregates_enabled: type: boolean description: Actual aggregate function setting read from the database. - db_anon_role: - type: string - description: Actual anonymous role name read from the database. db_extra_search_path: type: array items: @@ -4119,16 +5559,6 @@ components: stack_trace: type: string description: Databricks Error that is returned by all Databricks APIs. - DeleteForwardEtlConfigurationResponse: - type: object - properties: - deleted_configs: - type: integer - description: Number of configuration rows deleted (0 or 1). - deleted_mappings: - type: integer - description: Number of table mapping rows deleted. - description: Response to delete Forward ETL configuration. DeltaTableSyncInfo: type: object properties: @@ -4138,13 +5568,6 @@ components: delta_commit_version: type: integer description: The Delta Lake commit version that was last successfully synced. - DisableForwardEtlResponse: - type: object - properties: - disabled: - type: boolean - description: Whether Forward ETL was successfully disabled. - description: Response to disable Forward ETL Endpoint: type: object properties: @@ -4264,15 +5687,13 @@ components: no_suspension: type: boolean description: When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when - provided. Mutually exclusive with ``suspend_timeout_duration``. When updating, use ``spec.suspension`` in the - update_mask. + provided. Mutually exclusive with ``suspend_timeout_duration``. settings: $ref: '#/components/schemas/EndpointSettings' suspend_timeout_duration: type: string description: Duration of inactivity after which the compute endpoint is automatically suspended. If specified should - be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. When updating, use - ``spec.suspension`` in the update_mask. + be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. required: - endpoint_type EndpointStatus: @@ -4312,110 +5733,6 @@ components: suspend_timeout_duration: type: string description: Duration of inactivity after which the compute endpoint is automatically suspended. - ForwardEtlConfig: - type: object - properties: - create_time_millis: - type: integer - description: Configuration creation timestamp in milliseconds since epoch. - enabled: - type: boolean - description: Whether Forward ETL is enabled. - pg_database_oid: - type: integer - description: PostgreSQL database OID. - pg_schema_oid: - type: integer - description: PostgreSQL schema OID. - tenant_id: - type: string - description: Tenant ID (dashless UUID format). - timeline_id: - type: string - description: Timeline ID (dashless UUID format). - uc_catalog_id: - type: string - description: Unity Catalog catalog ID. - uc_schema_id: - type: string - description: Unity Catalog schema ID. - update_time_millis: - type: integer - description: Configuration last update timestamp in milliseconds since epoch. - workspace_id: - type: integer - description: Workspace ID. - description: Forward ETL configuration - ForwardEtlDatabase: - type: object - properties: - name: - type: string - description: Database name. - oid: - type: integer - description: PostgreSQL database OID. - description: Database metadata - ForwardEtlMetadata: - type: object - properties: - databases: - type: array - items: - $ref: '#/components/schemas/ForwardEtlDatabase' - description: List of databases with their PostgreSQL OIDs. - schemas: - type: array - items: - $ref: '#/components/schemas/ForwardEtlSchema' - description: List of schemas with their PostgreSQL OIDs. - description: Forward ETL metadata response - ForwardEtlSchema: - type: object - properties: - name: - type: string - description: Schema name. - oid: - type: integer - description: PostgreSQL schema OID. - description: Schema metadata - ForwardEtlStatus: - type: object - properties: - configurations: - type: array - items: - $ref: '#/components/schemas/ForwardEtlConfig' - description: List of Forward ETL configurations. - table_mappings: - type: array - items: - $ref: '#/components/schemas/ForwardEtlTableMapping' - description: Per-table replication mappings. - description: Forward ETL status response - ForwardEtlTableMapping: - type: object - properties: - enabled: - type: boolean - description: Whether replication is enabled for this table. - last_synced_lsn: - type: string - description: Last synced LSN (Log Sequence Number) for this table. - pg_table_name: - type: string - description: PostgreSQL table name. - pg_table_oid: - type: integer - description: PostgreSQL table OID. - uc_table_id: - type: string - description: Unity Catalog table ID. - uc_table_name: - type: string - description: Unity Catalog table name. - description: Per-table replication mapping InitialBranchSpec: type: object properties: @@ -4423,18 +5740,6 @@ components: type: boolean description: Whether the initial default branch should be protected from deletion. description: Configuration for the initial default branch created during project creation. - InitialDatabaseSpec: - type: object - properties: - postgres_database: - type: string - description: The name of the Postgres database. This expects a valid Postgres identifier as specified in the link - below. https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS - description: |- - Configuration for the initial Postgres database created inside the initial branch for a newly - created project. If omitted, the initial branch still gets an initial database with name - ``databricks_postgres``. The initial database is always owned by the initial Postgres role - (whether caller-provided via ``initial_role_spec`` or defaulted to the caller's identity). InitialEndpointSpec: type: object properties: @@ -4456,43 +5761,6 @@ components: description: Duration of inactivity after which the initial endpoint is automatically suspended. If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. description: Configuration for the initial Read/Write endpoint created during project creation. - InitialRoleSpec: - type: object - properties: - attributes: - $ref: '#/components/schemas/RoleAttributes' - description: The desired API-exposed Postgres role attribute to associate with the role. Optional. - auth_method: - $ref: '#/components/schemas/RoleAuthMethod' - description: 'Controls how the Postgres role authenticates when a client opens a database connection. Supported - values: - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth access token derived from - the backing managed identity (the Databricks user, service principal, or group named by the role''s ``postgres_role``). - No static password exists for roles using this method. - PG_PASSWORD_SCRAM_SHA_256: the role authenticates with - a Postgres password verified server-side using the SCRAM-SHA-256 mechanism. Lakebase generates a password for - the role. - NO_LOGIN: the role cannot open a Postgres session at all. Useful for roles that exist only to own - objects or to aggregate privileges that are then granted to other, loginable roles. If auth_method is left unspecified, - a meaningful authentication method is derived from the identity_type: - For the managed identities, OAUTH is used. - - For the regular postgres roles, authentication based on postgres passwords is used. NOTE: for the Databricks - identity type GROUP, LAKEBASE_OAUTH_V1 is the default auth method (group can login as well).' - identity_type: - $ref: '#/components/schemas/RoleIdentityType' - description: 'The type of role. When specifying a managed-identity, the chosen role_id must be a valid: - application - ID for SERVICE_PRINCIPAL - user email for USER - group name for GROUP' - membership_roles: - type: array - items: - $ref: '#/components/schemas/RoleMembershipRole' - description: An enum value for a standard role that this role is a member of. - postgres_role: - type: string - description: 'The name of the Postgres role. This expects a valid Postgres identifier as specified in the link below. - https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS If you wish to create a - Postgres Role backed by a managed Databricks identity, then postgres_role must be one of the following: 1. user - email for IdentityType.USER 2. app ID for IdentityType.SERVICE_PRINCIPAL 3. group name for IdentityType.GROUP' - description: |- - Configuration for the initial Postgres role created inside the initial branch for a newly - created project. If omitted, the default branch still gets an initial Postgres role - corresponding to the caller of the API endpoint. ListBranchesResponse: type: object properties: @@ -4531,17 +5799,6 @@ components: description: |- Response to a ListCdfStatuses request, containing a page of replicated table statuses and a token for fetching the next page. - ListComputeInstancesResponse: - type: object - properties: - compute_instances: - type: array - items: - $ref: '#/components/schemas/ComputeInstance' - next_page_token: - type: string - description: A token, which can be sent as ``page_token`` to retrieve the next page. If this field is omitted, there - are no subsequent pages. ListDatabasesResponse: type: object properties: @@ -4572,24 +5829,6 @@ components: items: $ref: '#/components/schemas/Project' description: List of all projects in the workspace that the user has permission to access. - ListRecoveryBranchPreviewsResponse: - type: object - properties: - next_page_token: - type: string - recovery_branch_previews: - type: array - items: - $ref: '#/components/schemas/RecoveryBranchPreview' - ListReplicationGroupPreviewsResponse: - type: object - properties: - next_page_token: - type: string - replication_group_previews: - type: array - items: - $ref: '#/components/schemas/ReplicationGroupPreview' ListRolesResponse: type: object properties: @@ -4678,23 +5917,12 @@ components: description: Configuration for the initial default branch created as part of project creation. Allows overriding branch protection. These settings only apply at creation time and do not affect resources created after project creation. - initial_database_spec: - $ref: '#/components/schemas/InitialDatabaseSpec' - description: Configuration for the initial Postgres database created inside the initial branch for this project. - If omitted, the initial branch still gets an initial database with name ``databricks_postgres``. The initial database - is always owned by the initial role (caller-provided via ``initial_role_spec`` or defaulted to the caller's identity). - This field is input-only; to change databases after project creation, use the standalone Database API. initial_endpoint_spec: $ref: '#/components/schemas/InitialEndpointSpec' description: Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly created project. If omitted, the initial endpoint created will have default settings, without high availability configured. This field does not apply to any endpoints created after project creation. Use spec.default_endpoint_settings to configure default settings for endpoints created after project creation. - initial_role_spec: - $ref: '#/components/schemas/InitialRoleSpec' - description: Configuration for the initial Postgres role created inside the initial branch for this project. If - omitted, the initial branch gets an initial role corresponding to the caller of the API endpoint. This field is - input-only; to change roles after project creation, use the standalone Role API. name: type: string description: 'Output only. The full resource path of the project. Format: projects/{project_id}' @@ -4740,16 +5968,14 @@ components: no_suspension: type: boolean description: When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when - provided. Mutually exclusive with ``suspend_timeout_duration``. When updating, use ``spec.project_default_settings.suspension`` - in the update_mask. + provided. Mutually exclusive with ``suspend_timeout_duration``. pg_settings: type: object description: A raw representation of Postgres settings. suspend_timeout_duration: type: string description: Duration of inactivity after which the compute endpoint is automatically suspended. If specified should - be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. When updating, use - ``spec.project_default_settings.suspension`` in the update_mask. + be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with ``no_suspension``. description: A collection of settings for a compute endpoint. ProjectOperationMetadata: type: object @@ -4759,10 +5985,6 @@ components: properties: budget_policy_id: type: string - compute_provisioner: - type: string - description: The compute provisioner used to provision endpoints in this project. Overrides the default provisioner - when set. custom_tags: type: array items: @@ -4802,9 +6024,6 @@ components: type: string format: date-time description: The most recent time when any endpoint of this project was active. - compute_provisioner: - type: string - description: The effective compute provisioner backing this project's endpoints. custom_tags: type: array items: @@ -4815,136 +6034,28 @@ components: description: The full resource path of the default branch of the project default_endpoint_settings: $ref: '#/components/schemas/ProjectDefaultEndpointSettings' - description: The effective default endpoint settings. - display_name: - type: string - description: The effective human-readable project name. - enable_pg_native_login: - type: boolean - description: Whether to enable PG native password login on all endpoints in this project. - history_retention_duration: - type: string - description: The effective number of seconds to retain the shared history for point in time recovery. - owner: - type: string - description: The email of the project owner. - pg_version: - type: integer - description: The effective major Postgres version number. - project_id: - type: string - description: Part of the resource name. - replication_role: - $ref: '#/components/schemas/ReplicationRolePreview' - description: The replication role of the project in this workspace. Populated only when cross-workspace replication - is configured. - synthetic_storage_size_bytes: - type: integer - description: The current space occupied by the project in storage. - RecoveryBranchPreview: - type: object - properties: - create_time: - type: string - format: date-time - name: - type: string - description: 'The resource name of the recovery branch. Format: projects/{project_id}/preview/recovery-branches/{recovery_branch_id}' - parent: - type: string - description: 'The project containing this recovery branch. Format: projects/{project_id}' - status: - $ref: '#/components/schemas/RecoveryBranchPreviewStatus' - uid: - type: string - update_time: - type: string - format: date-time - RecoveryBranchPreviewStatus: - type: object - properties: - current_state: - $ref: '#/components/schemas/RecoveryBranchPreviewStatusState' - divergent: - type: boolean - end_lsn: - type: string - description: The Log Sequence Number (LSN) up to which the recovery branch's timeline holds data. - expire_time: - type: string - format: date-time - failover_child_lsn: - type: string - description: The Log Sequence Number (LSN) at which a local child timeline was branched off this recovery branch's - timeline during recovery branch creation. - home_workspace: - type: string - description: 'The workspace that owns the source branch and where reconciliation completes. Format: a workspace - identifier.' - is_foreign: - type: boolean - origin_branch: - type: string - description: 'The normal branch from which this recovery branch originated. Format: projects/{project_id}/branches/{branch_id}' - ReplicationGroupPreview: - type: object - properties: - replication_mode: - $ref: '#/components/schemas/ReplicationModePreview' - workspaces: - type: array - items: - type: string - description: The workspaces participating in this replication group. Phase 1 requires exactly 2 entries. - create_time: - type: string - format: date-time - description: Server-generated timestamps. - etag: - type: string - description: Optional optimistic concurrency token for update and delete. - name: - type: string - description: 'The resource name of the replication group. Format: projects/{project_id}/preview/replication-groups/{replication_group_id}' - observed_metrics: - $ref: '#/components/schemas/ReplicationMetricsPreview' - description: The latest observed replication metrics for this group. - parent: - type: string - description: 'The parent project that owns this replication group. Format: projects/{project_id}' - primary_workspace: + description: The effective default endpoint settings. + display_name: type: string - description: The workspace currently serving writes. Server-owned. - state: - $ref: '#/components/schemas/ReplicationGroupPreviewState' - description: The lifecycle state of the replication group. - update_time: + description: The effective human-readable project name. + enable_pg_native_login: + type: boolean + description: Whether to enable PG native password login on all endpoints in this project. + history_retention_duration: type: string - format: date-time - required: - - replication_mode - - workspaces - ReplicationGroupPreviewOperationMetadata: - type: object - properties: {} - description: |- - Empty placeholder; required by every LRO ``metadata_type``. Mirrors BranchOperationMetadata / - RoleOperationMetadata. - ReplicationMetricsPreview: - type: object - properties: - as_of_time: + description: The effective number of seconds to retain the shared history for point in time recovery. + owner: type: string - format: date-time - bytes_lag: - type: integer - description: The most recent observed byte lag. - throughput_bytes_per_second: + description: The email of the project owner. + pg_version: type: integer - description: The most recent observed replication throughput. - time_lag: + description: The effective major Postgres version number. + project_id: type: string - description: The most recent observed time lag. + description: Part of the resource name. + synthetic_storage_size_bytes: + type: integer + description: The current space occupied by the project in storage. RequestedClaims: type: object properties: @@ -4959,6 +6070,13 @@ components: properties: table_name: type: string + RevealRolePasswordResponse: + type: object + properties: + password: + type: string + description: The current password for the Postgres role. + description: Response containing the password for a password-authenticated Postgres role. Role: type: object properties: @@ -5097,17 +6215,13 @@ components: uid: type: string description: Unique system-generated ID for the snapshot. - update_time: - type: string - format: date-time - description: When the snapshot was last updated. description: |- An immutable, point-in-time copy of a branch's data within a project. It remains available after the source branch is deleted. SnapshotOperationMetadata: type: object properties: {} - description: Metadata for the long-running snapshot Create, Update, and Delete operations. + description: Metadata for the long-running snapshot Create and Delete operations. SnapshotSchedule: type: object properties: @@ -5126,6 +6240,10 @@ components: (singleton); it is configured in place, not created or deleted. Name: projects/{project_id}/branches/{branch_id}/snapshot-schedule + SnapshotScheduleOperationMetadata: + type: object + properties: {} + description: Metadata for the long-running snapshot schedule Update operation. SnapshotSpec: type: object properties: @@ -5149,16 +6267,13 @@ components: ttl: type: string description: Time-to-live. The snapshot expires this long after it is created. Mutually exclusive with ``expire_time`` - and ``no_expiry``. + and ``no_expiry``. Reads report the resolved absolute ``expire_time`` instead. required: - source_branch description: Client-provided configuration of the snapshot. SnapshotStatus: type: object properties: - current_state: - $ref: '#/components/schemas/SnapshotStatusState' - description: The snapshot's current state. diff_size_bytes: type: integer description: Incremental storage size in bytes since the previous snapshot. Unset when the snapshot is not billed @@ -5176,13 +6291,6 @@ components: source_branch: type: string description: 'The source branch the snapshot was taken from. Format: projects/{project_id}/branches/{branch_id}' - source_branch_lsn: - type: string - description: The LSN at which the snapshot was taken. - source_branch_time: - type: string - format: date-time - description: The point in time at which the snapshot was taken. description: Server-observed state of a snapshot. SyncedTable: type: object @@ -5197,8 +6305,7 @@ components: in the Unity catalog look for the "source_table_full_name" attribute. spec: $ref: '#/components/schemas/SyncedTableSyncedTableSpec' - description: Configuration details of the synced table, such as the source table, scheduling policy, etc. This attribute - is specified at creation time and most fields are returned as is on subsequent queries. + description: Configuration details of the synced table, such as the source table, scheduling policy, etc. status: $ref: '#/components/schemas/SyncedTableSyncedTableStatus' description: Synced Table data synchronization status. @@ -5271,11 +6378,6 @@ components: items: $ref: '#/components/schemas/SyncedTableSyncedTableSpecExtraColumn' description: Extra PostgreSQL-only columns to add to the synced table. - extra_index_definitions: - type: array - items: - $ref: '#/components/schemas/SyncedTableSyncedTableSpecSecondaryIndex' - description: Secondary indexes to create on the synced table. new_pipeline_spec: $ref: '#/components/schemas/NewPipelineSpec' description: Specification for creating a new pipeline. At most one of existing_pipeline_id and new_pipeline_spec @@ -5326,23 +6428,6 @@ components: - column_name - column_type description: An extra PostgreSQL column to add to the synced table. - SyncedTableSyncedTableSpecSecondaryIndex: - type: object - properties: - name: - type: string - description: Name of the index as it will appear in PostgreSQL. - definition: - type: string - description: 'The definition portion of a CREATE INDEX statement, placed after ON table_name. For example: USING - hnsw (embedding vector_cosine_ops) WITH (m = 16, ef_construction = 64).' - creation_point: - $ref: '#/components/schemas/SyncedTableSyncedTableSpecSecondaryIndexCreationPoint' - description: When the index should be created relative to the initial data load. - required: - - name - - definition - description: Definition of a secondary index to create on the synced table. SyncedTableSyncedTableSpecTypeOverride: type: object properties: @@ -5393,31 +6478,6 @@ components: unity_catalog_provisioning_state: $ref: '#/components/schemas/ProvisioningInfoState' description: The provisioning state of the synced table entity in Unity Catalog. - Table: - type: object - properties: - name: - type: string - description: Full three-part (catalog, schema, table) name of the table. - database: - type: string - description: 'The project and branch scoped database to which this table belongs. Of the format: projects/{project_id}/branches/{branch_id}/databases/{database_id} - where database_id is the name of the logical database in Postgres.' - branch: - type: string - description: The id of the database branch associated with the table. Of the format projects/{project_id}/branches/{branch_id}. - project: - type: string - description: The id of the database project associated with the table. Of the format projects/{project_id}. - table_serving_url: - type: string - description: REST API URL for serving data from this table. - required: - - name - - database - description: |- - Table represents a non-synced database table in a Lakebase project. Unlike SyncedTable, this - does not have a data synchronization pipeline. WeeklySchedule: type: object properties: @@ -5448,92 +6508,6 @@ components: - CDF_STATE_STREAMING - CDF_STATE_TERMINATED description: The replication state of a single replicated table (CdfStatus). - ComputeInstanceComputeState: - type: string - x-enum: - - ACTIVE - - IDLE - - INIT - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - ComputeInstanceComputeType: - type: string - x-enum: - - HOT_STANDBY - - READ_ONLY - - READ_WRITE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. DayOfWeek: type: string x-enum: @@ -5715,112 +6689,6 @@ components: - PROVISIONING_PHASE_INDEX_SORT - PROVISIONING_PHASE_MAIN description: The current phase of the data synchronization pipeline. - RecoveryBranchPreviewStatusState: - type: string - x-enum: - - PENDING_HOME_SYNC - - READY_FOR_INSPECTION - - RECONCILED - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - ReplicationGroupPreviewState: - type: string - x-enum: - - REPLICATION_GROUP_PREVIEW_STATE_DEGRADED - - REPLICATION_GROUP_PREVIEW_STATE_DELETING - - REPLICATION_GROUP_PREVIEW_STATE_FAILING_OVER - - REPLICATION_GROUP_PREVIEW_STATE_PROVISIONING - - REPLICATION_GROUP_PREVIEW_STATE_READY - - REPLICATION_GROUP_PREVIEW_STATE_SWITCHING_OVER - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - ReplicationModePreview: - type: string - x-enum: - - REPLICATION_MODE_PREVIEW_LIVE - - REPLICATION_MODE_PREVIEW_PERIODIC - description: |- - How changes are propagated from the primary workspace to its secondaries in a replication group: - on a fixed schedule or continuously as they occur. - ReplicationRolePreview: - type: string - x-enum: - - REPLICATION_ROLE_PREVIEW_DEMOTING - - REPLICATION_ROLE_PREVIEW_PRIMARY - - REPLICATION_ROLE_PREVIEW_SECONDARY - description: |- - The replication role of the project in its current workspace. Populated only when - cross-workspace replication is configured for the project. RequestedClaimsPermissionSet: type: string x-enum: @@ -5883,14 +6751,6 @@ components: x-enum: - DATABRICKS_SUPERUSER description: Roles that the DatabaseInstanceRole can be a member of. - SnapshotStatusState: - type: string - x-enum: - - AVAILABLE - - CREATING - - DELETING - - FAILED - description: The state of the snapshot. SyncedTableState: type: string x-enum: @@ -5909,7 +6769,6 @@ components: SyncedTableSyncedTableSpecExtraColumnMaintenance: type: string x-enum: - - DEFAULT_VALUE - STORED_GENERATED description: How the column's value is populated and kept up to date. SyncedTableSyncedTableSpecPgSpecificType: @@ -5919,11 +6778,6 @@ components: - PG_SPECIFIC_TYPE_VARCHAR - PG_SPECIFIC_TYPE_VECTOR description: PostgreSQL-specific target types that can override the default Delta-to-PG mapping. - SyncedTableSyncedTableSpecSecondaryIndexCreationPoint: - type: string - x-enum: - - CREATION_POINT_AFTER_DATA_LOAD - description: Controls when the index is created relative to the initial data load. SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy: type: string x-enum: @@ -5942,24 +6796,54 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1branches/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.branches + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}/patch' response: mediaType: application/json openAPIDocKey: '200' - list: + undelete: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1branches/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1undelete/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.branches sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_branches/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_branches/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_branches/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_branches/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/postgres_branches/methods/delete' replace: [] postgres_catalogs: id: databricks_workspace.postgres.postgres_catalogs @@ -5975,12 +6859,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1catalogs~1{catalog_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1catalogs~1{catalog_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/postgres_catalogs/methods/get' insert: - $ref: '#/components/x-stackQL-resources/postgres_catalogs/methods/create' update: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/postgres_catalogs/methods/delete' replace: [] postgres_cdf_configs: id: databricks_workspace.postgres.postgres_cdf_configs @@ -5992,24 +6890,38 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1cdf-configs/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1cdf-configs/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.cdf_configs + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs~1{cdf_config}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs~1{cdf_config}/get' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_cdf_configs/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_cdf_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_cdf_configs/methods/create' update: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/postgres_cdf_configs/methods/delete' replace: [] postgres_data_apis: id: databricks_workspace.postgres.postgres_data_apis @@ -6021,16 +6933,40 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1data-api/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}~1data-api/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}~1data-api/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}~1data-api/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}~1data-api/patch' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/postgres_data_apis/methods/get' insert: - $ref: '#/components/x-stackQL-resources/postgres_data_apis/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_data_apis/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/postgres_data_apis/methods/delete' replace: [] postgres_databases: id: databricks_workspace.postgres.postgres_databases @@ -6042,24 +6978,48 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1databases/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1databases/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.databases + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1databases~1{database_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_databases/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_databases/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_databases/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_databases/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/postgres_databases/methods/delete' replace: [] postgres_endpoints: id: databricks_workspace.postgres.postgres_endpoints @@ -6071,24 +7031,48 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1endpoints/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1endpoints/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1endpoints/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1endpoints/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpoints + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1endpoints~1{endpoint_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1endpoints~1{endpoint_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1endpoints~1{endpoint_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_endpoints/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_endpoints/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_endpoints/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_endpoints/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/postgres_endpoints/methods/delete' replace: [] postgres_projects: id: databricks_workspace.postgres.postgres_projects @@ -6111,117 +7095,100 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.projects + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' update: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}/patch' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}/patch' response: mediaType: application/json openAPIDocKey: '200' undelete: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}~1undelete/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1undelete/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_projects/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_projects/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_projects/methods/create' update: - $ref: '#/components/x-stackQL-resources/postgres_projects/methods/update' - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/postgres_projects/methods/delete' replace: [] - postgres_replication_group_previews: - id: databricks_workspace.postgres.postgres_replication_group_previews - name: postgres_replication_group_previews - title: Postgres Replication Group Previews + postgres_roles: + id: databricks_workspace.postgres.postgres_roles + name: postgres_roles + title: Postgres Roles methods: create: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1preview~1replication-groups/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1preview~1replication-groups/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.replication_group_previews - failover: - config: - requestBodyTranslate: - algorithm: naive + objectKey: $.roles + delete: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}~1failover/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles~1{role_id}/delete' response: mediaType: application/json openAPIDocKey: '200' - switchover: - config: - requestBodyTranslate: - algorithm: naive + get: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}~1switchover/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles~1{role_id}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/postgres_replication_group_previews/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/postgres_replication_group_previews/methods/create' - update: [] - delete: [] - replace: [] - postgres_roles: - id: databricks_workspace.postgres.postgres_roles - name: postgres_roles - title: Postgres Roles - methods: - create: + update: config: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1roles/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1roles/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.roles - delete: - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}/delete' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles~1{role_id}/patch' response: mediaType: application/json openAPIDocKey: '200' - get: + reveal_password: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1roles~1{role_id}~1password/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/list' - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/get' + - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/update' delete: - $ref: '#/components/x-stackQL-resources/postgres_roles/methods/delete' replace: [] @@ -6235,24 +7202,38 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1snapshots/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1snapshots/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1snapshots/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1snapshots/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.snapshots + delete: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1snapshots~1{snapshot_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1snapshots~1{snapshot_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/postgres_snapshots/methods/get' - $ref: '#/components/x-stackQL-resources/postgres_snapshots/methods/list' insert: - $ref: '#/components/x-stackQL-resources/postgres_snapshots/methods/create' update: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/postgres_snapshots/methods/delete' replace: [] postgres_synced_tables: id: databricks_workspace.postgres.postgres_synced_tables @@ -6268,90 +7249,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/postgres_synced_tables/methods/create' - update: [] - delete: [] - replace: [] - postgres_tables: - id: databricks_workspace.postgres.postgres_tables - name: postgres_tables - title: Postgres Tables - methods: - create: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1postgres~1tables/post' - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1api~12.0~1postgres~1tables~1{name}/delete' + $ref: '#/paths/~1api~12.0~1postgres~1synced_tables~1{full_name}/delete' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.0~1postgres~1tables~1{name}/get' + $ref: '#/paths/~1api~12.0~1postgres~1synced_tables~1{full_name}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/postgres_tables/methods/get' + - $ref: '#/components/x-stackQL-resources/postgres_synced_tables/methods/get' insert: - - $ref: '#/components/x-stackQL-resources/postgres_tables/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/postgres_tables/methods/delete' - replace: [] - postgres_forward_etl_configurations: - id: databricks_workspace.postgres.postgres_forward_etl_configurations - name: postgres_forward_etl_configurations - title: Postgres Forward Etl Configurations - methods: - delete: - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1forward-etl~1configuration/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/postgres_forward_etl_configurations/methods/delete' - replace: [] - postgres_forward_etl: - id: databricks_workspace.postgres.postgres_forward_etl - name: postgres_forward_etl - title: Postgres Forward Etl - methods: - disable: - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1forward-etl/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1forward-etl/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/postgres_forward_etl/methods/get' - insert: [] + - $ref: '#/components/x-stackQL-resources/postgres_synced_tables/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/postgres_forward_etl/methods/disable' + - $ref: '#/components/x-stackQL-resources/postgres_synced_tables/methods/delete' replace: [] postgres_credentials: id: databricks_workspace.postgres.postgres_credentials @@ -6373,88 +7290,76 @@ components: update: [] delete: [] replace: [] - postgres_forward_etl_metadata: - id: databricks_workspace.postgres.postgres_forward_etl_metadata - name: postgres_forward_etl_metadata - title: Postgres Forward Etl Metadata + postgres_cdf_statuses: + id: databricks_workspace.postgres.postgres_cdf_statuses + name: postgres_cdf_statuses + title: Postgres Cdf Statuses methods: get: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1forward-etl~1metadata/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/postgres_forward_etl_metadata/methods/get' - insert: [] - update: [] - delete: [] - replace: [] - postgres_recovery_branch_previews: - id: databricks_workspace.postgres.postgres_recovery_branch_previews - name: postgres_recovery_branch_previews - title: Postgres Recovery Branch Previews - methods: - inspect: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1postgres~1{name}~1inspect/post' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs~1{cdf_config}~1cdf-statuses~1{cdf_status}/get' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1preview~1recovery-branches/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project}~1branches~1{branch}~1databases~1{database}~1cdf-configs~1{cdf_config}~1cdf-statuses/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recovery_branch_previews + objectKey: $.cdf_statuses sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/postgres_recovery_branch_previews/methods/list' + - $ref: '#/components/x-stackQL-resources/postgres_cdf_statuses/methods/get' + - $ref: '#/components/x-stackQL-resources/postgres_cdf_statuses/methods/list' insert: [] update: [] delete: [] replace: [] - postgres_cdf_statuses: - id: databricks_workspace.postgres.postgres_cdf_statuses - name: postgres_cdf_statuses - title: Postgres Cdf Statuses + postgres_operations: + id: databricks_workspace.postgres.postgres_operations + name: postgres_operations + title: Postgres Operations methods: - list: + get: operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1cdf-statuses/get' + $ref: '#/paths/~1api~12.0~1postgres~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.cdf_statuses sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/postgres_cdf_statuses/methods/list' + - $ref: '#/components/x-stackQL-resources/postgres_operations/methods/get' insert: [] update: [] delete: [] replace: [] - postgres_compute_instances: - id: databricks_workspace.postgres.postgres_compute_instances - name: postgres_compute_instances - title: Postgres Compute Instances + postgres_snapshot_schedules: + id: databricks_workspace.postgres.postgres_snapshot_schedules + name: postgres_snapshot_schedules + title: Postgres Snapshot Schedules methods: - list: + get: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1snapshot-schedule/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive operation: - $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1compute-instances/get' + $ref: '#/paths/~1api~12.0~1postgres~1projects~1{project_id}~1branches~1{branch_id}~1snapshot-schedule/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.compute_instances sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/postgres_compute_instances/methods/list' + - $ref: '#/components/x-stackQL-resources/postgres_snapshot_schedules/methods/get' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/postgres_snapshot_schedules/methods/update' delete: [] replace: [] vw_projects: @@ -6533,7 +7438,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_projects - WHERE deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -6554,7 +7458,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_projects - WHERE deployment_name = '{{ deployment_name }}' vw_branches: name: vw_branches id: databricks_workspace.postgres.vw_branches @@ -6622,8 +7525,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_branches - WHERE project_id = '{{ project_id }}' - AND deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -6641,8 +7542,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_branches - WHERE project_id = '{{ project_id }}' - AND deployment_name = '{{ deployment_name }}' vw_databases: name: vw_databases id: databricks_workspace.postgres.vw_databases @@ -6689,9 +7588,6 @@ components: JSON_EXTRACT(status, '$.postgres_database') AS postgres_database, SPLIT_PART(JSON_EXTRACT(status, '$.role'), '/', -1) AS role FROM databricks_workspace.postgres.postgres_databases - WHERE deployment_name = '{{ deployment_name }}' - AND project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -6703,9 +7599,6 @@ components: (status::jsonb)->>'postgres_database' AS postgres_database, SPLIT_PART((status::jsonb)->>'role', '/', -1) AS role FROM databricks_workspace.postgres.postgres_databases - WHERE deployment_name = '{{ deployment_name }}' - AND project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' vw_roles: name: vw_roles id: databricks_workspace.postgres.vw_roles @@ -6780,9 +7673,6 @@ components: JSON_EXTRACT(status, '$.postgres_role') AS postgres_role, update_time FROM databricks_workspace.postgres.postgres_roles - WHERE project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' - AND deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -6801,9 +7691,6 @@ components: (status::jsonb)->>'postgres_role' AS postgres_role, update_time FROM databricks_workspace.postgres.postgres_roles - WHERE project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' - AND deployment_name = '{{ deployment_name }}' vw_endpoints: name: vw_endpoints id: databricks_workspace.postgres.vw_endpoints @@ -6902,9 +7789,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_endpoints - WHERE project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' - AND deployment_name = '{{ deployment_name }}' fallback: predicate: sqlDialect == "postgres" ddl: |- @@ -6929,9 +7813,6 @@ components: uid, update_time FROM databricks_workspace.postgres.postgres_endpoints - WHERE project_id = '{{ project_id }}' - AND branch_id = '{{ branch_id }}' - AND deployment_name = '{{ deployment_name }}' x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml b/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml index aefcbd38..f40faf2f 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml @@ -6,14 +6,31 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.qualitymonitorv2 servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/quality-monitors: post: @@ -41,328 +58,76 @@ paths: schema: type: object properties: - quality_monitor: + object_type: + type: string + object_id: + type: string + description: The uuid of the request object. For example, schema id. + anomaly_detection_config: type: object properties: - object_type: - type: string - object_id: - type: string - description: The uuid of the request object. For example, schema id. - anomaly_detection_config: - type: object - properties: - custom_check_configurations: - type: array - items: - type: object - properties: - scalar_check: - type: object - properties: - check_name: - type: string - column_matchers: - type: array - items: - type: object - properties: - column_names: - type: array - items: - type: string - variable_name: - type: string - description: >- - Variable name within a custom sql query - that this matcher applies to. - description: >- - Column matchers to determine which tables - to apply this check to - sql_query: - type: string - description: Templated SQL query for this check - thresholds: - type: object - properties: - lower_bound: - type: object - properties: - bound_value: - type: integer - threshold_type: - type: string - x-enum: - - THRESHOLD_TYPE_AUTO - - THRESHOLD_TYPE_MANUAL - - THRESHOLD_TYPE_UNBOUNDED - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and - know how many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , - ] - - - Methods can be added to enumerations, - and members can have their own - - attributes -- see the documentation for - details. - upper_bound: - type: object - properties: - bound_value: - type: integer - threshold_type: - type: string - x-enum: - - THRESHOLD_TYPE_AUTO - - THRESHOLD_TYPE_MANUAL - - THRESHOLD_TYPE_UNBOUNDED - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and - know how many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , - ] - - - Methods can be added to enumerations, - and members can have their own - - attributes -- see the documentation for - details. - description: Upper bound threshold - description: >- - Upper/lower thresholds for the output of - the query - excluded_table_full_names: - type: array - items: - type: string - description: >- - List of fully qualified table names to exclude from - anomaly detection. - job_type: - type: string - x-enum: - - >- - ANOMALY_DETECTION_JOB_TYPE_BACKGROUND_COMPUTE_WORKER - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: The type of the last run of the workflow. - last_run_id: - type: string - description: Run id of the last run of the workflow - latest_run_status: - type: string - x-enum: - - ANOMALY_DETECTION_RUN_STATUS_CANCELED - - ANOMALY_DETECTION_RUN_STATUS_FAILED - - ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED - - ANOMALY_DETECTION_RUN_STATUS_PENDING - - ANOMALY_DETECTION_RUN_STATUS_RUNNING - - ANOMALY_DETECTION_RUN_STATUS_SUCCESS - - ANOMALY_DETECTION_RUN_STATUS_UNKNOWN - - >- - ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR - description: The status of the last run of the workflow. - slicing_config: - type: object - properties: - slice_specs: - type: array - items: - type: object - properties: - column_group: - type: array - items: - type: object - properties: - name: - type: string - description: >- - The name of the column to slice on. The - top-K column values are auto-discovered. - required: - - name - description: >- - A column to slice completeness - monitoring on. - description: The columns to group by for slicing. - description: >- - A single slice dimension for per-slice - completeness monitoring. - description: The set of slice dimensions to monitor. - description: Per-schema completeness slicing configuration. - validity_check_configurations: - type: array - items: - type: object - properties: - name: - type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - validity_check_configurations: + excluded_table_full_names: type: array items: + type: string + last_run_id: + type: string + description: Run id of the last run of the workflow + latest_run_status: + type: string + x-enum: + - ANOMALY_DETECTION_RUN_STATUS_CANCELED + - ANOMALY_DETECTION_RUN_STATUS_FAILED + - ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED + - ANOMALY_DETECTION_RUN_STATUS_PENDING + - ANOMALY_DETECTION_RUN_STATUS_RUNNING + - ANOMALY_DETECTION_RUN_STATUS_SUCCESS + - ANOMALY_DETECTION_RUN_STATUS_UNKNOWN + - ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR + description: The status of the last run of the workflow. + validity_check_configurations: + type: array + items: + type: object + properties: + name: + type: string + percent_null_validity_check: + type: object + properties: + column_names: + type: array + items: + type: string + upper_bound: + type: number + description: >- + Optional upper bound; we should use auto + determined bounds for now + range_validity_check: type: object properties: - name: - type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - description: Validity check configurations for anomaly detection. - required: - - object_type - - object_id + column_names: + type: array + items: + type: string + lower_bound: + type: number + description: Lower bound for the range + upper_bound: + type: number + description: Upper bound for the range + uniqueness_validity_check: + type: object + properties: + column_names: + type: array + items: + type: string + description: Validity check configurations for anomaly detection. required: - - quality_monitor + - object_type + - object_id responses: '200': description: Success @@ -582,328 +347,76 @@ paths: schema: type: object properties: - quality_monitor: + object_type: + type: string + object_id: + type: string + description: The uuid of the request object. For example, schema id. + anomaly_detection_config: type: object properties: - object_type: - type: string - object_id: - type: string - description: The uuid of the request object. For example, schema id. - anomaly_detection_config: - type: object - properties: - custom_check_configurations: - type: array - items: - type: object - properties: - scalar_check: - type: object - properties: - check_name: - type: string - column_matchers: - type: array - items: - type: object - properties: - column_names: - type: array - items: - type: string - variable_name: - type: string - description: >- - Variable name within a custom sql query - that this matcher applies to. - description: >- - Column matchers to determine which tables - to apply this check to - sql_query: - type: string - description: Templated SQL query for this check - thresholds: - type: object - properties: - lower_bound: - type: object - properties: - bound_value: - type: integer - threshold_type: - type: string - x-enum: - - THRESHOLD_TYPE_AUTO - - THRESHOLD_TYPE_MANUAL - - THRESHOLD_TYPE_UNBOUNDED - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and - know how many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , - ] - - - Methods can be added to enumerations, - and members can have their own - - attributes -- see the documentation for - details. - upper_bound: - type: object - properties: - bound_value: - type: integer - threshold_type: - type: string - x-enum: - - THRESHOLD_TYPE_AUTO - - THRESHOLD_TYPE_MANUAL - - THRESHOLD_TYPE_UNBOUNDED - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and - know how many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , - ] - - - Methods can be added to enumerations, - and members can have their own - - attributes -- see the documentation for - details. - description: Upper bound threshold - description: >- - Upper/lower thresholds for the output of - the query - excluded_table_full_names: - type: array - items: - type: string - description: >- - List of fully qualified table names to exclude from - anomaly detection. - job_type: - type: string - x-enum: - - >- - ANOMALY_DETECTION_JOB_TYPE_BACKGROUND_COMPUTE_WORKER - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: The type of the last run of the workflow. - last_run_id: - type: string - description: Run id of the last run of the workflow - latest_run_status: - type: string - x-enum: - - ANOMALY_DETECTION_RUN_STATUS_CANCELED - - ANOMALY_DETECTION_RUN_STATUS_FAILED - - ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED - - ANOMALY_DETECTION_RUN_STATUS_PENDING - - ANOMALY_DETECTION_RUN_STATUS_RUNNING - - ANOMALY_DETECTION_RUN_STATUS_SUCCESS - - ANOMALY_DETECTION_RUN_STATUS_UNKNOWN - - >- - ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR - description: The status of the last run of the workflow. - slicing_config: - type: object - properties: - slice_specs: - type: array - items: - type: object - properties: - column_group: - type: array - items: - type: object - properties: - name: - type: string - description: >- - The name of the column to slice on. The - top-K column values are auto-discovered. - required: - - name - description: >- - A column to slice completeness - monitoring on. - description: The columns to group by for slicing. - description: >- - A single slice dimension for per-slice - completeness monitoring. - description: The set of slice dimensions to monitor. - description: Per-schema completeness slicing configuration. - validity_check_configurations: - type: array - items: - type: object - properties: - name: - type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - validity_check_configurations: + excluded_table_full_names: type: array items: + type: string + last_run_id: + type: string + description: Run id of the last run of the workflow + latest_run_status: + type: string + x-enum: + - ANOMALY_DETECTION_RUN_STATUS_CANCELED + - ANOMALY_DETECTION_RUN_STATUS_FAILED + - ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED + - ANOMALY_DETECTION_RUN_STATUS_PENDING + - ANOMALY_DETECTION_RUN_STATUS_RUNNING + - ANOMALY_DETECTION_RUN_STATUS_SUCCESS + - ANOMALY_DETECTION_RUN_STATUS_UNKNOWN + - ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR + description: The status of the last run of the workflow. + validity_check_configurations: + type: array + items: + type: object + properties: + name: + type: string + percent_null_validity_check: + type: object + properties: + column_names: + type: array + items: + type: string + upper_bound: + type: number + description: >- + Optional upper bound; we should use auto + determined bounds for now + range_validity_check: type: object properties: - name: - type: string - percent_null_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - upper_bound: - type: number - description: >- - Optional upper bound; we should use auto - determined bounds for now - range_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - lower_bound: - type: number - description: Lower bound for the range - upper_bound: - type: number - description: Upper bound for the range - uniqueness_validity_check: - type: object - properties: - column_names: - type: array - items: - type: string - description: Validity check configurations for anomaly detection. - required: - - object_type - - object_id + column_names: + type: array + items: + type: string + lower_bound: + type: number + description: Lower bound for the range + upper_bound: + type: number + description: Upper bound for the range + uniqueness_validity_check: + type: object + properties: + column_names: + type: array + items: + type: string + description: Validity check configurations for anomaly detection. required: - - quality_monitor + - object_type + - object_id responses: '200': description: Success @@ -928,85 +441,16 @@ components: AnomalyDetectionConfig: type: object properties: - custom_check_configurations: - type: array - items: - $ref: '#/components/schemas/CustomCheckConfiguration' excluded_table_full_names: type: array items: type: string - description: >- - List of fully qualified table names to exclude from anomaly - detection. - job_type: - $ref: '#/components/schemas/AnomalyDetectionJobType' - description: The type of the last run of the workflow. last_run_id: type: string description: Run id of the last run of the workflow latest_run_status: $ref: '#/components/schemas/AnomalyDetectionRunStatus' description: The status of the last run of the workflow. - slicing_config: - $ref: '#/components/schemas/SlicingConfig' - description: Per-schema completeness slicing configuration. - validity_check_configurations: - type: array - items: - $ref: '#/components/schemas/ValidityCheckConfiguration' - ColumnMatcher: - type: object - properties: - column_names: - type: array - items: - type: string - variable_name: - type: string - description: >- - Variable name within a custom sql query that this matcher applies - to. - ColumnSpec: - type: object - properties: - name: - type: string - description: >- - The name of the column to slice on. The top-K column values are - auto-discovered. - required: - - name - description: A column to slice completeness monitoring on. - CustomCheckConfiguration: - type: object - properties: - scalar_check: - $ref: '#/components/schemas/CustomScalarCheck' - CustomCheckThresholds: - type: object - properties: - lower_bound: - $ref: '#/components/schemas/Threshold' - upper_bound: - $ref: '#/components/schemas/Threshold' - description: Upper bound threshold - CustomScalarCheck: - type: object - properties: - check_name: - type: string - column_matchers: - type: array - items: - $ref: '#/components/schemas/ColumnMatcher' - description: Column matchers to determine which tables to apply this check to - sql_query: - type: string - description: Templated SQL query for this check - thresholds: - $ref: '#/components/schemas/CustomCheckThresholds' - description: Upper/lower thresholds for the output of the query ListQualityMonitorResponse: type: object properties: @@ -1057,31 +501,6 @@ components: upper_bound: type: number description: Upper bound for the range - SliceSpec: - type: object - properties: - column_group: - type: array - items: - $ref: '#/components/schemas/ColumnSpec' - description: The columns to group by for slicing. - description: A single slice dimension for per-slice completeness monitoring. - SlicingConfig: - type: object - properties: - slice_specs: - type: array - items: - $ref: '#/components/schemas/SliceSpec' - description: The set of slice dimensions to monitor. - description: Per-schema completeness slicing configuration. - Threshold: - type: object - properties: - bound_value: - type: integer - threshold_type: - $ref: '#/components/schemas/ThresholdType' UniquenessValidityCheck: type: object properties: @@ -1100,49 +519,6 @@ components: $ref: '#/components/schemas/RangeValidityCheck' uniqueness_validity_check: $ref: '#/components/schemas/UniquenessValidityCheck' - AnomalyDetectionJobType: - type: string - x-enum: - - ANOMALY_DETECTION_JOB_TYPE_BACKGROUND_COMPUTE_WORKER - - ANOMALY_DETECTION_JOB_TYPE_INTERNAL_HIDDEN - - ANOMALY_DETECTION_JOB_TYPE_NORMAL - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. AnomalyDetectionRunStatus: type: string x-enum: @@ -1155,49 +531,6 @@ components: - ANOMALY_DETECTION_RUN_STATUS_UNKNOWN - ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR description: Status of Anomaly Detection Job Run - ThresholdType: - type: string - x-enum: - - THRESHOLD_TYPE_AUTO - - THRESHOLD_TYPE_MANUAL - - THRESHOLD_TYPE_UNBOUNDED - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. x-stackQL-resources: quality_monitor_v2: id: databricks_workspace.qualitymonitorv2.quality_monitor_v2 diff --git a/providers/src/databricks_workspace/v00.00.00000/services/sandbox.yaml b/providers/src/databricks_workspace/v00.00.00000/services/sandbox.yaml new file mode 100644 index 00000000..fa35c251 --- /dev/null +++ b/providers/src/databricks_workspace/v00.00.00000/services/sandbox.yaml @@ -0,0 +1,1414 @@ +openapi: 3.0.0 +info: + title: Databricks Sandbox API (workspace) + description: >- + OpenAPI specification for the Databricks sandbox service (workspace-level + APIs), generated from the Databricks Python SDK. + version: 0.1.0 + x-stackql-sdk-version: 0.123.0 + x-stackql-date-generated: '2026-11-01' + x-stackql-sdk-namespace: databricks.sdk.service.sandbox +servers: + - url: https://{deployment_name}.{workspace_domain} + variables: + deployment_name: + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. + default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com +paths: + /api/2.0/sandbox-files/sandboxes/{sandbox_id}/directories:make: + post: + operationId: sandbox_create_directory + summary: Creates a directory in a sandbox, including missing parents by default. + tags: + - sandbox + description: |- + Creates a directory in a sandbox, including missing parents by default. + + :param parent: str + :param path: str + Absolute UTF-8 path of the directory. + :param parents: bool (optional) + Defaults to true, which also succeeds when the directory already exists. + + :returns: :class:`CreateDirectoryResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). + requestBody: + content: + application/json: + schema: + type: object + properties: + path: + type: string + description: Absolute UTF-8 path of the directory. + parents: + type: boolean + description: >- + Defaults to true, which also succeeds when the directory + already exists. + required: + - path + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDirectoryResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandboxes: + post: + operationId: sandbox_create_sandbox + summary: Creates a new Sandbox. + tags: + - sandbox + description: |- + Creates a new Sandbox. + + :param sandbox: :class:`Sandbox` + The sandbox to create. + :param sandbox_id: str + Client-supplied ID that becomes the final path segment of the resource name. + + :returns: :class:`Sandbox` + parameters: + - name: sandbox_id + in: query + required: true + schema: + type: string + description: >- + Client-supplied ID that becomes the final path segment of the + resource name. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Output only. The creation time of the sandbox. + display_name: + type: string + description: >- + Human-readable display label for the sandbox. At most 256 + characters. + metadata: + type: object + properties: + custom_tags: + type: object + description: >- + Key-value tags associated with the sandbox. Supports up + to 54 tags. Keys must be between 1 and 512 characters, + and values must not exceed 256 characters. + description: Metadata associated with the sandbox. + name: + type: string + description: >- + The sandbox resource name, in the form + ``sandboxes/{sandbox_id}``. Derived from ``sandbox_id``; any + value supplied in a create or update request body is + ignored. + spec: + type: object + properties: + compute: + type: object + properties: + inactivity_timeout: + type: string + environment: + type: object + properties: + image_uri: + type: string + description: The execution environment to use for the sandbox. + description: >- + The desired configuration of the sandbox, supplied by the + caller at creation time. + status: + type: object + properties: + state: + type: string + x-enum: + - SANDBOX_STATE_PENDING + - SANDBOX_STATE_RUNNING + - SANDBOX_STATE_STOPPED + - SANDBOX_STATE_STOPPING + description: >- + Lifecycle state of a Sandbox resource. STOPPING is the + transient state while the sandbox is + + being stopped -- by a Stop request or inactivity + auto-termination -- and settles to STOPPED once + + the operation completes. + description: >- + The observed runtime state of the sandbox, populated by the + server. + update_time: + type: string + format: date-time + description: >- + Output only. The last update time of the sandbox metadata + and spec. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Sandbox' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + get: + operationId: sandbox_list_sandboxes + summary: Lists all Sandboxes. + tags: + - sandbox + description: |- + Lists all Sandboxes. + + :param page_size: int (optional) + :param page_token: str (optional) + + :returns: Iterator over :class:`Sandbox` + parameters: + - name: page_size + in: query + required: false + schema: + type: integer + - name: page_token + in: query + required: false + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListSandboxesResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-files/sandboxes/{sandbox_id}/paths:remove: + post: + operationId: sandbox_delete_path + summary: >- + Deletes a file, symlink, or empty directory, with an option for + recursive deletion. Succeeds if the + tags: + - sandbox + description: >- + Deletes a file, symlink, or empty directory, with an option for + recursive deletion. Succeeds if the + + path is already absent. + + + :param parent: str + + :param path: str + Absolute UTF-8 path of the entry to delete. + :param recursive: bool (optional) + Required for a non-empty directory. + + :returns: :class:`DeletePathResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). + requestBody: + content: + application/json: + schema: + type: object + properties: + path: + type: string + description: Absolute UTF-8 path of the entry to delete. + recursive: + type: boolean + description: Required for a non-empty directory. + required: + - path + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DeletePathResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandboxes/{sandbox_id}: + delete: + operationId: sandbox_delete_sandbox + summary: Deletes a Sandbox. + tags: + - sandbox + description: |- + Deletes a Sandbox. + + :param name: str + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + get: + operationId: sandbox_get_sandbox + summary: Retrieves a Sandbox by name. + tags: + - sandbox + description: |- + Retrieves a Sandbox by name. + + :param name: str + + :returns: :class:`Sandbox` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Sandbox' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + patch: + operationId: sandbox_update_sandbox + summary: >- + Updates mutable fields on an existing Sandbox. Allowlisted update_mask + paths today: display_name, + tags: + - sandbox + description: >- + Updates mutable fields on an existing Sandbox. Allowlisted update_mask + paths today: display_name, + + spec.compute.inactivity_timeout. Returns INVALID_PARAMETER_VALUE for + empty masks or unknown paths; + + NOT_FOUND if the sandbox does not exist. + + + :param name: str + Resource name of the sandbox to update, in the form ``sandboxes/{sandbox_id}``. + :param sandbox: :class:`Sandbox` + The Sandbox resource carrying new field values. Only fields named in ``update_mask`` are read; + unmasked fields are ignored. + :param update_mask: FieldMask + Field paths to update. Must be a non-empty subset of: + + - display_name + - spec.compute.inactivity_timeout Any other path returns INVALID_PARAMETER_VALUE. + + :returns: :class:`Sandbox` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). Resource name of the sandbox to update, + in the form ``sandboxes/{sandbox_id}``. + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Field paths to update. Must be a non-empty subset of: - display_name + - spec.compute.inactivity_timeout Any other path returns + INVALID_PARAMETER_VALUE. + requestBody: + content: + application/json: + schema: + type: object + properties: + create_time: + type: string + format: date-time + description: Output only. The creation time of the sandbox. + display_name: + type: string + description: >- + Human-readable display label for the sandbox. At most 256 + characters. + metadata: + type: object + properties: + custom_tags: + type: object + description: >- + Key-value tags associated with the sandbox. Supports up + to 54 tags. Keys must be between 1 and 512 characters, + and values must not exceed 256 characters. + description: Metadata associated with the sandbox. + name: + type: string + description: >- + The sandbox resource name, in the form + ``sandboxes/{sandbox_id}``. Derived from ``sandbox_id``; any + value supplied in a create or update request body is + ignored. + spec: + type: object + properties: + compute: + type: object + properties: + inactivity_timeout: + type: string + environment: + type: object + properties: + image_uri: + type: string + description: The execution environment to use for the sandbox. + description: >- + The desired configuration of the sandbox, supplied by the + caller at creation time. + status: + type: object + properties: + state: + type: string + x-enum: + - SANDBOX_STATE_PENDING + - SANDBOX_STATE_RUNNING + - SANDBOX_STATE_STOPPED + - SANDBOX_STATE_STOPPING + description: >- + Lifecycle state of a Sandbox resource. STOPPING is the + transient state while the sandbox is + + being stopped -- by a Stop request or inactivity + auto-termination -- and settles to STOPPED once + + the operation completes. + description: >- + The observed runtime state of the sandbox, populated by the + server. + update_time: + type: string + format: date-time + description: >- + Output only. The last update time of the sandbox metadata + and spec. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Sandbox' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-exec/sandboxes/{sandbox_id}/exec-sync: + post: + operationId: sandbox_execute_command_sync + summary: >- + Runs a command in the sandbox and blocks until it exits, returning the + captured stdout, stderr and + tags: + - sandbox + description: >- + Runs a command in the sandbox and blocks until it exits, returning the + captured stdout, stderr and + + exit code in a single response. + + + :param name: str + Resource name of the sandbox to run the command in, in the form ``sandboxes/{sandbox_id}``. Bound + from the URL path. + :param cmd: str + Executable or command to run (e.g. ``/bin/echo``, ``python3``). + :param args: List[str] (optional) + Arguments passed to ``cmd``. + :param envs: Dict[str,str] (optional) + Extra environment variables for the command's process, merged over the sandbox's default + environment. + :param execution_timeout: Duration (optional) + Maximum time to wait for the command to finish. When it elapses the command is terminated and the + response carries status ``TIMED_OUT``. The server applies a default when unset and clamps to an + upper bound; negative or otherwise invalid durations are rejected with ``INVALID_ARGUMENT``. + + :returns: :class:`ExecuteCommandSyncResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). Resource name of the sandbox to run the + command in, in the form ``sandboxes/{sandbox_id}``. Bound from the + URL path. + requestBody: + content: + application/json: + schema: + type: object + properties: + cmd: + type: string + description: >- + Executable or command to run (e.g. ``/bin/echo``, + ``python3``). + args: + type: array + items: + type: string + description: Arguments passed to ``cmd``. + envs: + type: object + description: >- + Extra environment variables for the command's process, + merged over the sandbox's default environment. + execution_timeout: + type: string + description: >- + Maximum time to wait for the command to finish. When it + elapses the command is terminated and the response carries + status ``TIMED_OUT``. The server applies a default when + unset and clamps to an upper bound; negative or otherwise + invalid durations are rejected with ``INVALID_ARGUMENT``. + required: + - cmd + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteCommandSyncResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-files/sandboxes/{sandbox_id}/paths:describe: + get: + operationId: sandbox_get_metadata + summary: Returns metadata for a path without following its final symlink. + tags: + - sandbox + description: |- + Returns metadata for a path without following its final symlink. + + :param parent: str + :param path: str + Absolute UTF-8 path of the entry to inspect. + + :returns: :class:`GetMetadataResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). + - name: path + in: query + required: true + schema: + type: string + description: Absolute UTF-8 path of the entry to inspect. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetMetadataResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-exec/sandboxes/{sandbox_id}/commands: + get: + operationId: sandbox_list_commands + summary: >- + Lists the tracked command executions (running and completed) in a + sandbox. + tags: + - sandbox + description: >- + Lists the tracked command executions (running and completed) in a + sandbox. + + + :param parent: str + The sandbox whose commands to list, in the form ``sandboxes/{sandbox_id}``. + :param page_size: int (optional) + Maximum number of commands to return. The server may return fewer. If unspecified, the server + returns all commands. + :param page_token: str (optional) + Page token returned by a previous ListCommands call. Use this to retrieve the next page of results. + + :returns: :class:`ListCommandsResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). The sandbox whose commands to list, in + the form ``sandboxes/{sandbox_id}``. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Maximum number of commands to return. The server may return fewer. + If unspecified, the server returns all commands. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + Page token returned by a previous ListCommands call. Use this to + retrieve the next page of results. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListCommandsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-files/sandboxes/{sandbox_id}/directory-entries: + get: + operationId: sandbox_list_directory_contents + summary: >- + Lists a directory's immediate children in UTF-8 name order. Later pages + may reflect concurrent + tags: + - sandbox + description: >- + Lists a directory's immediate children in UTF-8 name order. Later pages + may reflect concurrent + + changes. + + + :param parent: str + + :param path: str + Absolute UTF-8 path of the directory. + :param page_size: int (optional) + Zero uses the default of 1000; values above 1000 are clamped to 1000. + :param page_token: str (optional) + The token from a prior response. Keep parent and path unchanged between pages. + + :returns: Iterator over :class:`SandboxFileInfo` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). + - name: path + in: query + required: true + schema: + type: string + description: Absolute UTF-8 path of the directory. + - name: page_size + in: query + required: false + schema: + type: integer + description: >- + Zero uses the default of 1000; values above 1000 are clamped to + 1000. + - name: page_token + in: query + required: false + schema: + type: string + description: >- + The token from a prior response. Keep parent and path unchanged + between pages. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListDirectoryContentsResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandbox-files/sandboxes/{sandbox_id}/paths:rename: + post: + operationId: sandbox_rename_path + summary: >- + Renames a path within a sandbox. The destination must be absent and on + the same filesystem. + tags: + - sandbox + description: >- + Renames a path within a sandbox. The destination must be absent and on + the same filesystem. + + + :param parent: str + Sandbox resource name, for example ``sandboxes/my-sandbox``. + :param source: str + Absolute UTF-8 path to move. + :param destination: str + Exact absolute UTF-8 destination; it must not already exist. + + :returns: :class:`RenamePathResponse` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `parent` resource name + (`sandboxes/{sandbox_id}`). Sandbox resource name, for example + ``sandboxes/my-sandbox``. + requestBody: + content: + application/json: + schema: + type: object + properties: + source: + type: string + description: Absolute UTF-8 path to move. + destination: + type: string + description: Exact absolute UTF-8 destination; it must not already exist. + required: + - source + - destination + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/RenamePathResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandboxes/{sandbox_id}/start: + post: + operationId: sandbox_start_sandbox + summary: >- + Starts a previously stopped Sandbox under the same sandbox name. Returns + NOT_FOUND if there is no + tags: + - sandbox + description: >- + Starts a previously stopped Sandbox under the same sandbox name. Returns + NOT_FOUND if there is no + + stopped sandbox to start for the given name. + + + :param name: str + Resource name of the sandbox to start, in the form ``sandboxes/{sandbox_id}``. + + :returns: :class:`Sandbox` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). Resource name of the sandbox to start, + in the form ``sandboxes/{sandbox_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Sandbox' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI + /api/2.0/sandboxes/{sandbox_id}/stop: + post: + operationId: sandbox_stop_sandbox + summary: >- + Stops a running Sandbox, preserving it so it can later be restarted with + a Start request. + tags: + - sandbox + description: >- + Stops a running Sandbox, preserving it so it can later be restarted with + a Start request. + + + :param name: str + Resource name of the sandbox to stop, in the form ``sandboxes/{sandbox_id}``. + + :returns: :class:`Sandbox` + parameters: + - name: sandbox_id + in: path + required: true + schema: + type: string + description: >- + The `sandbox_id` segment of the `name` resource name + (`sandboxes/{sandbox_id}`). Resource name of the sandbox to stop, in + the form ``sandboxes/{sandbox_id}``. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Sandbox' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SandboxAPI +components: + schemas: + Command: + type: object + properties: + args: + type: array + items: + type: string + description: Arguments passed to the program. + cmd: + type: string + description: The program that was executed. + command_id: + type: string + description: Stable identifier for this command. + exit_code: + type: integer + description: >- + Process exit code. Only present when finished is true and the + process exited normally (not killed by signal or failed to start). + finished: + type: boolean + description: Whether the command has finished executing. + pid: + type: integer + description: PID of the spawned process. Absent if the process failed to start. + description: A single command execution. + ComputeSpec: + type: object + properties: + inactivity_timeout: + type: string + CreateDirectoryResponse: + type: object + properties: {} + description: Confirms that the requested directory exists. + DeletePathResponse: + type: object + properties: {} + description: Confirms that the requested path is absent. + EnvironmentSpec: + type: object + properties: + image_uri: + type: string + ExecuteCommandSyncResponse: + type: object + properties: + command_id: + type: string + description: >- + Daemon-generated identifier for this command execution, for + correlation (for example in ``ListCommands``). + exit_code: + type: integer + description: >- + Process exit code. Unset when the process was terminated by a signal + (e.g. on ``TIMED_OUT``) or never started (``FAILED``) rather than + exiting normally. + status: + $ref: '#/components/schemas/ExecuteCommandStatus' + description: >- + Terminal status of the command execution. Always set on a successful + response; never ``EXECUTE_COMMAND_STATUS_UNSPECIFIED``. + stderr: + type: string + description: >- + Captured standard error, with the same UTF-8 semantics as + ``stdout``. + stdout: + type: string + description: >- + Captured standard output as UTF-8 text. Invalid UTF-8 bytes are + replaced with the Unicode replacement character (U+FFFD). + truncated: + type: boolean + description: >- + True when ``stdout`` / ``stderr`` were truncated because the + captured output exceeded the server's per-response size cap. The + dropped output is not included in this response and is not + recoverable through this unary API. + description: >- + Result of a completed unary command execution: captured output, exit + code, and terminal status. + GetMetadataResponse: + type: object + properties: + file: + $ref: '#/components/schemas/SandboxFileInfo' + description: >- + Contains metadata for the requested path without following its final + symlink. + ListCommandsResponse: + type: object + properties: + commands: + type: array + items: + $ref: '#/components/schemas/Command' + description: Commands in this page of results. + next_page_token: + type: string + description: >- + Token to retrieve the next page. Empty when there are no more + results. + description: Response listing tracked command executions. + ListDirectoryContentsResponse: + type: object + properties: + contents: + type: array + items: + $ref: '#/components/schemas/SandboxFileInfo' + next_page_token: + type: string + description: >- + Contains a page of immediate directory entries and an optional + continuation token. An empty + token marks the final page. Pages reflect concurrent directory changes. + ListSandboxesResponse: + type: object + properties: + next_page_token: + type: string + sandboxes: + type: array + items: + $ref: '#/components/schemas/Sandbox' + description: A list of Sandboxes. + RenamePathResponse: + type: object + properties: {} + description: Confirms that the sandbox path was renamed. + Sandbox: + type: object + properties: + create_time: + type: string + format: date-time + description: Output only. The creation time of the sandbox. + display_name: + type: string + description: >- + Human-readable display label for the sandbox. At most 256 + characters. + metadata: + $ref: '#/components/schemas/SandboxMetadata' + description: Metadata associated with the sandbox. + name: + type: string + description: >- + The sandbox resource name, in the form ``sandboxes/{sandbox_id}``. + Derived from ``sandbox_id``; any value supplied in a create or + update request body is ignored. + spec: + $ref: '#/components/schemas/SandboxSpec' + description: >- + The desired configuration of the sandbox, supplied by the caller at + creation time. + status: + $ref: '#/components/schemas/SandboxStatus' + description: The observed runtime state of the sandbox, populated by the server. + update_time: + type: string + format: date-time + description: Output only. The last update time of the sandbox metadata and spec. + description: A Sandbox resource representing an execution environment. + SandboxFileInfo: + type: object + properties: + file_type: + $ref: '#/components/schemas/SandboxFileType' + group: + type: string + mode: + type: integer + modify_time: + type: string + format: date-time + description: Nanosecond precision is preserved on the wire. + name: + type: string + owner: + type: string + path: + type: string + permissions: + type: string + size: + type: integer + symlink_target: + type: string + description: >- + Metadata for a sandbox filesystem entry, describing a final symlink + itself. + SandboxMetadata: + type: object + properties: + custom_tags: + type: object + description: >- + Key-value tags associated with the sandbox. Supports up to 54 tags. + Keys must be between 1 and 512 characters, and values must not + exceed 256 characters. + description: Metadata associated with a sandbox. + SandboxSpec: + type: object + properties: + compute: + $ref: '#/components/schemas/ComputeSpec' + environment: + $ref: '#/components/schemas/EnvironmentSpec' + description: The execution environment to use for the sandbox. + SandboxStatus: + type: object + properties: + state: + $ref: '#/components/schemas/SandboxState' + ExecuteCommandStatus: + type: string + x-enum: + - EXECUTE_COMMAND_STATUS_COMPLETED + - EXECUTE_COMMAND_STATUS_FAILED + - EXECUTE_COMMAND_STATUS_TIMED_OUT + description: Terminal status of a unary command execution. + SandboxFileType: + type: string + x-enum: + - SANDBOX_FILE_TYPE_DIRECTORY + - SANDBOX_FILE_TYPE_FILE + - SANDBOX_FILE_TYPE_OTHER + - SANDBOX_FILE_TYPE_SYMLINK + description: Type of a sandbox filesystem entry without following its final symlink. + SandboxState: + type: string + x-enum: + - SANDBOX_STATE_PENDING + - SANDBOX_STATE_RUNNING + - SANDBOX_STATE_STOPPED + - SANDBOX_STATE_STOPPING + description: >- + Lifecycle state of a Sandbox resource. STOPPING is the transient state + while the sandbox is + + being stopped -- by a Stop request or inactivity auto-termination -- and + settles to STOPPED once + + the operation completes. + x-stackQL-resources: + sandbox_directories: + id: databricks_workspace.sandbox.sandbox_directories + name: sandbox_directories + title: Sandbox Directories + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-files~1sandboxes~1{sandbox_id}~1directories:make/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/sandbox_directories/methods/create + update: [] + delete: [] + replace: [] + sandboxes: + id: databricks_workspace.sandbox.sandboxes + name: sandboxes + title: Sandboxes + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1sandboxes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1api~12.0~1sandboxes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sandboxes + delete: + operation: + $ref: '#/paths/~1api~12.0~1sandboxes~1{sandbox_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.0~1sandboxes~1{sandbox_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1sandboxes~1{sandbox_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: '#/paths/~1api~12.0~1sandboxes~1{sandbox_id}~1start/post' + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: '#/paths/~1api~12.0~1sandboxes~1{sandbox_id}~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sandboxes/methods/get' + - $ref: '#/components/x-stackQL-resources/sandboxes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/sandboxes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/sandboxes/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/sandboxes/methods/delete' + replace: [] + sandbox_paths: + id: databricks_workspace.sandbox.sandbox_paths + name: sandbox_paths + title: Sandbox Paths + methods: + delete: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-files~1sandboxes~1{sandbox_id}~1paths:remove/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-files~1sandboxes~1{sandbox_id}~1paths:describe/get + response: + mediaType: application/json + openAPIDocKey: '200' + rename: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-files~1sandboxes~1{sandbox_id}~1paths:rename/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sandbox_paths/methods/get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/sandbox_paths/methods/delete' + replace: [] + sandbox_commands: + id: databricks_workspace.sandbox.sandbox_commands + name: sandbox_commands + title: Sandbox Commands + methods: + execute: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-exec~1sandboxes~1{sandbox_id}~1exec-sync/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-exec~1sandboxes~1{sandbox_id}~1commands/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.commands + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sandbox_commands/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + sandbox_directory_entries: + id: databricks_workspace.sandbox.sandbox_directory_entries + name: sandbox_directory_entries + title: Sandbox Directory Entries + methods: + list: + operation: + $ref: >- + #/paths/~1api~12.0~1sandbox-files~1sandboxes~1{sandbox_id}~1directory-entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contents + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sandbox_directory_entries/methods/list + insert: [] + update: [] + delete: [] + replace: [] +x-stackQL-config: + pagination: + requestToken: + key: page_token + location: query + responseToken: + key: next_page_token + location: body diff --git a/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml b/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml index e3143b18..5cc43a2b 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml @@ -5,14 +5,28 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.serving servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/build-logs: get: @@ -75,10 +89,8 @@ paths: :param route_optimized: bool (optional)\n Enable route optimization for the serving endpoint.\n:param tags: List[:class:`EndpointTag`]\ \ (optional)\n Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n:param\ \ telemetry_config: :class:`TelemetryConfig` (optional)\n Configuration for persisting endpoint telemetry (logs,\ - \ traces, and metrics) to Unity Catalog tables.\n:param uc_system_metrics_export_state: :class:`FirstPartyExportSetting`\ - \ (optional)\n Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics Unity\n \ - \ Catalog table. Endpoint-level property (not part of the per-version config).\n\n:returns:\n Long-running operation\ - \ waiter for :class:`ServingEndpointDetailed`.\n See :method:wait_get_serving_endpoint_not_updating for more details." + \ traces, and metrics) to Unity Catalog tables.\n\n:returns:\n Long-running operation waiter for :class:`ServingEndpointDetailed`.\n\ + \ See :method:wait_get_serving_endpoint_not_updating for more details." requestBody: content: application/json: @@ -338,7 +350,6 @@ paths: - amazon - anthropic - cohere - - grok description: 'The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.' aws_access_key_id: @@ -373,6 +384,8 @@ paths: ``aws_secret_access_key`` and ``aws_secret_access_key_plaintext``. uc_service_credential_name: type: string + description: The name of the Unity Catalog service credential that the external model + uses to access AWS resources. required: - aws_region - bedrock_provider @@ -787,6 +800,19 @@ paths: telemetry_config: type: object properties: + enabled_telemetry_features: + type: array + items: + type: string + x-enum: + - TELEMETRY_FEATURE_INFERENCE_TABLE + - TELEMETRY_FEATURE_LOGS + - TELEMETRY_FEATURE_METRICS + - TELEMETRY_FEATURE_TRACES + description: 'A telemetry signal that a serving endpoint can export to Unity Catalog. Use these values + to + + select which signals the endpoint exports.' inference_table_config: type: object properties: @@ -797,7 +823,7 @@ paths: type: number description: Fraction of requests sampled for payload logging, in the range [0.0, 1.0], where 1.0 logs all requests. - description: Inference table payload logging configuration + description: Configuration for inference table payload logging, including sampling. table_names: type: object properties: @@ -823,13 +849,6 @@ paths: a telemetry profile that has already been created, instead of specifying table_names. description: Configuration for persisting endpoint telemetry (logs, traces, and metrics) to Unity Catalog tables. - uc_system_metrics_export_state: - type: string - x-enum: - - FIRST_PARTY_EXPORT_DISABLED - - FIRST_PARTY_EXPORT_ENABLED - description: Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics Unity - Catalog table. Endpoint-level property (not part of the per-version config). required: - name responses: @@ -893,12 +912,10 @@ paths: \ dashes, and underscores.\n:param config: :class:`PtEndpointCoreConfig`\n The core config of the serving endpoint.\n\ :param ai_gateway: :class:`AiGatewayConfig` (optional)\n The AI Gateway configuration for the serving endpoint.\n\ :param budget_policy_id: str (optional)\n The budget policy associated with the endpoint.\n:param email_notifications:\ - \ :class:`EmailNotifications` (optional)\n Email notification settings.\n:param relocate_pt_commitment: :class:`PtCommitmentRelocation`\ - \ (optional)\n Relocate (\"upgrade\") an existing reserved commitment into this newly created endpoint, whose served\n\ - \ model must be a same-line upgrade of the commitment's current model.\n:param tags: List[:class:`EndpointTag`] (optional)\n\ - \ Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n\n:returns:\n Long-running\ - \ operation waiter for :class:`ServingEndpointDetailed`.\n See :method:wait_get_serving_endpoint_not_updating for\ - \ more details." + \ :class:`EmailNotifications` (optional)\n Email notification settings.\n:param tags: List[:class:`EndpointTag`]\ + \ (optional)\n Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n\n:returns:\n\ + \ Long-running operation waiter for :class:`ServingEndpointDetailed`.\n See :method:wait_get_serving_endpoint_not_updating\ + \ for more details." requestBody: content: application/json: @@ -921,7 +938,8 @@ paths: type: string provisioned_model_units: type: integer - description: The number of model units to be provisioned. + description: The number of model units to be provisioned. Dedicated inference requires positive + fixed capacity and does not support scale-to-zero. burst_scaling_enabled: type: boolean description: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically @@ -935,17 +953,6 @@ paths: name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version. - pt_auto_renew: - type: boolean - description: Whether the Provisioned Throughput commitment should automatically renew at the end - of its term. Only applies when pt_term is set. - pt_term: - type: string - x-enum: - - COMMITMENT_TERM_1_MONTH - - COMMITMENT_TERM_3_MONTHS - description: Commitment term to purchase for this served entity; its presence marks the entity - as reserved (vs on-demand) PT. Valid on create and on update (purchases a commitment for a scale-up). required: - entity_name - provisioned_model_units @@ -1132,22 +1139,6 @@ paths: description: A list of email addresses to be notified when an endpoint successfully updates its configuration or state. description: Email notification settings. - relocate_pt_commitment: - type: object - properties: - source_endpoint: - type: string - description: The endpoint that currently owns the commitments (the relocation source). - commitment_ids: - type: array - items: - type: string - description: The IDs of the commitments to relocate. All move from the same source endpoint to the same - target in one transaction (all-or-nothing), so a multi-commitment upgrade is atomic. - required: - - source_endpoint - description: Relocate ("upgrade") an existing reserved commitment into this newly created endpoint, whose - served model must be a same-line upgrade of the commitment's current model. tags: type: array items: @@ -1531,19 +1522,12 @@ paths: description: "Make external services call using the credentials stored in UC Connection.\n\n:param connection_name:\ \ str\n The connection name to use. This is required to identify the external connection.\n:param method: :class:`ExternalFunctionRequestHttpMethod`\n\ \ The HTTP method to use (e.g., 'GET', 'POST').\n:param path: str\n The relative path for the API endpoint. This\ - \ is required.\n:param body: str (optional)\n Raw binary request body. When set, this is forwarded as the HTTP body\ - \ to the upstream connection\n without any encoding. Use this for non-text payloads (image uploads, multipart bodies)\ - \ that cannot\n be carried in the UTF-8 string ``json`` field. Mutually exclusive with ``json`` — if both are set,\n\ - \ the request is rejected. The caller is responsible for setting an appropriate ``Content-Type``\n header.\n\n \ - \ Size is bounded by the same limit as the rest of the request payload —\n ``maxRequestPayloadSizeExternalFunctions``\ - \ (default 4 MiB, configurable). Note that proto-over-JSON\n encodes ``bytes`` as base64, so the on-wire representation\ - \ is ~33% larger than the raw bytes; budget\n accordingly.\n:param headers: str (optional)\n Additional headers\ - \ for the request. If not provided, only auth headers from connections would be\n passed.\n:param json: str (optional)\n\ - \ The JSON payload to send in the request body.\n:param params: str (optional)\n Query parameters for the request.\n\ - :param sub_domain: str (optional)\n Optional subdomain to prepend to the connection URL's host. If provided, this\ - \ will be added as a\n prefix to the connection URL's host. For example, if the connection URL is\n ``https://api.example.com/v1``\ - \ and ``sub_domain`` is ``\"custom\"``, the resulting URL will be\n ``https://custom.api.example.com/v1``.\n\n:returns:\ - \ :class:`HttpRequestResponse`" + \ is required.\n:param headers: str (optional)\n Additional headers for the request. If not provided, only auth headers\ + \ from connections would be\n passed.\n:param json: str (optional)\n The JSON payload to send in the request body.\n\ + :param params: str (optional)\n Query parameters for the request.\n:param sub_domain: str (optional)\n Optional\ + \ subdomain to prepend to the connection URL's host. If provided, this will be added as a\n prefix to the connection\ + \ URL's host. For example, if the connection URL is\n ``https://api.example.com/v1`` and ``sub_domain`` is ``\"custom\"\ + ``, the resulting URL will be\n ``https://custom.api.example.com/v1``.\n\n:returns: :class:`HttpRequestResponse`" requestBody: content: application/json: @@ -1565,15 +1549,6 @@ paths: path: type: string description: The relative path for the API endpoint. This is required. - body: - type: string - description: Raw binary request body. When set, this is forwarded as the HTTP body to the upstream connection - without any encoding. Use this for non-text payloads (image uploads, multipart bodies) that cannot be - carried in the UTF-8 string ``json`` field. Mutually exclusive with ``json`` — if both are set, the request - is rejected. The caller is responsible for setting an appropriate ``Content-Type`` header. Size is bounded - by the same limit as the rest of the request payload — ``maxRequestPayloadSizeExternalFunctions`` (default - 4 MiB, configurable). Note that proto-over-JSON encodes ``bytes`` as base64, so the on-wire representation - is ~33% larger than the raw bytes; budget accordingly. json: type: string description: The JSON payload to send in the request body. @@ -1714,57 +1689,6 @@ paths: message: type: string x-stackql-sdk-source: ServingEndpointsAPI - /api/2.0/serving-endpoints/{name}/system-metrics-export-state: - patch: - operationId: serving_endpoints_patch_system_metrics_export_state - summary: Updates the system-metrics-export state of a serving endpoint, independently of the endpoint config - tags: - - serving - - serving_endpoints - description: "Updates the system-metrics-export state of a serving endpoint, independently of the endpoint config\n\ - (does not trigger a config-version change or redeployment).\n\n:param name: str\n The name of the serving endpoint\ - \ whose system-metrics-export state is being updated. This field is\n required.\n:param uc_system_metrics_export_state:\ - \ :class:`FirstPartyExportSetting` (optional)\n Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics\ - \ Unity\n Catalog table. Endpoint-level property (not part of the per-version config).\n\n:returns: :class:`ServingEndpointDetailed`" - parameters: - - name: name - in: path - required: true - schema: - type: string - description: The name of the serving endpoint whose system-metrics-export state is being updated. This field is required. - requestBody: - content: - application/json: - schema: - type: object - properties: - uc_system_metrics_export_state: - type: string - x-enum: - - FIRST_PARTY_EXPORT_DISABLED - - FIRST_PARTY_EXPORT_ENABLED - description: Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics Unity - Catalog table. Endpoint-level property (not part of the per-version config). - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ServingEndpointDetailed' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: ServingEndpointsAPI /api/2.0/serving-endpoints/{name}/telemetry-config: patch: operationId: serving_endpoints_patch_telemetry_config @@ -1793,6 +1717,19 @@ paths: telemetry_config: type: object properties: + enabled_telemetry_features: + type: array + items: + type: string + x-enum: + - TELEMETRY_FEATURE_INFERENCE_TABLE + - TELEMETRY_FEATURE_LOGS + - TELEMETRY_FEATURE_METRICS + - TELEMETRY_FEATURE_TRACES + description: 'A telemetry signal that a serving endpoint can export to Unity Catalog. Use these values + to + + select which signals the endpoint exports.' inference_table_config: type: object properties: @@ -1803,7 +1740,7 @@ paths: type: number description: Fraction of requests sampled for payload logging, in the range [0.0, 1.0], where 1.0 logs all requests. - description: Inference table payload logging configuration + description: Configuration for inference table payload logging, including sampling. table_names: type: object properties: @@ -2391,7 +2328,6 @@ paths: - amazon - anthropic - cohere - - grok description: 'The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.' aws_access_key_id: @@ -2426,6 +2362,8 @@ paths: and ``aws_secret_access_key_plaintext``. uc_service_credential_name: type: string + description: The name of the Unity Catalog service credential that the external model uses + to access AWS resources. required: - aws_region - bedrock_provider @@ -2862,10 +2800,6 @@ paths: description: "Updates any combination of the pt endpoint's served entities, the compute configuration of those\nserved\ \ entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be\nupdated instantly\n\ \n:param name: str\n The name of the pt endpoint to update. This field is required.\n:param config: :class:`PtEndpointCoreConfig`\n\ - :param pt_commitment_auto_renew: :class:`PtCommitmentAutoRenew` (optional)\n When set, updates the referenced commitment's\ - \ auto-renew flag as part of this config update.\n:param relocate_pt_commitment: :class:`PtCommitmentRelocation` (optional)\n\ - \ Relocate (\"upgrade\") an existing commitment onto this endpoint, whose served model must be a\n same-line upgrade\ - \ of the commitment's current model. Mutually exclusive with a pt_term scale-up and\n with pt_commitment_auto_renew.\n\ \n:returns:\n Long-running operation waiter for :class:`ServingEndpointDetailed`.\n See :method:wait_get_serving_endpoint_not_updating\ \ for more details." parameters: @@ -2893,7 +2827,8 @@ paths: type: string provisioned_model_units: type: integer - description: The number of model units to be provisioned. + description: The number of model units to be provisioned. Dedicated inference requires positive + fixed capacity and does not support scale-to-zero. burst_scaling_enabled: type: boolean description: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically @@ -2907,17 +2842,6 @@ paths: name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version. - pt_auto_renew: - type: boolean - description: Whether the Provisioned Throughput commitment should automatically renew at the end - of its term. Only applies when pt_term is set. - pt_term: - type: string - x-enum: - - COMMITMENT_TERM_1_MONTH - - COMMITMENT_TERM_3_MONTHS - description: Commitment term to purchase for this served entity; its presence marks the entity - as reserved (vs on-demand) PT. Valid on create and on update (purchases a commitment for a scale-up). required: - entity_name - provisioned_model_units @@ -2938,36 +2862,6 @@ paths: description: The name of the served model this route configures traffic for. required: - traffic_percentage - pt_commitment_auto_renew: - type: object - properties: - commitment_id: - type: string - description: The ID of the commitment to update. - auto_renew: - type: boolean - description: The desired auto-renew setting for the commitment. - required: - - commitment_id - - auto_renew - description: When set, updates the referenced commitment's auto-renew flag as part of this config update. - relocate_pt_commitment: - type: object - properties: - source_endpoint: - type: string - description: The endpoint that currently owns the commitments (the relocation source). - commitment_ids: - type: array - items: - type: string - description: The IDs of the commitments to relocate. All move from the same source endpoint to the same - target in one transaction (all-or-nothing), so a multi-commitment upgrade is atomic. - required: - - source_endpoint - description: Relocate ("upgrade") an existing commitment onto this endpoint, whose served model must be - a same-line upgrade of the commitment's current model. Mutually exclusive with a pt_term scale-up and - with pt_commitment_auto_renew. required: - config responses: @@ -3132,6 +3026,7 @@ components: ``aws_access_key_id_plaintext``, ``aws_secret_access_key`` and ``aws_secret_access_key_plaintext``. uc_service_credential_name: type: string + description: The name of the Unity Catalog service credential that the external model uses to access AWS resources. required: - aws_region - bedrock_provider @@ -3422,9 +3317,6 @@ components: properties: config_update: $ref: '#/components/schemas/EndpointStateConfigUpdate' - pt_state: - $ref: '#/components/schemas/PtState' - description: The Provisioned Throughput state of the endpoint, including its capacity commitments. ready: $ref: '#/components/schemas/EndpointStateReady' description: The state of an endpoint, indicating whether or not the endpoint is queryable. An endpoint is READY @@ -3653,68 +3545,6 @@ components: type: string status_message: type: string - PtCommitment: - type: object - properties: - auto_renew: - type: boolean - description: Whether the commitment automatically renews at the end of its term. - auto_renew_editable: - type: boolean - description: 'Whether auto_renew can still be toggled. Derived at read time, gated on the lockout window: true while - more than the auto-renew lockout window remains before expiry. The server enforces the same rule on write.' - expire_time: - type: string - format: date-time - description: The commitment's expiry (start_time + the term, in UTC calendar months/years). Stored on the commitment - and returned verbatim, so clients, the billing meter, and the purge agree on the exact instant. - id: - type: string - description: System-generated ID of the commitment. - provisioned_model_units: - type: integer - description: The number of model units reserved by this commitment. - start_time: - type: string - format: date-time - description: The time at which the commitment becomes active. - status: - $ref: '#/components/schemas/CommitmentStatus' - description: The lifecycle status of the commitment. - term: - $ref: '#/components/schemas/CommitmentTerm' - description: The commitment term length. - description: A single Provisioned Throughput capacity commitment for an endpoint. - PtCommitmentAutoRenew: - type: object - properties: - commitment_id: - type: string - description: The ID of the commitment to update. - auto_renew: - type: boolean - description: The desired auto-renew setting for the commitment. - required: - - commitment_id - - auto_renew - description: Changes the auto-renew setting of a single PT commitment. - PtCommitmentRelocation: - type: object - properties: - source_endpoint: - type: string - description: The endpoint that currently owns the commitments (the relocation source). - commitment_ids: - type: array - items: - type: string - description: The IDs of the commitments to relocate. All move from the same source endpoint to the same target in - one transaction (all-or-nothing), so a multi-commitment upgrade is atomic. - required: - - source_endpoint - description: "A request to relocate (\"upgrade\") an existing Provisioned Throughput commitment onto a\n different,\ - \ same-line endpoint. The commitment row moves intact (same commitment_id) from the\n source endpoint to the target\ - \ in a single transaction." PtEndpointCoreConfig: type: object properties: @@ -3731,7 +3561,8 @@ components: type: string provisioned_model_units: type: integer - description: The number of model units to be provisioned. + description: The number of model units to be provisioned. Dedicated inference requires positive fixed capacity and + does not support scale-to-zero. burst_scaling_enabled: type: boolean description: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically scale up beyond @@ -3744,26 +3575,9 @@ components: of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version. - pt_auto_renew: - type: boolean - description: Whether the Provisioned Throughput commitment should automatically renew at the end of its term. Only - applies when pt_term is set. - pt_term: - $ref: '#/components/schemas/CommitmentTerm' - description: Commitment term to purchase for this served entity; its presence marks the entity as reserved (vs on-demand) - PT. Valid on create and on update (purchases a commitment for a scale-up). required: - entity_name - provisioned_model_units - PtState: - type: object - properties: - commitments: - type: array - items: - $ref: '#/components/schemas/PtCommitment' - description: The list of capacity commitments backing the endpoint. - description: The Provisioned Throughput state for an endpoint, including all of its capacity commitments. PutAiGatewayResponse: type: object properties: @@ -4202,10 +4016,6 @@ components: telemetry_config: $ref: '#/components/schemas/TelemetryConfig' description: Telemetry configuration for the endpoint, including inference-table payload logging. - uc_system_metrics_export_state: - $ref: '#/components/schemas/FirstPartyExportSetting' - description: Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics Unity Catalog - table. Endpoint-level property (not part of the per-version config). usage_policy_id: type: string description: The usage policy associated with serving endpoint. @@ -4302,10 +4112,6 @@ components: telemetry_config: $ref: '#/components/schemas/TelemetryConfig' description: Telemetry configuration for the endpoint, including inference-table payload logging. - uc_system_metrics_export_state: - $ref: '#/components/schemas/FirstPartyExportSetting' - description: Whether this endpoint's system metrics are exported to the system.telemetry.otel_metrics Unity Catalog - table. Endpoint-level property (not part of the per-version config). ServingEndpointPermission: type: object properties: @@ -4338,8 +4144,13 @@ components: TelemetryConfig: type: object properties: + enabled_telemetry_features: + type: array + items: + $ref: '#/components/schemas/TelemetryFeature' inference_table_config: $ref: '#/components/schemas/TelemetryInferenceTableConfig' + description: Configuration for inference table payload logging, including sampling. table_names: $ref: '#/components/schemas/UnityCatalogTableNames' description: The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported. Provide @@ -4448,7 +4259,6 @@ components: - amazon - anthropic - cohere - - grok description: "Create a collection of name/value pairs.\n\nExample enumeration:\n\n>>> class Color(Enum):\n... RED\ \ = 1\n... BLUE = 2\n... GREEN = 3\n\nAccess them by:\n\n- attribute access:\n\n >>> Color.RED\n \n\n- value lookup:\n\n >>> Color(1)\n \n\n- name lookup:\n\n >>> Color['RED']\n \n\nEnumerations can be iterated over, and know how many members they have:\n\n>>> len(Color)\n3\n\n>>> list(Color)\n\ [, , ]\n\nMethods can be added to enumerations, and members can have\ \ their own\nattributes -- see the documentation for details." - FirstPartyExportSetting: - type: string - x-enum: - - FIRST_PARTY_EXPORT_DISABLED - - FIRST_PARTY_EXPORT_ENABLED - description: 'Whether first-party system-metrics export (to system.telemetry.otel_metrics) is enabled for an - - endpoint. Scoped to first-party only for now; third-party (e.g. Datadog) export is deferred.' QueryEndpointResponseObject: type: string x-enum: @@ -4632,6 +4422,16 @@ components: - GPU_XLARGE_8 - MULTIGPU_MEDIUM description: Please keep this in sync with workload types in InferenceEndpointEntities.scala. + TelemetryFeature: + type: string + x-enum: + - TELEMETRY_FEATURE_INFERENCE_TABLE + - TELEMETRY_FEATURE_LOGS + - TELEMETRY_FEATURE_METRICS + - TELEMETRY_FEATURE_TRACES + description: 'A telemetry signal that a serving endpoint can export to Unity Catalog. Use these values to + + select which signals the endpoint exports.' x-stackQL-resources: serving_endpoint_build_logs: id: databricks_workspace.serving.serving_endpoint_build_logs @@ -4693,15 +4493,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch_system_metrics_export_state: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1serving-endpoints~1{name}~1system-metrics-export-state/patch' - response: - mediaType: application/json - openAPIDocKey: '200' patch_telemetry_config: config: requestBodyTranslate: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml b/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml index 13a398cc..c3cb5c24 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml @@ -5,14 +5,28 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.settings servers: -- url: https://{deployment_name}.cloud.databricks.com +- url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: 'The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, + adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the + session.' default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; + default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default: delete: @@ -788,7 +802,6 @@ paths: items: type: string x-enum: - - ARC_AMPE - CANADA_PROTECTED_B - CYBER_ESSENTIAL_PLUS - FEDRAMP_HIGH @@ -1045,7 +1058,6 @@ paths: items: type: string x-enum: - - ARC_AMPE - CANADA_PROTECTED_B - CYBER_ESSENTIAL_PLUS - FEDRAMP_HIGH @@ -3899,51 +3911,61 @@ paths: config: type: object properties: - email: + databricks_app_slack: type: object properties: - addresses: - type: array - items: - type: string - generic_webhook: + channel_id: + type: string + description: '[Input-Only] Slack channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Slack workspace (team) ID the Databricks app is installed in.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + description: |- + Slack channel reached through the Databricks app. The app must already be installed in the Slack + workspace and connected to this Databricks workspace. + databricks_app_teams: type: object properties: - oauth_audience: + channel_id: type: string - oauth_audience_set: + description: '[Input-Only] Teams channel ID notifications are posted to.' + channel_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 audience is set.' - oauth_client_id: + description: '[Output-Only] Whether channel ID is set.' + team_id: type: string - description: '[Input-Only][Optional] OAuth2 client ID for the client_credentials grant.' - oauth_client_id_set: + description: '[Input-Only] Microsoft Entra group ID of the team that owns the channel.' + team_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 client ID is set.' - oauth_client_secret: + description: '[Output-Only] Whether team ID is set.' + tenant_id: type: string - description: '[Input-Only][Optional] OAuth2 client secret for the client_credentials grant.' - oauth_client_secret_set: + description: '[Input-Only] Microsoft Entra tenant ID of the Microsoft 365 tenant the app is installed + in.' + tenant_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 client secret is set.' - oauth_scopes: + description: '[Output-Only] Whether tenant ID is set.' + description: |- + Microsoft Teams channel reached through the Databricks app. The app must already be installed in + the Microsoft 365 tenant and connected to this Databricks workspace. + email: + type: object + properties: + addresses: type: array items: type: string - description: '[Input-Only][Optional] OAuth2 scopes requested at token mint (required by some IdPs).' - oauth_scopes_set: - type: boolean - description: '[Output-Only] Whether OAuth2 scopes are set.' - oauth_token_url: - type: string - description: '[Input-Only][Optional] OAuth2 token endpoint URL (customer IdP) where access tokens - are minted.' - oauth_token_url_set: - type: boolean - description: '[Output-Only] Whether OAuth2 token URL is set.' + generic_webhook: + type: object + properties: password: type: string - description: '[Input-Only][Optional] Password for webhook.' password_set: type: boolean description: '[Output-Only] Whether password is set.' @@ -4188,51 +4210,61 @@ paths: config: type: object properties: - email: + databricks_app_slack: type: object properties: - addresses: - type: array - items: - type: string - generic_webhook: + channel_id: + type: string + description: '[Input-Only] Slack channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Slack workspace (team) ID the Databricks app is installed in.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + description: |- + Slack channel reached through the Databricks app. The app must already be installed in the Slack + workspace and connected to this Databricks workspace. + databricks_app_teams: type: object properties: - oauth_audience: + channel_id: type: string - oauth_audience_set: + description: '[Input-Only] Teams channel ID notifications are posted to.' + channel_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 audience is set.' - oauth_client_id: + description: '[Output-Only] Whether channel ID is set.' + team_id: type: string - description: '[Input-Only][Optional] OAuth2 client ID for the client_credentials grant.' - oauth_client_id_set: + description: '[Input-Only] Microsoft Entra group ID of the team that owns the channel.' + team_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 client ID is set.' - oauth_client_secret: + description: '[Output-Only] Whether team ID is set.' + tenant_id: type: string - description: '[Input-Only][Optional] OAuth2 client secret for the client_credentials grant.' - oauth_client_secret_set: + description: '[Input-Only] Microsoft Entra tenant ID of the Microsoft 365 tenant the app is installed + in.' + tenant_id_set: type: boolean - description: '[Output-Only] Whether OAuth2 client secret is set.' - oauth_scopes: + description: '[Output-Only] Whether tenant ID is set.' + description: |- + Microsoft Teams channel reached through the Databricks app. The app must already be installed in + the Microsoft 365 tenant and connected to this Databricks workspace. + email: + type: object + properties: + addresses: type: array items: type: string - description: '[Input-Only][Optional] OAuth2 scopes requested at token mint (required by some IdPs).' - oauth_scopes_set: - type: boolean - description: '[Output-Only] Whether OAuth2 scopes are set.' - oauth_token_url: - type: string - description: '[Input-Only][Optional] OAuth2 token endpoint URL (customer IdP) where access tokens - are minted.' - oauth_token_url_set: - type: boolean - description: '[Output-Only] Whether OAuth2 token URL is set.' + generic_webhook: + type: object + properties: password: type: string - description: '[Input-Only][Optional] Password for webhook.' password_set: type: boolean description: '[Output-Only] Whether password is set.' @@ -5634,9 +5666,6 @@ paths: items: type: string description: Output only. Inferred API path scopes collected for this token when autoscope is enabled. - last_accessed_time: - type: integer - description: Server time (in epoch milliseconds) when the token was accessed most recently. scopes: type: array items: @@ -6104,6 +6133,10 @@ components: Config: type: object properties: + databricks_app_slack: + $ref: '#/components/schemas/DatabricksAppSlackConfig' + databricks_app_teams: + $ref: '#/components/schemas/DatabricksAppTeamsConfig' email: $ref: '#/components/schemas/EmailConfig' generic_webhook: @@ -6225,6 +6258,8 @@ components: properties: cross_workspace_access: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess' + description: 'The network policy restrictions for cross-workspace access: which other workspaces may access this + workspace.' private_access: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyPrivateAccess' description: The network policy restrictions for private access. Configures how requests arriving over private connectivity @@ -6237,15 +6272,6 @@ components: CustomerFacingIngressNetworkPolicyAccountApiDestination: type: object properties: - excluded_scopes: - type: array - items: - type: string - description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here ("allow all except"). Mutually - exclusive with ``scopes`` — a single destination may set at most one of the two.' - scope_constraint: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeConstraint' - description: 'Deprecated: Use scope_qualifier instead.' scope_qualifier: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeQualifier' description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. @@ -6297,10 +6323,14 @@ components: type: array items: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule' + description: Allow rules are evaluated after deny rules. A request matching any allow rule is allowed; a request + matching no rule is denied by default. Only applies when restriction_mode is RESTRICTED_ACCESS. deny_rules: type: array items: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule' + description: Deny rules are evaluated first. A request matching any deny rule is denied, regardless of allow rules. + Only applies when restriction_mode is RESTRICTED_ACCESS. required: - restriction_mode CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule: @@ -6308,13 +6338,22 @@ components: properties: authentication: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyAuthentication' + description: The authenticated identity the request must match. When unset, the rule matches all users and service + principals. destination: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyRequestDestination' + description: The destination the request must match — the resource being accessed, for example the workspace UI + or workspace APIs. See RequestDestination. label: type: string description: The label for this ingress rule. origin: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin' + description: The origin the request must match — the source workspace the request comes from, either specific source + workspaces or any source workspace in any account. See CrossWorkspaceRequestOrigin. + description: |- + An ingress rule is enforced when a request satisfies all specified attributes — including + request origin, destination, and authentication. CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin: type: object properties: @@ -6344,23 +6383,6 @@ components: properties: all_destinations: type: boolean - CustomerFacingIngressNetworkPolicyManagedIpRange: - type: object - properties: - name: - type: string - description: Name of the managed IP range, e.g., "powerbi". - regions: - type: array - items: - type: string - description: Partner regions to allow, e.g., ["EastUS", "WestEurope"]. Each region must belong to the partner named - in ``name``. Empty list means all regions of the partner. Region casing matches the partner's source (e.g., Microsoft - uses "EastUS"), so values are stored verbatim, not lowercased. - description: |- - A Databricks-managed IP range identified by name (e.g., "powerbi", "dbt"), optionally scoped to - specific partner regions. Customers reference a name instead of raw CIDRs; Databricks keeps the - underlying IP list current. CustomerFacingIngressNetworkPolicyPrivateAccess: type: object properties: @@ -6469,10 +6491,6 @@ components: included_ip_ranges: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyIpRanges' description: Will not allow IP ranges with private IPs. - managed_ip_range: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyManagedIpRange' - description: A single Databricks-maintained IP range for a well-known partner (e.g., Power BI, dbt), optionally - scoped to specific partner regions. Customers create one rule per partner. CustomerFacingIngressNetworkPolicyRequestDestination: type: object properties: @@ -6505,9 +6523,6 @@ components: type: string description: 'Inverse of ``scopes``: matches every API scope EXCEPT those listed here ("allow all except"). Mutually exclusive with ``scopes`` — a single destination may set at most one of the two.' - scope_constraint: - $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeConstraint' - description: 'Deprecated: Use scope_qualifier instead.' scope_qualifier: $ref: '#/components/schemas/CustomerFacingIngressNetworkPolicyApiScopeQualifier' description: Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. @@ -6606,6 +6621,48 @@ components: name is required to be 'default' if the setting only has one instance per workspace. required: - boolean_val + DatabricksAppSlackConfig: + type: object + properties: + channel_id: + type: string + description: '[Input-Only] Slack channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Slack workspace (team) ID the Databricks app is installed in.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + description: |- + Slack channel reached through the Databricks app. The app must already be installed in the Slack + workspace and connected to this Databricks workspace. + DatabricksAppTeamsConfig: + type: object + properties: + channel_id: + type: string + description: '[Input-Only] Teams channel ID notifications are posted to.' + channel_id_set: + type: boolean + description: '[Output-Only] Whether channel ID is set.' + team_id: + type: string + description: '[Input-Only] Microsoft Entra group ID of the team that owns the channel.' + team_id_set: + type: boolean + description: '[Output-Only] Whether team ID is set.' + tenant_id: + type: string + description: '[Input-Only] Microsoft Entra tenant ID of the Microsoft 365 tenant the app is installed in.' + tenant_id_set: + type: boolean + description: '[Output-Only] Whether tenant ID is set.' + description: |- + Microsoft Teams channel reached through the Databricks app. The app must already be installed in + the Microsoft 365 tenant and connected to this Databricks workspace. DefaultNamespaceSetting: type: object properties: @@ -7174,40 +7231,8 @@ components: GenericWebhookConfig: type: object properties: - oauth_audience: - type: string - oauth_audience_set: - type: boolean - description: '[Output-Only] Whether OAuth2 audience is set.' - oauth_client_id: - type: string - description: '[Input-Only][Optional] OAuth2 client ID for the client_credentials grant.' - oauth_client_id_set: - type: boolean - description: '[Output-Only] Whether OAuth2 client ID is set.' - oauth_client_secret: - type: string - description: '[Input-Only][Optional] OAuth2 client secret for the client_credentials grant.' - oauth_client_secret_set: - type: boolean - description: '[Output-Only] Whether OAuth2 client secret is set.' - oauth_scopes: - type: array - items: - type: string - description: '[Input-Only][Optional] OAuth2 scopes requested at token mint (required by some IdPs).' - oauth_scopes_set: - type: boolean - description: '[Output-Only] Whether OAuth2 scopes are set.' - oauth_token_url: - type: string - description: '[Input-Only][Optional] OAuth2 token endpoint URL (customer IdP) where access tokens are minted.' - oauth_token_url_set: - type: boolean - description: '[Output-Only] Whether OAuth2 token URL is set.' password: type: string - description: '[Input-Only][Optional] Password for webhook.' password_set: type: boolean description: '[Output-Only] Whether password is set.' @@ -7561,8 +7586,6 @@ components: $ref: '#/components/schemas/NccAwsStableIpRule' azure_service_endpoint_rule: $ref: '#/components/schemas/NccAzureServiceEndpointRule' - gcp_project_id_rule: - $ref: '#/components/schemas/NetworkConnectivityConfigEgressConfigDefaultRuleGcpProjectIdRule' description: Default rules don't have specific targets. NccEgressTargetRules: type: object @@ -7656,13 +7679,6 @@ components: description: |- Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization. - NetworkConnectivityConfigEgressConfigDefaultRuleGcpProjectIdRule: - type: object - properties: - project_ids: - type: array - items: - type: string NetworkConnectivityConfiguration: type: object properties: @@ -7776,9 +7792,6 @@ components: items: type: string description: Output only. Inferred API path scopes collected for this token when autoscope is enabled. - last_accessed_time: - type: integer - description: Server time (in epoch milliseconds) when the token was accessed most recently. scopes: type: array items: @@ -8151,7 +8164,6 @@ components: ComplianceStandard: type: string x-enum: - - ARC_AMPE - CANADA_PROTECTED_B - CYBER_ESSENTIAL_PLUS - FEDRAMP_HIGH @@ -8171,12 +8183,6 @@ components: description: |- Compliance standard for SHIELD customers. See README.md for how instructions of how to add new standards. - CustomerFacingIngressNetworkPolicyApiScopeConstraint: - type: string - x-enum: - - ALL - - READ - description: 'Deprecated: Use ApiScopeQualifier instead.' CustomerFacingIngressNetworkPolicyApiScopeQualifier: type: string x-enum: @@ -8275,44 +8281,14 @@ components: type: string x-enum: - FULL_ACCESS + - LEGACY_MODE - RESTRICTED_ACCESS description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. + The restriction mode for cross-workspace access. In FULL_ACCESS mode, requests from any source + workspace (in any account) are allowed, and deny rules and allow rules cannot be set. In + RESTRICTED_ACCESS mode, access is restricted based on deny rules and allow rules; requests that + do not match any allow rule are denied. In LEGACY_MODE, cross-workspace ingress is not governed + by this policy. CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode: type: string x-enum: @@ -8415,6 +8391,8 @@ components: DestinationType: type: string x-enum: + - DATABRICKS_APP_SLACK + - DATABRICKS_APP_TEAMS - EMAIL - MICROSOFT_TEAMS - PAGERDUTY @@ -9998,6 +9976,9 @@ components: config: docs: fields: + - name: deployment_name + type: string + description: Workspace deployment name the settings belong to. - name: key type: string description: The name of the workspace setting (only non-null values are included). @@ -10012,119 +9993,115 @@ components: select: predicate: sqlDialect == "sqlite3" ddl: |- - SELECT key, value - FROM ( - SELECT - json_object( - 'enableWebTerminal', enableWebTerminal, - 'enableTokensConfig', enableTokensConfig, - 'maxTokenLifetimeDays', maxTokenLifetimeDays, - 'enableWorkspaceFilesystem', enableWorkspaceFilesystem, - 'enableExportNotebook', enableExportNotebook, - 'enableNotebookTableClipboard', enableNotebookTableClipboard, - 'enableResultsDownloading', enableResultsDownloading, - 'enableDcs', enableDcs, - 'enableGp3', enableGp3, - 'mlflowRunArtifactDownloadEnabled', mlflowRunArtifactDownloadEnabled, - 'enableUploadDataUis', enableUploadDataUis, - 'storeInteractiveNotebookResultsInCustomerAccount', storeInteractiveNotebookResultsInCustomerAccount, - 'enableDeprecatedGlobalInitScripts', enableDeprecatedGlobalInitScripts, - 'rStudioUserDefaultHomeBase', rStudioUserDefaultHomeBase, - 'enforceUserIsolation', enforceUserIsolation, - 'enableProjectsAllowList', enableProjectsAllowList, - 'projectsAllowListPermissions', projectsAllowListPermissions, - 'projectsAllowList', projectsAllowList, - 'reposIpynbResultsExportPermissions', reposIpynbResultsExportPermissions, - 'enableDbfsFileBrowser', enableDbfsFileBrowser, - 'enableDatabricksAutologgingAdminConf', enableDatabricksAutologgingAdminConf, - 'mlflowModelServingEndpointCreationEnabled', mlflowModelServingEndpointCreationEnabled, - 'enableVerboseAuditLogs', enableVerboseAuditLogs, - 'enableFileStoreEndpoint', enableFileStoreEndpoint, - 'loginLogo', loginLogo, - 'productName', productName, - 'homePageLogo', homePageLogo, - 'homePageLogoWidth', homePageLogoWidth, - 'homePageWelcomeMessage', homePageWelcomeMessage, - 'sidebarLogoText', sidebarLogoText, - 'sidebarLogoActive', sidebarLogoActive, - 'sidebarLogoInactive', sidebarLogoInactive, - 'customReferences', customReferences, - 'loginLogoWidth', loginLogoWidth, - 'enforceWorkspaceViewAcls', enforceWorkspaceViewAcls, - 'enforceClusterViewAcls', enforceClusterViewAcls, - 'enableJobViewAcls', enableJobViewAcls, - 'enableHlsRuntime', enableHlsRuntime, - 'enableEnforceImdsV2', enableEnforceImdsV2, - 'enableJobsEmailsV2', enableJobsEmailsV2, - 'enableProjectTypeInWorkspace', enableProjectTypeInWorkspace, - 'mlflowModelRegistryEmailNotificationsEnabled', mlflowModelRegistryEmailNotificationsEnabled, - 'jobsListBackendPaginationEnabled', jobsListBackendPaginationEnabled, - 'jobsListBackendPaginationOptOut', jobsListBackendPaginationOptOut - ) AS settings_object, - json_each.key, - json_each.value - FROM databricks_workspace.settings.workspace_config c, - json_each(settings_object) - WHERE keys='enableWebTerminal,enableTokensConfig,maxTokenLifetimeDays,enableWorkspaceFilesystem,enableExportNotebook,enableNotebookTableClipboard,enableResultsDownloading,enableDcs,enableGp3,mlflowRunArtifactDownloadEnabled,enableUploadDataUis,storeInteractiveNotebookResultsInCustomerAccount,enableDeprecatedGlobalInitScripts,rStudioUserDefaultHomeBase,enforceUserIsolation,enableProjectsAllowList,projectsAllowListPermissions,projectsAllowList,reposIpynbResultsExportPermissions,enableDbfsFileBrowser,enableDatabricksAutologgingAdminConf,mlflowModelServingEndpointCreationEnabled,enableVerboseAuditLogs,enableFileStoreEndpoint,loginLogo,productName,homePageLogo,homePageLogoWidth,homePageWelcomeMessage,sidebarLogoText,sidebarLogoActive,sidebarLogoInactive,customReferences,loginLogoWidth,enforceWorkspaceViewAcls,enforceClusterViewAcls,enableJobViewAcls,enableHlsRuntime,enableEnforceImdsV2,enableJobsEmailsV2,enableProjectTypeInWorkspace,mlflowModelRegistryEmailNotificationsEnabled,jobsListBackendPaginationEnabled,jobsListBackendPaginationOptOut' - AND deployment_name='{{ deployment_name }}' - ) t WHERE value IS NOT NULL; + SELECT + c.deployment_name, + je.key, + je.value + FROM databricks_workspace.settings.workspace_config c, + json_each(json_object( + 'enableWebTerminal', c.enableWebTerminal, + 'enableTokensConfig', c.enableTokensConfig, + 'maxTokenLifetimeDays', c.maxTokenLifetimeDays, + 'enableWorkspaceFilesystem', c.enableWorkspaceFilesystem, + 'enableExportNotebook', c.enableExportNotebook, + 'enableNotebookTableClipboard', c.enableNotebookTableClipboard, + 'enableResultsDownloading', c.enableResultsDownloading, + 'enableDcs', c.enableDcs, + 'enableGp3', c.enableGp3, + 'mlflowRunArtifactDownloadEnabled', c.mlflowRunArtifactDownloadEnabled, + 'enableUploadDataUis', c.enableUploadDataUis, + 'storeInteractiveNotebookResultsInCustomerAccount', c.storeInteractiveNotebookResultsInCustomerAccount, + 'enableDeprecatedGlobalInitScripts', c.enableDeprecatedGlobalInitScripts, + 'rStudioUserDefaultHomeBase', c.rStudioUserDefaultHomeBase, + 'enforceUserIsolation', c.enforceUserIsolation, + 'enableProjectsAllowList', c.enableProjectsAllowList, + 'projectsAllowListPermissions', c.projectsAllowListPermissions, + 'projectsAllowList', c.projectsAllowList, + 'reposIpynbResultsExportPermissions', c.reposIpynbResultsExportPermissions, + 'enableDbfsFileBrowser', c.enableDbfsFileBrowser, + 'enableDatabricksAutologgingAdminConf', c.enableDatabricksAutologgingAdminConf, + 'mlflowModelServingEndpointCreationEnabled', c.mlflowModelServingEndpointCreationEnabled, + 'enableVerboseAuditLogs', c.enableVerboseAuditLogs, + 'enableFileStoreEndpoint', c.enableFileStoreEndpoint, + 'loginLogo', c.loginLogo, + 'productName', c.productName, + 'homePageLogo', c.homePageLogo, + 'homePageLogoWidth', c.homePageLogoWidth, + 'homePageWelcomeMessage', c.homePageWelcomeMessage, + 'sidebarLogoText', c.sidebarLogoText, + 'sidebarLogoActive', c.sidebarLogoActive, + 'sidebarLogoInactive', c.sidebarLogoInactive, + 'customReferences', c.customReferences, + 'loginLogoWidth', c.loginLogoWidth, + 'enforceWorkspaceViewAcls', c.enforceWorkspaceViewAcls, + 'enforceClusterViewAcls', c.enforceClusterViewAcls, + 'enableJobViewAcls', c.enableJobViewAcls, + 'enableHlsRuntime', c.enableHlsRuntime, + 'enableEnforceImdsV2', c.enableEnforceImdsV2, + 'enableJobsEmailsV2', c.enableJobsEmailsV2, + 'enableProjectTypeInWorkspace', c.enableProjectTypeInWorkspace, + 'mlflowModelRegistryEmailNotificationsEnabled', c.mlflowModelRegistryEmailNotificationsEnabled, + 'jobsListBackendPaginationEnabled', c.jobsListBackendPaginationEnabled, + 'jobsListBackendPaginationOptOut', c.jobsListBackendPaginationOptOut + )) je + WHERE c.keys = 'enableWebTerminal,enableTokensConfig,maxTokenLifetimeDays,enableWorkspaceFilesystem,enableExportNotebook,enableNotebookTableClipboard,enableResultsDownloading,enableDcs,enableGp3,mlflowRunArtifactDownloadEnabled,enableUploadDataUis,storeInteractiveNotebookResultsInCustomerAccount,enableDeprecatedGlobalInitScripts,rStudioUserDefaultHomeBase,enforceUserIsolation,enableProjectsAllowList,projectsAllowListPermissions,projectsAllowList,reposIpynbResultsExportPermissions,enableDbfsFileBrowser,enableDatabricksAutologgingAdminConf,mlflowModelServingEndpointCreationEnabled,enableVerboseAuditLogs,enableFileStoreEndpoint,loginLogo,productName,homePageLogo,homePageLogoWidth,homePageWelcomeMessage,sidebarLogoText,sidebarLogoActive,sidebarLogoInactive,customReferences,loginLogoWidth,enforceWorkspaceViewAcls,enforceClusterViewAcls,enableJobViewAcls,enableHlsRuntime,enableEnforceImdsV2,enableJobsEmailsV2,enableProjectTypeInWorkspace,mlflowModelRegistryEmailNotificationsEnabled,jobsListBackendPaginationEnabled,jobsListBackendPaginationOptOut' + AND je.value IS NOT NULL fallback: predicate: sqlDialect == "postgres" ddl: |- - SELECT key, value - FROM ( - SELECT - (jsonb_build_object( - 'enableWebTerminal', enableWebTerminal, - 'enableTokensConfig', enableTokensConfig, - 'maxTokenLifetimeDays', maxTokenLifetimeDays, - 'enableWorkspaceFilesystem', enableWorkspaceFilesystem, - 'enableExportNotebook', enableExportNotebook, - 'enableNotebookTableClipboard', enableNotebookTableClipboard, - 'enableResultsDownloading', enableResultsDownloading, - 'enableDcs', enableDcs, - 'enableGp3', enableGp3, - 'mlflowRunArtifactDownloadEnabled', mlflowRunArtifactDownloadEnabled, - 'enableUploadDataUis', enableUploadDataUis, - 'storeInteractiveNotebookResultsInCustomerAccount', storeInteractiveNotebookResultsInCustomerAccount, - 'enableDeprecatedGlobalInitScripts', enableDeprecatedGlobalInitScripts, - 'rStudioUserDefaultHomeBase', rStudioUserDefaultHomeBase, - 'enforceUserIsolation', enforceUserIsolation, - 'enableProjectsAllowList', enableProjectsAllowList, - 'projectsAllowListPermissions', projectsAllowListPermissions, - 'projectsAllowList', projectsAllowList, - 'reposIpynbResultsExportPermissions', reposIpynbResultsExportPermissions, - 'enableDbfsFileBrowser', enableDbfsFileBrowser, - 'enableDatabricksAutologgingAdminConf', enableDatabricksAutologgingAdminConf, - 'mlflowModelServingEndpointCreationEnabled', mlflowModelServingEndpointCreationEnabled, - 'enableVerboseAuditLogs', enableVerboseAuditLogs, - 'enableFileStoreEndpoint', enableFileStoreEndpoint, - 'loginLogo', loginLogo, - 'productName', productName, - 'homePageLogo', homePageLogo, - 'homePageLogoWidth', homePageLogoWidth, - 'homePageWelcomeMessage', homePageWelcomeMessage, - 'sidebarLogoText', sidebarLogoText, - 'sidebarLogoActive', sidebarLogoActive, - 'sidebarLogoInactive', sidebarLogoInactive, - 'customReferences', customReferences, - 'loginLogoWidth', loginLogoWidth, - 'enforceWorkspaceViewAcls', enforceWorkspaceViewAcls, - 'enforceClusterViewAcls', enforceClusterViewAcls, - 'enableJobViewAcls', enableJobViewAcls, - 'enableHlsRuntime', enableHlsRuntime, - 'enableEnforceImdsV2', enableEnforceImdsV2, - 'enableJobsEmailsV2', enableJobsEmailsV2, - 'enableProjectTypeInWorkspace', enableProjectTypeInWorkspace, - 'mlflowModelRegistryEmailNotificationsEnabled', mlflowModelRegistryEmailNotificationsEnabled, - 'jobsListBackendPaginationEnabled', jobsListBackendPaginationEnabled, - 'jobsListBackendPaginationOptOut', jobsListBackendPaginationOptOut - )) AS settings_object - FROM databricks_workspace.settings.workspace_config c - WHERE keys='enableWebTerminal,enableTokensConfig,maxTokenLifetimeDays,enableWorkspaceFilesystem,enableExportNotebook,enableNotebookTableClipboard,enableResultsDownloading,enableDcs,enableGp3,mlflowRunArtifactDownloadEnabled,enableUploadDataUis,storeInteractiveNotebookResultsInCustomerAccount,enableDeprecatedGlobalInitScripts,rStudioUserDefaultHomeBase,enforceUserIsolation,enableProjectsAllowList,projectsAllowListPermissions,projectsAllowList,reposIpynbResultsExportPermissions,enableDbfsFileBrowser,enableDatabricksAutologgingAdminConf,mlflowModelServingEndpointCreationEnabled,enableVerboseAuditLogs,enableFileStoreEndpoint,loginLogo,productName,homePageLogo,homePageLogoWidth,homePageWelcomeMessage,sidebarLogoText,sidebarLogoActive,sidebarLogoInactive,customReferences,loginLogoWidth,enforceWorkspaceViewAcls,enforceClusterViewAcls,enableJobViewAcls,enableHlsRuntime,enableEnforceImdsV2,enableJobsEmailsV2,enableProjectTypeInWorkspace,mlflowModelRegistryEmailNotificationsEnabled,jobsListBackendPaginationEnabled,jobsListBackendPaginationOptOut' - AND deployment_name='{{ deployment_name }}' - ) t, LATERAL jsonb_each_text(t.settings_object) - WHERE value IS NOT NULL; + SELECT + c.deployment_name, + je.key, + je.value + FROM databricks_workspace.settings.workspace_config c, + jsonb_each_text(jsonb_build_object( + 'enableWebTerminal', c.enableWebTerminal, + 'enableTokensConfig', c.enableTokensConfig, + 'maxTokenLifetimeDays', c.maxTokenLifetimeDays, + 'enableWorkspaceFilesystem', c.enableWorkspaceFilesystem, + 'enableExportNotebook', c.enableExportNotebook, + 'enableNotebookTableClipboard', c.enableNotebookTableClipboard, + 'enableResultsDownloading', c.enableResultsDownloading, + 'enableDcs', c.enableDcs, + 'enableGp3', c.enableGp3, + 'mlflowRunArtifactDownloadEnabled', c.mlflowRunArtifactDownloadEnabled, + 'enableUploadDataUis', c.enableUploadDataUis, + 'storeInteractiveNotebookResultsInCustomerAccount', c.storeInteractiveNotebookResultsInCustomerAccount, + 'enableDeprecatedGlobalInitScripts', c.enableDeprecatedGlobalInitScripts, + 'rStudioUserDefaultHomeBase', c.rStudioUserDefaultHomeBase, + 'enforceUserIsolation', c.enforceUserIsolation, + 'enableProjectsAllowList', c.enableProjectsAllowList, + 'projectsAllowListPermissions', c.projectsAllowListPermissions, + 'projectsAllowList', c.projectsAllowList, + 'reposIpynbResultsExportPermissions', c.reposIpynbResultsExportPermissions, + 'enableDbfsFileBrowser', c.enableDbfsFileBrowser, + 'enableDatabricksAutologgingAdminConf', c.enableDatabricksAutologgingAdminConf, + 'mlflowModelServingEndpointCreationEnabled', c.mlflowModelServingEndpointCreationEnabled, + 'enableVerboseAuditLogs', c.enableVerboseAuditLogs, + 'enableFileStoreEndpoint', c.enableFileStoreEndpoint, + 'loginLogo', c.loginLogo, + 'productName', c.productName, + 'homePageLogo', c.homePageLogo, + 'homePageLogoWidth', c.homePageLogoWidth, + 'homePageWelcomeMessage', c.homePageWelcomeMessage, + 'sidebarLogoText', c.sidebarLogoText, + 'sidebarLogoActive', c.sidebarLogoActive, + 'sidebarLogoInactive', c.sidebarLogoInactive, + 'customReferences', c.customReferences, + 'loginLogoWidth', c.loginLogoWidth, + 'enforceWorkspaceViewAcls', c.enforceWorkspaceViewAcls, + 'enforceClusterViewAcls', c.enforceClusterViewAcls, + 'enableJobViewAcls', c.enableJobViewAcls, + 'enableHlsRuntime', c.enableHlsRuntime, + 'enableEnforceImdsV2', c.enableEnforceImdsV2, + 'enableJobsEmailsV2', c.enableJobsEmailsV2, + 'enableProjectTypeInWorkspace', c.enableProjectTypeInWorkspace, + 'mlflowModelRegistryEmailNotificationsEnabled', c.mlflowModelRegistryEmailNotificationsEnabled, + 'jobsListBackendPaginationEnabled', c.jobsListBackendPaginationEnabled, + 'jobsListBackendPaginationOptOut', c.jobsListBackendPaginationOptOut + )) je + WHERE c.keys = 'enableWebTerminal,enableTokensConfig,maxTokenLifetimeDays,enableWorkspaceFilesystem,enableExportNotebook,enableNotebookTableClipboard,enableResultsDownloading,enableDcs,enableGp3,mlflowRunArtifactDownloadEnabled,enableUploadDataUis,storeInteractiveNotebookResultsInCustomerAccount,enableDeprecatedGlobalInitScripts,rStudioUserDefaultHomeBase,enforceUserIsolation,enableProjectsAllowList,projectsAllowListPermissions,projectsAllowList,reposIpynbResultsExportPermissions,enableDbfsFileBrowser,enableDatabricksAutologgingAdminConf,mlflowModelServingEndpointCreationEnabled,enableVerboseAuditLogs,enableFileStoreEndpoint,loginLogo,productName,homePageLogo,homePageLogoWidth,homePageWelcomeMessage,sidebarLogoText,sidebarLogoActive,sidebarLogoInactive,customReferences,loginLogoWidth,enforceWorkspaceViewAcls,enforceClusterViewAcls,enableJobViewAcls,enableHlsRuntime,enableEnforceImdsV2,enableJobsEmailsV2,enableProjectTypeInWorkspace,mlflowModelRegistryEmailNotificationsEnabled,jobsListBackendPaginationEnabled,jobsListBackendPaginationOptOut' + AND je.value IS NOT NULL x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml b/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml index 9146bb09..d38bbc01 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.settingsv2 servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.1/settings/{name}: get: @@ -104,989 +121,977 @@ paths: schema: type: object properties: - setting: + aibi_dashboard_embedding_access_policy: type: object properties: - aibi_dashboard_embedding_access_policy: - type: object - properties: - access_policy_type: - type: string - x-enum: - - ALLOW_ALL_DOMAINS - - ALLOW_APPROVED_DOMAINS - - DENY_ALL_DOMAINS - description: >- - Create a collection of name/value pairs. + access_policy_type: + type: string + x-enum: + - ALLOW_ALL_DOMAINS + - ALLOW_APPROVED_DOMAINS + - DENY_ALL_DOMAINS + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - access_policy_type - aibi_dashboard_embedding_approved_domains: - type: object - properties: - approved_domains: - type: array - items: - type: string - description: >- - Setting value for - aibi_dashboard_embedding_approved_domains setting. This - is the setting value set by consumers, check - effective_aibi_dashboard_embedding_approved_domains for - final setting value. - allowed_apps_user_api_scopes: + attributes -- see the documentation for details. + required: + - access_policy_type + aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + description: >- + Setting value for aibi_dashboard_embedding_approved_domains + setting. This is the setting value set by consumers, check + effective_aibi_dashboard_embedding_approved_domains for + final setting value. + allowed_apps_user_api_scopes: + type: object + properties: + allowed_scopes: + type: array + items: + type: string + description: >- + Setting value for allowed_apps_user_api_scopes setting. This + is the setting value set by consumers, check + effective_allowed_apps_user_api_scopes for final setting + value. + automatic_cluster_update_workspace: + type: object + properties: + can_toggle: + type: boolean + enabled: + type: boolean + enablement_details: type: object properties: - allowed_scopes: - type: array - items: - type: string + forced_for_compliance_mode: + type: boolean + description: >- + The feature is force enabled if compliance mode is + active + unavailable_for_disabled_entitlement: + type: boolean + description: >- + The feature is unavailable if the corresponding + entitlement disabled (see + getShieldEntitlementEnable) + unavailable_for_non_enterprise_tier: + type: boolean + description: >- + The feature is unavailable if the customer doesn't + have enterprise tier description: >- - Setting value for allowed_apps_user_api_scopes setting. - This is the setting value set by consumers, check - effective_allowed_apps_user_api_scopes for final setting - value. - automatic_cluster_update_workspace: + Contains an information about the enablement status + judging (e.g. whether the enterprise tier is + enabled) This is only additional information that MUST NOT be used to decide whether the setting + is enabled or not. This is intended to use only for purposes like showing an error message to + the customer with the additional details. For example, using these details we can check why + exactly the feature is disabled for this customer. + maintenance_window: type: object properties: - can_toggle: - type: boolean - enabled: - type: boolean - enablement_details: + week_day_based_schedule: type: object properties: - forced_for_compliance_mode: - type: boolean - description: >- - The feature is force enabled if compliance mode - is active - unavailable_for_disabled_entitlement: - type: boolean + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY description: >- - The feature is unavailable if the corresponding - entitlement disabled (see - getShieldEntitlementEnable) - unavailable_for_non_enterprise_tier: - type: boolean - description: >- - The feature is unavailable if the customer - doesn't have enterprise tier - description: >- - Contains an information about the enablement status - judging (e.g. whether the enterprise tier is - enabled) This is only additional information that MUST NOT be used to decide whether the setting - is enabled or not. This is intended to use only for purposes like showing an error message to - the customer with the additional details. For example, using these details we can check why - exactly the feature is disabled for this customer. - maintenance_window: - type: object - properties: - week_day_based_schedule: - type: object - properties: - day_of_week: - type: string - x-enum: - - FRIDAY - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - frequency: - type: string - x-enum: - - EVERY_WEEK - - FIRST_AND_THIRD_OF_MONTH - - FIRST_OF_MONTH - - FOURTH_OF_MONTH - - SECOND_AND_FOURTH_OF_MONTH - - SECOND_OF_MONTH - - THIRD_OF_MONTH - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + frequency: + type: string + x-enum: + - EVERY_WEEK + - FIRST_AND_THIRD_OF_MONTH + - FIRST_OF_MONTH + - FOURTH_OF_MONTH + - SECOND_AND_FOURTH_OF_MONTH + - SECOND_OF_MONTH + - THIRD_OF_MONTH + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - window_start_time: - type: object - properties: - hours: - type: integer - minutes: - type: integer - restart_even_if_no_updates_available: - type: boolean - description: >- - Setting value for automatic_cluster_update_workspace - setting. This is the setting value set by consumers, - check effective_automatic_cluster_update_workspace for - final setting value. - boolean_val: - type: object - properties: - value: - type: boolean + attributes -- see the documentation for details. + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + restart_even_if_no_updates_available: + type: boolean + description: >- + Setting value for automatic_cluster_update_workspace + setting. This is the setting value set by consumers, check + effective_automatic_cluster_update_workspace for final + setting value. + boolean_val: + type: object + properties: + value: + type: boolean + description: >- + Setting value for boolean type setting. This is the setting + value set by consumers, check effective_boolean_val for + final setting value. + collaboration_platform_connectivity: + type: object + properties: + connectivity: + type: string + x-enum: + - ALLOW_ALL + - ALLOW_SLACK + - ALLOW_TEAMS + - DENY_ALL description: >- - Setting value for boolean type setting. This is the - setting value set by consumers, check - effective_boolean_val for final setting value. - collaboration_platform_connectivity: - type: object - properties: - connectivity: - type: string - x-enum: - - ALLOW_ALL - - ALLOW_SLACK - - ALLOW_TEAMS - - DENY_ALL - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - connectivity + attributes -- see the documentation for details. + required: + - connectivity + description: >- + Setting value for collaboration_platform_connectivity + setting. This is the setting value set by consumers, check + effective_collaboration_platform_connectivity for final + setting value. + effective_aibi_dashboard_embedding_access_policy: + type: object + properties: + access_policy_type: + type: string + x-enum: + - ALLOW_ALL_DOMAINS + - ALLOW_APPROVED_DOMAINS + - DENY_ALL_DOMAINS description: >- - Setting value for collaboration_platform_connectivity - setting. This is the setting value set by consumers, - check effective_collaboration_platform_connectivity for - final setting value. - effective_aibi_dashboard_embedding_access_policy: - type: object - properties: - access_policy_type: - type: string - x-enum: - - ALLOW_ALL_DOMAINS - - ALLOW_APPROVED_DOMAINS - - DENY_ALL_DOMAINS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - access_policy_type - description: >- - Effective setting value for - aibi_dashboard_embedding_access_policy setting. This is - the final effective value of setting. To set a value use - aibi_dashboard_embedding_access_policy. - effective_aibi_dashboard_embedding_approved_domains: - type: object - properties: - approved_domains: - type: array - items: - type: string - description: >- - Effective setting value for - aibi_dashboard_embedding_approved_domains setting. This - is the final effective value of setting. To set a value - use aibi_dashboard_embedding_approved_domains. - effective_allowed_apps_user_api_scopes: + attributes -- see the documentation for details. + required: + - access_policy_type + description: >- + Effective setting value for + aibi_dashboard_embedding_access_policy setting. This is the + final effective value of setting. To set a value use + aibi_dashboard_embedding_access_policy. + effective_aibi_dashboard_embedding_approved_domains: + type: object + properties: + approved_domains: + type: array + items: + type: string + description: >- + Effective setting value for + aibi_dashboard_embedding_approved_domains setting. This is + the final effective value of setting. To set a value use + aibi_dashboard_embedding_approved_domains. + effective_allowed_apps_user_api_scopes: + type: object + properties: + allowed_scopes: + type: array + items: + type: string + description: >- + Effective setting value for allowed_apps_user_api_scopes + setting. This is the final effective value of setting. To + set a value use allowed_apps_user_api_scopes. + effective_automatic_cluster_update_workspace: + type: object + properties: + can_toggle: + type: boolean + enabled: + type: boolean + enablement_details: type: object properties: - allowed_scopes: - type: array - items: - type: string + forced_for_compliance_mode: + type: boolean + description: >- + The feature is force enabled if compliance mode is + active + unavailable_for_disabled_entitlement: + type: boolean + description: >- + The feature is unavailable if the corresponding + entitlement disabled (see + getShieldEntitlementEnable) + unavailable_for_non_enterprise_tier: + type: boolean + description: >- + The feature is unavailable if the customer doesn't + have enterprise tier description: >- - Effective setting value for allowed_apps_user_api_scopes - setting. This is the final effective value of setting. - To set a value use allowed_apps_user_api_scopes. - effective_automatic_cluster_update_workspace: + Contains an information about the enablement status + judging (e.g. whether the enterprise tier is + enabled) This is only additional information that MUST NOT be used to decide whether the setting + is enabled or not. This is intended to use only for purposes like showing an error message to + the customer with the additional details. For example, using these details we can check why + exactly the feature is disabled for this customer. + maintenance_window: type: object properties: - can_toggle: - type: boolean - enabled: - type: boolean - enablement_details: + week_day_based_schedule: type: object properties: - forced_for_compliance_mode: - type: boolean + day_of_week: + type: string + x-enum: + - FRIDAY + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY description: >- - The feature is force enabled if compliance mode - is active - unavailable_for_disabled_entitlement: - type: boolean - description: >- - The feature is unavailable if the corresponding - entitlement disabled (see - getShieldEntitlementEnable) - unavailable_for_non_enterprise_tier: - type: boolean - description: >- - The feature is unavailable if the customer - doesn't have enterprise tier - description: >- - Contains an information about the enablement status - judging (e.g. whether the enterprise tier is - enabled) This is only additional information that MUST NOT be used to decide whether the setting - is enabled or not. This is intended to use only for purposes like showing an error message to - the customer with the additional details. For example, using these details we can check why - exactly the feature is disabled for this customer. - maintenance_window: - type: object - properties: - week_day_based_schedule: - type: object - properties: - day_of_week: - type: string - x-enum: - - FRIDAY - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - frequency: - type: string - x-enum: - - EVERY_WEEK - - FIRST_AND_THIRD_OF_MONTH - - FIRST_OF_MONTH - - FOURTH_OF_MONTH - - SECOND_AND_FOURTH_OF_MONTH - - SECOND_OF_MONTH - - THIRD_OF_MONTH - description: >- - Create a collection of name/value pairs. + attributes -- see the documentation for details. + frequency: + type: string + x-enum: + - EVERY_WEEK + - FIRST_AND_THIRD_OF_MONTH + - FIRST_OF_MONTH + - FOURTH_OF_MONTH + - SECOND_AND_FOURTH_OF_MONTH + - SECOND_OF_MONTH + - THIRD_OF_MONTH + description: >- + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know - how many members they have: + Enumerations can be iterated over, and know how + many members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , - ] + [, , ] - Methods can be added to enumerations, and - members can have their own + Methods can be added to enumerations, and + members can have their own - attributes -- see the documentation for - details. - window_start_time: - type: object - properties: - hours: - type: integer - minutes: - type: integer - restart_even_if_no_updates_available: - type: boolean - description: >- - Effective setting value for - automatic_cluster_update_workspace setting. This is the - final effective value of setting. To set a value use - automatic_cluster_update_workspace. - effective_boolean_val: - type: object - properties: - value: - type: boolean + attributes -- see the documentation for details. + window_start_time: + type: object + properties: + hours: + type: integer + minutes: + type: integer + restart_even_if_no_updates_available: + type: boolean + description: >- + Effective setting value for + automatic_cluster_update_workspace setting. This is the + final effective value of setting. To set a value use + automatic_cluster_update_workspace. + effective_boolean_val: + type: object + properties: + value: + type: boolean + description: >- + Effective setting value for boolean type setting. This is + the final effective value of setting. To set a value use + boolean_val. + effective_collaboration_platform_connectivity: + type: object + properties: + connectivity: + type: string + x-enum: + - ALLOW_ALL + - ALLOW_SLACK + - ALLOW_TEAMS + - DENY_ALL description: >- - Effective setting value for boolean type setting. This - is the final effective value of setting. To set a value - use boolean_val. - effective_collaboration_platform_connectivity: - type: object - properties: - connectivity: - type: string - x-enum: - - ALLOW_ALL - - ALLOW_SLACK - - ALLOW_TEAMS - - DENY_ALL - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - required: - - connectivity - description: >- - Effective setting value for - collaboration_platform_connectivity setting. This is the - final effective value of setting. To set a value use - collaboration_platform_connectivity. - effective_genie_chat_share_policy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Effective setting value for genie_chat_share_policy - setting. This is the final effective value of setting. - To set a value use genie_chat_share_policy. - effective_integer_val: - type: object - properties: - value: - type: integer - description: >- - Effective setting value for integer type setting. This - is the final effective value of setting. To set a value - use integer_val. - effective_operational_email_custom_recipient: - type: object - properties: - email: - type: string + attributes -- see the documentation for details. + required: + - connectivity + description: >- + Effective setting value for + collaboration_platform_connectivity setting. This is the + final effective value of setting. To set a value use + collaboration_platform_connectivity. + effective_integer_val: + type: object + properties: + value: + type: integer + description: >- + Effective setting value for integer type setting. This is + the final effective value of setting. To set a value use + integer_val. + effective_operational_email_custom_recipient: + type: object + properties: + email: + type: string + description: >- + Effective setting value for + operational_email_custom_recipient setting. This is the + final effective value of setting. To set a value use + operational_email_custom_recipient. + effective_personal_compute: + type: object + properties: + value: + type: string + x-enum: + - DELEGATE + - 'ON' description: >- - Effective setting value for - operational_email_custom_recipient setting. This is the - final effective value of setting. To set a value use - operational_email_custom_recipient. - effective_personal_compute: - type: object - properties: - value: - type: string - x-enum: - - DELEGATE - - 'ON' - description: >- - ON: Grants all users in all workspaces access to the - Personal Compute default policy, allowing + ON: Grants all users in all workspaces access to the + Personal Compute default policy, allowing - all users to create single-machine compute - resources. DELEGATE: Moves access control for the + all users to create single-machine compute resources. + DELEGATE: Moves access control for the - Personal Compute default policy to individual - workspaces and requires a workspace’s users or + Personal Compute default policy to individual workspaces + and requires a workspace’s users or - groups to be added to the ACLs of that workspace’s - Personal Compute default policy before they + groups to be added to the ACLs of that workspace’s + Personal Compute default policy before they - will be able to create compute resources through - that policy. + will be able to create compute resources through that + policy. + description: >- + Effective setting value for personal_compute setting. This + is the final effective value of setting. To set a value use + personal_compute. + effective_restrict_workspace_admins: + type: object + properties: + status: + type: string + x-enum: + - ALLOW_ALL + - RESTRICT_TOKENS_AND_JOB_RUN_AS description: >- - Effective setting value for personal_compute setting. - This is the final effective value of setting. To set a - value use personal_compute. - effective_restrict_workspace_admins: - type: object - properties: - status: - type: string - x-enum: - - ALLOW_ALL - - RESTRICT_TOKENS_AND_JOB_RUN_AS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - disable_gov_tag_creation: - type: boolean - description: >- - When true, workspace admins cannot create governance - tags. ALLOW_ALL status does not override this; they - are independent. - required: - - status - description: >- - Effective setting value for restrict_workspace_admins - setting. This is the final effective value of setting. - To set a value use restrict_workspace_admins. - effective_string_val: - type: object - properties: - value: - type: string + attributes -- see the documentation for details. + disable_gov_tag_creation: + type: boolean description: >- - Effective setting value for string type setting. This is - the final effective value of setting. To set a value use - string_val. - genie_chat_share_policy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Setting value for genie_chat_share_policy setting. This - is the setting value set by consumers, check - effective_genie_chat_share_policy for final setting - value. - integer_val: - type: object - properties: - value: - type: integer - description: >- - Setting value for integer type setting. This is the - setting value set by consumers, check - effective_integer_val for final setting value. - name: + When true, workspace admins cannot create governance + tags. ALLOW_ALL status does not override this; they are + independent. + required: + - status + description: >- + Effective setting value for restrict_workspace_admins + setting. This is the final effective value of setting. To + set a value use restrict_workspace_admins. + effective_string_val: + type: object + properties: + value: type: string - description: Name of the setting. - operational_email_custom_recipient: - type: object - properties: - email: - type: string + description: >- + Effective setting value for string type setting. This is the + final effective value of setting. To set a value use + string_val. + effective_workspace_label: + type: object + properties: + color: + type: string + label: + type: string + description: >- + Effective setting value for workspace_label setting. This is + the final effective value of setting. To set a value use + workspace_label. + integer_val: + type: object + properties: + value: + type: integer + description: >- + Setting value for integer type setting. This is the setting + value set by consumers, check effective_integer_val for + final setting value. + name: + type: string + description: Name of the setting. + operational_email_custom_recipient: + type: object + properties: + email: + type: string + description: >- + Setting value for operational_email_custom_recipient + setting. This is the setting value set by consumers, check + effective_operational_email_custom_recipient for final + setting value. + personal_compute: + type: object + properties: + value: + type: string + x-enum: + - DELEGATE + - 'ON' description: >- - Setting value for operational_email_custom_recipient - setting. This is the setting value set by consumers, - check effective_operational_email_custom_recipient for - final setting value. - personal_compute: - type: object - properties: - value: - type: string - x-enum: - - DELEGATE - - 'ON' - description: >- - ON: Grants all users in all workspaces access to the - Personal Compute default policy, allowing + ON: Grants all users in all workspaces access to the + Personal Compute default policy, allowing - all users to create single-machine compute - resources. DELEGATE: Moves access control for the + all users to create single-machine compute resources. + DELEGATE: Moves access control for the - Personal Compute default policy to individual - workspaces and requires a workspace’s users or + Personal Compute default policy to individual workspaces + and requires a workspace’s users or - groups to be added to the ACLs of that workspace’s - Personal Compute default policy before they + groups to be added to the ACLs of that workspace’s + Personal Compute default policy before they - will be able to create compute resources through - that policy. + will be able to create compute resources through that + policy. + description: >- + Setting value for personal_compute setting. This is the + setting value set by consumers, check + effective_personal_compute for final setting value. + restrict_workspace_admins: + type: object + properties: + status: + type: string + x-enum: + - ALLOW_ALL + - RESTRICT_TOKENS_AND_JOB_RUN_AS description: >- - Setting value for personal_compute setting. This is the - setting value set by consumers, check - effective_personal_compute for final setting value. - restrict_workspace_admins: - type: object - properties: - status: - type: string - x-enum: - - ALLOW_ALL - - RESTRICT_TOKENS_AND_JOB_RUN_AS - description: >- - Create a collection of name/value pairs. + Create a collection of name/value pairs. - Example enumeration: + Example enumeration: - >>> class Color(Enum): + >>> class Color(Enum): - ... RED = 1 + ... RED = 1 - ... BLUE = 2 + ... BLUE = 2 - ... GREEN = 3 + ... GREEN = 3 - Access them by: + Access them by: - - attribute access: + - attribute access: - >>> Color.RED - + >>> Color.RED + - - value lookup: + - value lookup: - >>> Color(1) - + >>> Color(1) + - - name lookup: + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + - Enumerations can be iterated over, and know how many - members they have: + Enumerations can be iterated over, and know how many + members they have: - >>> len(Color) + >>> len(Color) - 3 + 3 - >>> list(Color) + >>> list(Color) - [, , ] + [, , ] - Methods can be added to enumerations, and members - can have their own + Methods can be added to enumerations, and members can + have their own - attributes -- see the documentation for details. - disable_gov_tag_creation: - type: boolean - description: >- - When true, workspace admins cannot create governance - tags. ALLOW_ALL status does not override this; they - are independent. - required: - - status - description: >- - Setting value for restrict_workspace_admins setting. - This is the setting value set by consumers, check - effective_restrict_workspace_admins for final setting - value. - string_val: - type: object - properties: - value: - type: string + attributes -- see the documentation for details. + disable_gov_tag_creation: + type: boolean description: >- - Setting value for string type setting. This is the - setting value set by consumers, check - effective_string_val for final setting value. - required: - - setting + When true, workspace admins cannot create governance + tags. ALLOW_ALL status does not override this; they are + independent. + required: + - status + description: >- + Setting value for restrict_workspace_admins setting. This is + the setting value set by consumers, check + effective_restrict_workspace_admins for final setting value. + string_val: + type: object + properties: + value: + type: string + description: >- + Setting value for string type setting. This is the setting + value set by consumers, check effective_string_val for final + setting value. + workspace_label: + type: object + properties: + color: + type: string + label: + type: string + description: >- + Setting value for workspace_label setting. This is the + setting value set by consumers, check + effective_workspace_label for final setting value. responses: '200': description: Success @@ -1280,19 +1285,6 @@ components: Controls which external collaboration platforms (Slack, Microsoft Teams) can connect to a workspace. Defaults to ALLOW_ALL. - GenieChatSharePolicy: - type: object - properties: - disable_make_chat_private: - type: boolean - disable_share_with_account_users: - type: boolean - description: >- - Workspace controls that restrict which Genie space chat sharing modes - are available to end - users. When disable_make_chat_private is true, users cannot make a Genie chat private. When - disable_share_with_account_users is true, users cannot share a Genie chat with all account - users. Defaults preserve current behavior (both false). IntegerMessage: type: object properties: @@ -1425,12 +1417,6 @@ components: Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity. - effective_genie_chat_share_policy: - $ref: '#/components/schemas/GenieChatSharePolicy' - description: >- - Effective setting value for genie_chat_share_policy setting. This is - the final effective value of setting. To set a value use - genie_chat_share_policy. effective_integer_val: $ref: '#/components/schemas/IntegerMessage' description: >- @@ -1459,12 +1445,12 @@ components: description: >- Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val. - genie_chat_share_policy: - $ref: '#/components/schemas/GenieChatSharePolicy' + effective_workspace_label: + $ref: '#/components/schemas/WorkspaceLabelMessage' description: >- - Setting value for genie_chat_share_policy setting. This is the - setting value set by consumers, check - effective_genie_chat_share_policy for final setting value. + Effective setting value for workspace_label setting. This is the + final effective value of setting. To set a value use + workspace_label. integer_val: $ref: '#/components/schemas/IntegerMessage' description: >- @@ -1498,6 +1484,12 @@ components: description: >- Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value. + workspace_label: + $ref: '#/components/schemas/WorkspaceLabelMessage' + description: >- + Setting value for workspace_label setting. This is the setting value + set by consumers, check effective_workspace_label for final setting + value. SettingsMetadata: type: object properties: @@ -1551,6 +1543,14 @@ components: individual user within an account. Unlike workspace or account settings that apply to all users, user preferences allow personal customization (e.g., UI theme, editor preferences) without affecting other users. + WorkspaceLabelMessage: + type: object + properties: + color: + type: string + label: + type: string + description: Workspace label and color for display (e.g. in account console). AibiDashboardEmbeddingAccessPolicyAccessPolicyType: type: string x-enum: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml b/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml index c4baff9a..625ca17f 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.sharing servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.1/unity-catalog/providers: post: @@ -37,9 +54,6 @@ paths: :param comment: str (optional) Description about the provider. - :param email_recipient_id: str (optional) - The ID of the email recipient this provider is being created to accept. Only valid on DATABRICKS - CreateProvider when accepting an email invite. :param recipient_profile_str: str (optional) This field is required when the **authentication_type** is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided. @@ -58,7 +72,6 @@ paths: type: string x-enum: - DATABRICKS - - EMAIL - OAUTH_CLIENT_CREDENTIALS - OIDC_FEDERATION - TOKEN @@ -66,12 +79,6 @@ paths: comment: type: string description: Description about the provider. - email_recipient_id: - type: string - description: >- - The ID of the email recipient this provider is being created - to accept. Only valid on DATABRICKS CreateProvider when - accepting an email invite. recipient_profile_str: type: string description: >- @@ -532,9 +539,6 @@ paths: :param activation_url: str The one time activation url. It also accepts activation token. - :param metastore_id: str (optional) - The provider metastore ID. Optional for now; used as a routing hint when present and principal - context parameters: - name: activation_url in: path @@ -542,14 +546,6 @@ paths: schema: type: string description: The one time activation url. It also accepts activation token. - - name: metastore_id - in: query - required: false - schema: - type: string - description: >- - The provider metastore ID. Optional for now; used as a routing hint - when present and principal context responses: '200': description: Success @@ -581,9 +577,6 @@ paths: :param activation_url: str The one time activation url. It also accepts activation token. - :param metastore_id: str (optional) - The provider metastore ID. Optional for now; used as a routing hint when present and principal - context :returns: :class:`RetrieveTokenResponse` parameters: @@ -593,14 +586,6 @@ paths: schema: type: string description: The one time activation url. It also accepts activation token. - - name: metastore_id - in: query - required: false - schema: - type: string - description: >- - The provider metastore ID. Optional for now; used as a routing hint - when present and principal context responses: '200': description: Success @@ -697,93 +682,81 @@ paths: schema: type: object properties: - policy: + comment: + type: string + create_time: + type: string + description: >- + System-generated timestamp indicating when the policy was + created. + id: + type: string + description: >- + Unique, immutable system-generated identifier for the + federation policy. + name: + type: string + description: >- + Name of the federation policy. A recipient can have multiple + policies with different names. The name must contain only + lowercase alphanumeric characters, numbers, and hyphens. + oidc_policy: type: object properties: - comment: - type: string - create_time: + issuer: type: string description: >- - System-generated timestamp indicating when the policy - was created. - id: + The required token issuer, as specified in the 'iss' + claim of federated tokens. + subject_claim: type: string description: >- - Unique, immutable system-generated identifier for the - federation policy. - name: + The claim that contains the subject of the token. + Depending on the identity provider and the use case (U2M + or M2M), this can vary: - For Entra ID (AAD): - U2M flow + (group access): Use ``groups``. - U2M flow (user + access): Use ``oid``. - M2M flow (OAuth App access): Use + ``azp``. - For other IdPs, refer to the specific IdP + documentation. Supported ``subject_claim`` values are: - + ``oid``: Object ID of the user. - ``azp``: Client ID of + the OAuth app. - ``groups``: Object ID of the group. - + ``sub``: Subject identifier for other use cases. + subject: type: string description: >- - Name of the federation policy. A recipient can have - multiple policies with different names. The name must - contain only lowercase alphanumeric characters, numbers, - and hyphens. - oidc_policy: - type: object - properties: - issuer: - type: string - description: >- - The required token issuer, as specified in the 'iss' - claim of federated tokens. - subject_claim: - type: string - description: >- - The claim that contains the subject of the token. - Depending on the identity provider and the use case - (U2M or M2M), this can vary: - For Entra ID (AAD): - - U2M flow (group access): Use ``groups``. - U2M flow - (user access): Use ``oid``. - M2M flow (OAuth App - access): Use ``azp``. - For other IdPs, refer to the - specific IdP documentation. Supported - ``subject_claim`` values are: - ``oid``: Object ID - of the user. - ``azp``: Client ID of the OAuth app. - - ``groups``: Object ID of the group. - ``sub``: - Subject identifier for other use cases. - subject: - type: string - description: >- - The required token subject, as specified in the - subject claim of federated tokens. The subject claim - identifies the identity of the user or machine - accessing the resource. Examples for Entra ID (AAD): - - U2M flow (group access): If the subject claim is - ``groups``, this must be the Object ID of the group - in Entra ID. - U2M flow (user access): If the - subject claim is ``oid``, this must be the Object ID - of the user in Entra ID. - M2M flow (OAuth App - access): If the subject claim is ``azp``, this must - be the client ID of the OAuth app registered in - Entra ID. - audiences: - type: array - items: - type: string - description: >- - The allowed token audiences, as specified in the - 'aud' claim of federated tokens. The audience - identifier is intended to represent the recipient of - the token. Can be any non-empty string value. As - long as the audience in the token matches at least - one audience in the policy, - required: - - issuer - - subject_claim - - subject - description: >- - Specifies the policy to use for validating OIDC claims - in the federated tokens. - update_time: - type: string + The required token subject, as specified in the subject + claim of federated tokens. The subject claim identifies + the identity of the user or machine accessing the + resource. Examples for Entra ID (AAD): - U2M flow (group + access): If the subject claim is ``groups``, this must + be the Object ID of the group in Entra ID. - U2M flow + (user access): If the subject claim is ``oid``, this + must be the Object ID of the user in Entra ID. - M2M + flow (OAuth App access): If the subject claim is + ``azp``, this must be the client ID of the OAuth app + registered in Entra ID. + audiences: + type: array + items: + type: string description: >- - System-generated timestamp indicating when the policy - was last updated. + The allowed token audiences, as specified in the 'aud' + claim of federated tokens. The audience identifier is + intended to represent the recipient of the token. Can be + any non-empty string value. As long as the audience in + the token matches at least one audience in the policy, + required: + - issuer + - subject_claim + - subject description: >- - Name of the policy. This is the name of the policy to be - created. - required: - - policy + Specifies the policy to use for validating OIDC claims in + the federated tokens. + update_time: + type: string + description: >- + System-generated timestamp indicating when the policy was + last updated. responses: '200': description: Success @@ -971,174 +944,6 @@ paths: message: type: string x-stackql-sdk-source: RecipientFederationPoliciesAPI - patch: - operationId: recipient_federation_policies_update - summary: >- - Updates an existing federation policy for an OIDC_RECIPIENT. The caller - must be the owner of the - tags: - - sharing - - recipient_federation_policies - description: >- - Updates an existing federation policy for an OIDC_RECIPIENT. The caller - must be the owner of the - - recipient. - - - :param recipient_name: str - Name of the recipient. This is the name of the recipient for which the policy is being updated. - :param name: str - Name of the policy. This is the name of the current name of the policy. - :param policy: :class:`FederationPolicy` - - :param update_mask: str (optional) - The field mask specifies which fields of the policy to update. To specify multiple fields in the - field mask, use comma as the separator (no space). The special value '*' indicates that all fields - should be updated (full replacement). If unspecified, all fields that are set in the policy provided - in the update request will overwrite the corresponding fields in the existing policy. Example value: - 'comment,oidc_policy.audiences'. - - :returns: :class:`FederationPolicy` - parameters: - - name: recipient_name - in: path - required: true - schema: - type: string - description: >- - Name of the recipient. This is the name of the recipient for which - the policy is being updated. - - name: name - in: path - required: true - schema: - type: string - description: >- - Name of the policy. This is the name of the current name of the - policy. - - name: update_mask - in: query - required: false - schema: - type: string - description: >- - The field mask specifies which fields of the policy to update. To - specify multiple fields in the field mask, use comma as the - separator (no space). The special value '*' indicates that all - fields should be updated (full replacement). If unspecified, all - fields that are set in the policy provided in the update request - will overwrite the corresponding fields in the existing policy. - Example value: 'comment,oidc_policy.audiences'. - requestBody: - content: - application/json: - schema: - type: object - properties: - policy: - type: object - properties: - comment: - type: string - create_time: - type: string - description: >- - System-generated timestamp indicating when the policy - was created. - id: - type: string - description: >- - Unique, immutable system-generated identifier for the - federation policy. - name: - type: string - description: >- - Name of the federation policy. A recipient can have - multiple policies with different names. The name must - contain only lowercase alphanumeric characters, numbers, - and hyphens. - oidc_policy: - type: object - properties: - issuer: - type: string - description: >- - The required token issuer, as specified in the 'iss' - claim of federated tokens. - subject_claim: - type: string - description: >- - The claim that contains the subject of the token. - Depending on the identity provider and the use case - (U2M or M2M), this can vary: - For Entra ID (AAD): - - U2M flow (group access): Use ``groups``. - U2M flow - (user access): Use ``oid``. - M2M flow (OAuth App - access): Use ``azp``. - For other IdPs, refer to the - specific IdP documentation. Supported - ``subject_claim`` values are: - ``oid``: Object ID - of the user. - ``azp``: Client ID of the OAuth app. - - ``groups``: Object ID of the group. - ``sub``: - Subject identifier for other use cases. - subject: - type: string - description: >- - The required token subject, as specified in the - subject claim of federated tokens. The subject claim - identifies the identity of the user or machine - accessing the resource. Examples for Entra ID (AAD): - - U2M flow (group access): If the subject claim is - ``groups``, this must be the Object ID of the group - in Entra ID. - U2M flow (user access): If the - subject claim is ``oid``, this must be the Object ID - of the user in Entra ID. - M2M flow (OAuth App - access): If the subject claim is ``azp``, this must - be the client ID of the OAuth app registered in - Entra ID. - audiences: - type: array - items: - type: string - description: >- - The allowed token audiences, as specified in the - 'aud' claim of federated tokens. The audience - identifier is intended to represent the recipient of - the token. Can be any non-empty string value. As - long as the audience in the token matches at least - one audience in the policy, - required: - - issuer - - subject_claim - - subject - description: >- - Specifies the policy to use for validating OIDC claims - in the federated tokens. - update_time: - type: string - description: >- - System-generated timestamp indicating when the policy - was last updated. - required: - - policy - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/FederationPolicy' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: RecipientFederationPoliciesAPI /api/2.1/unity-catalog/recipients: post: operationId: recipients_create @@ -1160,25 +965,12 @@ paths: Name of Recipient. :param authentication_type: :class:`AuthenticationType` - :param allowed_acceptance_types: List[:class:`AuthenticationType`] - (optional) - Authentication types the invitee may choose from when activating. Each value must be TOKEN or - DATABRICKS. Empty means all supported types are allowed. This field is only present when the - **authentication_type** is **EMAIL**. - :param allowed_data_recipient_global_metastore_ids: List[str] (optional) - Optional allowlist of the data recipient's global metastore IDs permitted to accept the invite with - the DATABRICKS acceptance type. Each ID is of the form **cloud**:**region**:**metastore-uuid**. - Empty means any metastore is allowed. If non-empty, **allowed_acceptance_types** must include - **DATABRICKS**. This field is only present when the **authentication_type** is **EMAIL**. :param comment: str (optional) Description about the recipient. :param data_recipient_global_metastore_id: str (optional) The global Unity Catalog metastore id provided by the data recipient. This field is only present when the **authentication_type** is **DATABRICKS**. The identifier is of format **cloud**:**region**:**metastore-uuid**. - :param email: str (optional) - The invited email address. This field is only present when the **authentication_type** is **EMAIL**. - The 320-character cap follows RFC 5321 (64-octet local-part + ``@`` + 255-octet domain). :param expiration_time: int (optional) Expiration timestamp of the token, in epoch milliseconds. :param id: str (optional) @@ -1210,40 +1002,10 @@ paths: type: string x-enum: - DATABRICKS - - EMAIL - OAUTH_CLIENT_CREDENTIALS - OIDC_FEDERATION - TOKEN description: The delta sharing authentication type. - allowed_acceptance_types: - type: array - items: - type: string - x-enum: - - DATABRICKS - - EMAIL - - OAUTH_CLIENT_CREDENTIALS - - OIDC_FEDERATION - - TOKEN - description: The delta sharing authentication type. - description: >- - Authentication types the invitee may choose from when - activating. Each value must be TOKEN or DATABRICKS. Empty - means all supported types are allowed. This field is only - present when the **authentication_type** is **EMAIL**. - allowed_data_recipient_global_metastore_ids: - type: array - items: - type: string - description: >- - Optional allowlist of the data recipient's global metastore - IDs permitted to accept the invite with the DATABRICKS - acceptance type. Each ID is of the form - **cloud**:**region**:**metastore-uuid**. Empty means any - metastore is allowed. If non-empty, - **allowed_acceptance_types** must include **DATABRICKS**. - This field is only present when the **authentication_type** - is **EMAIL**. comment: type: string description: Description about the recipient. @@ -1254,13 +1016,6 @@ paths: recipient. This field is only present when the **authentication_type** is **DATABRICKS**. The identifier is of format **cloud**:**region**:**metastore-uuid**. - email: - type: string - description: >- - The invited email address. This field is only present when - the **authentication_type** is **EMAIL**. The 320-character - cap follows RFC 5321 (64-octet local-part + ``@`` + - 255-octet domain). expiration_time: type: integer description: Expiration timestamp of the token, in epoch milliseconds. @@ -1354,10 +1109,6 @@ paths: next_page_token is unset from the response. :param page_token: str (optional) Opaque pagination token to go to next page based on previous query. - :param parent_recipient_name: str (optional) - If set, the response is scoped to the child recipients of the named parent recipient. Child - recipients are otherwise hidden from the default list response. Only applicable to email recipient - parents — non-email recipients have no children to scope to. :returns: Iterator over :class:`RecipientInfo` parameters: @@ -1391,16 +1142,6 @@ paths: schema: type: string description: Opaque pagination token to go to next page based on previous query. - - name: parent_recipient_name - in: query - required: false - schema: - type: string - description: >- - If set, the response is scoped to the child recipients of the named - parent recipient. Child recipients are otherwise hidden from the - default list response. Only applicable to email recipient parents — - non-email recipients have no children to scope to. responses: '200': description: Success @@ -1521,21 +1262,8 @@ paths: :param name: str Name of the recipient. - :param allowed_acceptance_types: List[:class:`AuthenticationType`] - (optional) - Authentication types the invitee may choose from when activating. Each value must be TOKEN or - DATABRICKS. Empty means all supported types are allowed. This field is only present when the - **authentication_type** is **EMAIL**. - :param allowed_data_recipient_global_metastore_ids: List[str] (optional) - Optional allowlist of the data recipient's global metastore IDs permitted to accept the invite with - the DATABRICKS acceptance type. Each ID is of the form **cloud**:**region**:**metastore-uuid**. - Empty means any metastore is allowed. If non-empty, **allowed_acceptance_types** must include - **DATABRICKS**. This field is only present when the **authentication_type** is **EMAIL**. :param comment: str (optional) Description about the recipient. - :param email: str (optional) - The invited email address. This field is only present when the **authentication_type** is **EMAIL**. - The 320-character cap follows RFC 5321 (64-octet local-part + ``@`` + 255-octet domain). :param expiration_time: int (optional) Expiration timestamp of the token, in epoch milliseconds. :param id: str (optional) @@ -1566,45 +1294,9 @@ paths: schema: type: object properties: - allowed_acceptance_types: - type: array - items: - type: string - x-enum: - - DATABRICKS - - EMAIL - - OAUTH_CLIENT_CREDENTIALS - - OIDC_FEDERATION - - TOKEN - description: The delta sharing authentication type. - description: >- - Authentication types the invitee may choose from when - activating. Each value must be TOKEN or DATABRICKS. Empty - means all supported types are allowed. This field is only - present when the **authentication_type** is **EMAIL**. - allowed_data_recipient_global_metastore_ids: - type: array - items: - type: string - description: >- - Optional allowlist of the data recipient's global metastore - IDs permitted to accept the invite with the DATABRICKS - acceptance type. Each ID is of the form - **cloud**:**region**:**metastore-uuid**. Empty means any - metastore is allowed. If non-empty, - **allowed_acceptance_types** must include **DATABRICKS**. - This field is only present when the **authentication_type** - is **EMAIL**. comment: type: string description: Description about the recipient. - email: - type: string - description: >- - The invited email address. This field is only present when - the **authentication_type** is **EMAIL**. The 320-character - cap follows RFC 5321 (64-octet local-part + ``@`` + - 255-octet domain). expiration_time: type: integer description: Expiration timestamp of the token, in epoch milliseconds. @@ -1825,11 +1517,6 @@ paths: Name of the share. :param comment: str (optional) User-provided free-form text description. - :param replication_config: :class:`ReplicationConfig` (optional) - Configuration for share replication. - :param serverless_budget_policy_id: str (optional) - Serverless budget policy id (can only be created/updated when calling data-sharing service) - [Create,Update:IGN] :param storage_root: str (optional) Storage root URL for the share. @@ -1846,32 +1533,6 @@ paths: comment: type: string description: User-provided free-form text description. - replication_config: - type: object - properties: - enabled: - type: boolean - description: Whether replication is enabled for the share. - schedule: - type: object - properties: - interval: - type: object - properties: - duration: - type: string - description: How often the share's data should be replicated. - description: Fixed-interval replication schedule. - description: >- - Optional schedule describing how often replication runs - for this share. When unset, replication runs on a - service-default schedule. - description: Configuration for share replication. - serverless_budget_policy_id: - type: string - description: >- - Serverless budget policy id (can only be created/updated - when calling data-sharing service) [Create,Update:IGN] storage_root: type: string description: Storage root URL for the share. @@ -1914,11 +1575,6 @@ paths: is no guarantee of a specific ordering of the elements in the array. - :param filter_by_genie_space_id: str (optional) - When set, only shares that contain the Genie space with this id are returned. The filter is applied - at the data-sharing layer after MC returns the page, so the resulting page may be smaller than - ``max_results``. Intended for the provider Genie space page's "Shared with N recipients" lookup; not - optimized for providers with many shares. :param max_results: int (optional) Maximum number of shares to return. @@ -1935,18 +1591,6 @@ paths: :returns: Iterator over :class:`ShareInfo` parameters: - - name: filter_by_genie_space_id - in: query - required: false - schema: - type: string - description: >- - When set, only shares that contain the Genie space with this id are - returned. The filter is applied at the data-sharing layer after MC - returns the page, so the resulting page may be smaller than - ``max_results``. Intended for the provider Genie space page's - "Shared with N recipients" lookup; not optimized for providers with - many shares. - name: max_results in: query required: false @@ -2127,9 +1771,6 @@ paths: New name for the share. :param owner: str (optional) Username of current owner of share. - :param serverless_budget_policy_id: str (optional) - Serverless budget policy id (can only be created/updated when calling data-sharing service) - [Create,Update:IGN] :param storage_root: str (optional) Storage root URL for the share. :param updates: List[:class:`SharedDataObjectUpdate`] (optional) @@ -2158,11 +1799,6 @@ paths: owner: type: string description: Username of current owner of share. - serverless_budget_policy_id: - type: string - description: >- - Serverless budget policy id (can only be created/updated - when calling data-sharing service) [Create,Update:IGN] storage_root: type: string description: Storage root URL for the share. @@ -2275,79 +1911,6 @@ paths: - VIEW - VOLUME description: The type of the data object. - global_distribution_status: - type: object - properties: - eligible: - type: boolean - description: >- - Whether this asset meets the structural - requirements for global distribution (e.g. - asset type, history sharing mode, storage - scheme). - status: - type: string - x-enum: - - DISABLED - - ENABLED - description: >- - Create a collection of name/value pairs. - - - Example enumeration: - - - >>> class Color(Enum): - - ... RED = 1 - - ... BLUE = 2 - - ... GREEN = 3 - - - Access them by: - - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know - how many members they have: - - - >>> len(Color) - - 3 - - - >>> list(Color) - - [, , - ] - - - Methods can be added to enumerations, and - members can have their own - - attributes -- see the documentation for - details. - description: >- - Global Distribution status for the shared asset. - Output only. Only set for TABLE objects; absent - for all other data object types. history_data_sharing_status: type: string x-enum: @@ -2640,17 +2203,6 @@ paths: The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time. - principal_id: - type: integer - description: >- - An opaque internal ID that identifies the principal - whose privileges should be removed. This field is - intended for removing privileges associated with a - deleted user. When set, only the entries specified in - the remove field are processed; any entries in the add - field will be rejected. Only one of principal or - principal_id should be specified, never both at the - same time. remove: type: array items: @@ -2870,18 +2422,6 @@ components: items: $ref: '#/components/schemas/PrivilegeAssignment' description: The privileges assigned to each principal - GlobalDistributionStatus: - type: object - properties: - eligible: - type: boolean - description: >- - Whether this asset meets the structural requirements for global - distribution (e.g. asset type, history sharing mode, storage - scheme). - status: - $ref: '#/components/schemas/GlobalDistributionStatusStatus' - description: Status of Global Distribution for a shared asset. IpAccessList: type: object properties: @@ -3077,15 +2617,6 @@ components: The principal whose privileges we are changing. Only one of principal or principal_id should be specified, never both at the same time. - principal_id: - type: integer - description: >- - An opaque internal ID that identifies the principal whose privileges - should be removed. This field is intended for removing privileges - associated with a deleted user. When set, only the entries specified - in the remove field are processed; any entries in the add field will - be rejected. Only one of principal or principal_id should be - specified, never both at the same time. remove: type: array items: @@ -3096,11 +2627,6 @@ components: properties: principal: type: string - principal_id: - type: integer - description: >- - Unique identifier of the principal. For active principals, both - ``principal`` and ``principal_id`` are present. privileges: type: array items: @@ -3131,12 +2657,6 @@ components: The global UC metastore id of the data provider. This field is only present when the **authentication_type** is **DATABRICKS**. The identifier is of format **cloud**:**region**:**metastore-uuid**. - email_recipient_id: - type: string - description: >- - The ID of the email recipient this provider is being created to - accept. Only valid on DATABRICKS CreateProvider when accepting an - email invite. metastore_id: type: string description: >- @@ -3184,26 +2704,6 @@ components: description: >- Full activation url to retrieve the access token. It will be empty if the token is already retrieved. - allowed_acceptance_types: - type: array - items: - $ref: '#/components/schemas/AuthenticationType' - description: >- - Authentication types the invitee may choose from when activating. - Each value must be TOKEN or DATABRICKS. Empty means all supported - types are allowed. This field is only present when the - **authentication_type** is **EMAIL**. - allowed_data_recipient_global_metastore_ids: - type: array - items: - type: string - description: >- - Optional allowlist of the data recipient's global metastore IDs - permitted to accept the invite with the DATABRICKS acceptance type. - Each ID is of the form **cloud**:**region**:**metastore-uuid**. - Empty means any metastore is allowed. If non-empty, - **allowed_acceptance_types** must include **DATABRICKS**. This field - is only present when the **authentication_type** is **EMAIL**. authentication_type: $ref: '#/components/schemas/AuthenticationType' cloud: @@ -3227,12 +2727,6 @@ components: recipient. This field is only present when the **authentication_type** is **DATABRICKS**. The identifier is of format **cloud**:**region**:**metastore-uuid**. - email: - type: string - description: >- - The invited email address. This field is only present when the - **authentication_type** is **EMAIL**. The 320-character cap follows - RFC 5321 (64-octet local-part + ``@`` + 255-octet domain). expiration_time: type: integer description: Expiration timestamp of the token, in epoch milliseconds. @@ -3329,43 +2823,6 @@ components: version_num: type: integer description: Numeric model version that alias will reference. - ReplicationConfig: - type: object - properties: - enabled: - type: boolean - description: Whether replication is enabled for the share. - schedule: - $ref: '#/components/schemas/ReplicationSchedule' - description: >- - Optional schedule describing how often replication runs for this - share. When unset, replication runs on a service-default schedule. - description: >- - Configuration for Delta Sharing replication on a share. When enabled, - the share's data is copied - into each recipient's region so recipients can query the share locally. - ReplicationInterval: - type: object - properties: - duration: - type: string - description: How often the share's data should be replicated. - description: >- - Fixed-interval replication schedule variant. The duration must be - between 30 minutes and 24 - hours; values outside that range are rejected at the API boundary. - ReplicationSchedule: - type: object - properties: - interval: - $ref: '#/components/schemas/ReplicationInterval' - description: Fixed-interval replication schedule. - description: >- - Schedule for share replication. Today only a fixed ``interval`` variant - is supported; the - ``variant`` oneof leaves room for future variants (e.g. cron) without API churn. Each arm is - wrapped in a sub-message so variant-specific metadata (e.g. jitter, drift tolerance, timezone) - can be added later without breaking the wire format. RetrieveTokenResponse: type: object properties: @@ -3420,14 +2877,6 @@ components: owner: type: string description: Username of current owner of share. - replication_config: - $ref: '#/components/schemas/ReplicationConfig' - description: Configuration for share replication. - serverless_budget_policy_id: - type: string - description: >- - Serverless budget policy id (can only be created/updated when - calling data-sharing service) [Create,Update:IGN] storage_location: type: string description: Storage Location URL (full path) for the share. @@ -3480,11 +2929,6 @@ components: data_object_type: $ref: '#/components/schemas/SharedDataObjectDataObjectType' description: The type of the data object. - global_distribution_status: - $ref: '#/components/schemas/GlobalDistributionStatus' - description: >- - Global Distribution status for the shared asset. Output only. Only - set for TABLE objects; absent for all other data object types. history_data_sharing_status: $ref: '#/components/schemas/SharedDataObjectHistoryDataSharingStatus' description: >- @@ -3572,19 +3016,11 @@ components: Table: type: object properties: - accessModes: - type: array - items: - type: string comment: type: string - description: The comment of the table. id: type: string description: The id of the table. - location: - type: string - description: The cloud storage location of the table for open sharing. materialization_namespace: type: string description: The catalog and schema of the materialized table @@ -3643,7 +3079,6 @@ components: type: string x-enum: - DATABRICKS - - EMAIL - OAUTH_CLIENT_CREDENTIALS - OIDC_FEDERATION - TOKEN @@ -3660,8 +3095,6 @@ components: - DECIMAL - DOUBLE - FLOAT - - GEOGRAPHY - - GEOMETRY - INT - INTERVAL - LONG @@ -3762,48 +3195,6 @@ components: >>> list(Color) [, , ] - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - GlobalDistributionStatusStatus: - type: string - x-enum: - - DISABLED - - ENABLED - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. PartitionValueOp: @@ -4274,16 +3665,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - recipient_federation_policies_update: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1data-sharing~1recipients~1{recipient_name}~1federation-policies~1{name}/patch - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -4293,9 +3674,7 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/recipient_federation_policies/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/recipient_federation_policies/methods/recipient_federation_policies_update + update: [] delete: - $ref: >- #/components/x-stackQL-resources/recipient_federation_policies/methods/delete diff --git a/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml b/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml index a09ffd15..89496a25 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml @@ -6,14 +6,31 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.sql servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/sql/alerts: post: @@ -952,21 +969,106 @@ paths: schema: type: object properties: - alert: + display_name: + type: string + query_text: + type: string + description: Text of the query to be run. + warehouse_id: + type: string + description: ID of the SQL warehouse attached to the alert. + evaluation: type: object properties: - display_name: + source: + type: object + properties: + name: + type: string + aggregation: + type: string + x-enum: + - AVG + - COUNT + - COUNT_DISTINCT + - MAX + - MEDIAN + - MIN + - STDDEV + - SUM + description: >- + If not set, the behavior is equivalent to using + ``First row`` in the UI. + display: + type: string + required: + - name + comparison_operator: type: string - query_text: + x-enum: + - EQUAL + - GREATER_THAN + - GREATER_THAN_OR_EQUAL + - IS_NOT_NULL + - IS_NULL + - LESS_THAN + - LESS_THAN_OR_EQUAL + - NOT_EQUAL + description: Operator used for comparison in alert evaluation. + empty_result_state: type: string - description: Text of the query to be run. - warehouse_id: + x-enum: + - ERROR + - OK + - TRIGGERED + - UNKNOWN + description: >- + Alert state if result is empty. Please avoid setting + this field to be ``UNKNOWN`` because ``UNKNOWN`` state + is planned to be deprecated. + last_evaluated_at: + type: string + description: Timestamp of the last evaluation. + notification: + type: object + properties: + notify_on_ok: + type: boolean + retrigger_seconds: + type: integer + description: >- + Number of seconds an alert waits after being + triggered before it is allowed to send another + notification. If set to 0 or omitted, the alert will + not send any further notifications after the first + trigger Setting this value to 1 allows the alert to + send a notification on every evaluation where the + condition is met, effectively making it always + retrigger for notification purposes. + subscriptions: + type: array + items: + type: object + properties: + destination_id: + type: string + user_email: + type: string + description: >- + User or Notification Destination to notify when alert is + triggered. + state: type: string - description: ID of the SQL warehouse attached to the alert. - evaluation: + x-enum: + - ERROR + - OK + - TRIGGERED + - UNKNOWN + description: Latest state of alert evaluation. + threshold: type: object properties: - source: + column: type: object properties: name: @@ -989,268 +1091,190 @@ paths: type: string required: - name - comparison_operator: - type: string - x-enum: - - EQUAL - - GREATER_THAN - - GREATER_THAN_OR_EQUAL - - IS_NOT_NULL - - IS_NULL - - LESS_THAN - - LESS_THAN_OR_EQUAL - - NOT_EQUAL - description: Operator used for comparison in alert evaluation. - empty_result_state: - type: string - x-enum: - - ERROR - - OK - - TRIGGERED - - UNKNOWN - description: >- - Alert state if result is empty. Please avoid setting - this field to be ``UNKNOWN`` because ``UNKNOWN`` - state is planned to be deprecated. - last_evaluated_at: - type: string - description: Timestamp of the last evaluation. - notification: + value: type: object properties: - notify_on_ok: + bool_value: type: boolean - retrigger_seconds: - type: integer - description: >- - Number of seconds an alert waits after being - triggered before it is allowed to send another - notification. If set to 0 or omitted, the alert - will not send any further notifications after - the first trigger Setting this value to 1 allows - the alert to send a notification on every - evaluation where the condition is met, - effectively making it always retrigger for - notification purposes. - subscriptions: - type: array - items: - type: object - properties: - destination_id: - type: string - user_email: - type: string - description: >- - User or Notification Destination to notify when - alert is triggered. - state: - type: string - x-enum: - - ERROR - - OK - - TRIGGERED - - UNKNOWN - description: Latest state of alert evaluation. - threshold: - type: object - properties: - column: - type: object - properties: - name: - type: string - aggregation: - type: string - x-enum: - - AVG - - COUNT - - COUNT_DISTINCT - - MAX - - MEDIAN - - MIN - - STDDEV - - SUM - description: >- - If not set, the behavior is equivalent to - using ``First row`` in the UI. - display: - type: string - required: - - name - value: - type: object - properties: - bool_value: - type: boolean - double_value: - type: number - string_value: - type: string - description: >- - Threshold to user for alert evaluation, can be a - column or a value. - required: - - source - - comparison_operator - schedule: - type: object - properties: - quartz_cron_schedule: - type: string - timezone_id: - type: string - description: >- - A Java timezone id. The schedule will be resolved - using this timezone. This will be combined with the - quartz_cron_schedule to determine the schedule. See - https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html - for details. - effective_pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: >- - The actual pause status of the schedule. This is an - output-only field. - pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: Indicate whether this schedule is paused or not. - required: - - quartz_cron_schedule - - timezone_id - create_time: - type: string - description: The timestamp indicating when the alert was created. - custom_description: - type: string + double_value: + type: number + string_value: + type: string description: >- - Custom description for the alert. support mustache - template. - custom_summary: + Threshold to user for alert evaluation, can be a column + or a value. + required: + - source + - comparison_operator + schedule: + type: object + properties: + quartz_cron_schedule: type: string - description: Custom summary for the alert. support mustache template. - effective_parent_path: + timezone_id: type: string description: >- - The actual workspace path of the folder containing the - alert. This is an output-only field. - effective_run_as: - type: object - properties: - service_principal_name: - type: string - user_name: - type: string - description: >- - The email of an active workspace user. Can only set - this field to their own email. - description: >- - The actual identity that will be used to execute the - alert. This is an output-only field that shows the - resolved run-as identity after applying permissions and - defaults. - id: - type: string - description: UUID identifying the alert. - lifecycle_state: + A Java timezone id. The schedule will be resolved using + this timezone. This will be combined with the + quartz_cron_schedule to determine the schedule. See + https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html + for details. + pause_status: type: string x-enum: - - ACTIVE - - DELETED - description: Indicates whether the query is trashed. - owner_user_name: + - PAUSED + - UNPAUSED + description: Indicate whether this schedule is paused or not. + required: + - quartz_cron_schedule + - timezone_id + create_time: + type: string + description: The timestamp indicating when the alert was created. + custom_description: + type: string + description: >- + Custom description for the alert. Interpreted according to + ``custom_template_format``. + custom_summary: + type: string + description: >- + Custom summary for the alert. Interpreted according to + ``custom_template_format``. + custom_template_format: + type: string + x-enum: + - HTML + - MARKDOWN + description: >- + The format used to interpret the ``custom_summary`` and + ``custom_description`` templates. ``HTML`` treats both + templates as HTML with Mustache ``{{VARIABLE_NAME}}`` + placeholders. ``MARKDOWN`` treats them as Markdown with + allowlisted ``@VARIABLE_NAME`` placeholders and converts + them to the format each notification destination expects, so + a single template renders correctly in email, Slack, and + Microsoft Teams. When unset, the API applies no default. + Responses omit the field unless a format is stored, and a + template with no format is rendered as HTML. + effective_run_as: + type: object + properties: + service_principal_name: + type: string + user_name: type: string description: >- - The owner's username. This field is set to "Unavailable" - if the user has been deleted. - parameters: - type: array - items: - type: object - properties: - name: - type: string - description: >- - The name of the parameter, referenced in the query - as ``:name``. - type: - type: string - description: >- - The SQL data type of the parameter, e.g. STRING, - INT, or DATE. Defaults to STRING. This is a string - rather than an enum because scalar subtypes such - as DECIMAL(10, 4) cannot be enumerated. Complex - types such as ARRAY, MAP, and STRUCT are not - supported. - value: - type: string - description: >- - The bound value for the parameter, given as a - string. If omitted, the value is interpreted as - NULL. - required: - - name + The email of an active workspace user. Can only set this + field to their own email. + description: >- + The actual identity that will be used to execute the alert. + This is an output-only field that shows the resolved run-as + identity after applying permissions and defaults. + id: + type: string + description: >- + The canonical identifier of the alert to retrieve + information about. + lifecycle_state: + type: string + x-enum: + - ACTIVE + - DELETED + description: Indicates whether the query is trashed. + owner_user_name: + type: string + description: >- + The owner's username. This field is set to "Unavailable" if + the user has been deleted. + parameters: + type: array + items: + type: object + properties: + name: + type: string description: >- - Redash-owned copy of the internal StatementParameter - for the external AlertV2 API. The internal - ``ordinal`` and ``args`` fields are intentionally omitted: the public API supports only flat, - named scalar parameters; complex types (ARRAY, MAP, STRUCT) are not supported. This mirrors - SEA's public StatementParameter schema, see: - cmdexec/sql-exec-api/proto/sql_exec_api_service.proto:763-779 - description: >- - Query parameters bound when executing the alert query, - referenced in the query text with ``:name`` syntax. - Static values only. - parent_path: + The name of the parameter. Reference it in the query + text as ``:name``. Required, must be non-empty, and + must be unique across the alert's parameters. + type: + type: string + description: >- + The SQL data type of the parameter, for example + ``STRING``, ``INT``, or ``DECIMAL(10, 2)``. If no type + is given the type is assumed to be ``STRING``. Complex + types such as ``ARRAY``, ``MAP``, and ``STRUCT`` are + not supported. + value: + type: string + description: >- + The value bound to the parameter, represented as a + string. If omitted, the value is interpreted as NULL. + required: + - name + description: >- + A named parameter bound to the alert query. Only flat, + named scalar parameters are supported; + complex types such as ARRAY, MAP, and STRUCT are not. + description: >- + A list of parameters to pass into the alert SQL query + statement containing parameter markers. Static values only. + Reference a parameter in the query text as ``:name``. Each + parameter must have a unique, non-empty name. Each parameter + consists of a name, a value, and optionally a type. To + represent a NULL value, the ``value`` field may be omitted + or set to ``null`` explicitly. If the ``type`` field is + omitted, the value is interpreted as a string. If the type + is given, parameters will be checked for type correctness + according to the given type. A value is correct if the + provided string can be converted to the requested type using + the ``cast`` function. The exact semantics are described in + the section `cast function + `__ + of the SQL language reference. + parent_path: + type: string + description: >- + The workspace path of the folder containing the alert. Can + only be set on create, and cannot be updated. + run_as: + type: object + properties: + service_principal_name: type: string - description: >- - The workspace path of the folder containing the alert. - Can only be set on create, and cannot be updated. - run_as: - type: object - properties: - service_principal_name: - type: string - user_name: - type: string - description: >- - The email of an active workspace user. Can only set - this field to their own email. - description: >- - Specifies the identity that will be used to run the - alert. This field allows you to configure alerts to run - as a specific user or service principal. - For user - identity: Set ``user_name`` to the email of an active - workspace user. Users can only set this to their own - email. - For service principal: Set - ``service_principal_name`` to the application ID. - Requires the ``servicePrincipal/user`` role. If not - specified, the alert will run as the request user. - run_as_user_name: + user_name: type: string description: >- - The run as username or application ID of service - principal. On Create and Update, this field can be set - to application ID of an active service principal. - Setting this field requires the servicePrincipal/user - role. Deprecated: Use ``run_as`` field instead. This - field will be removed in a future release. - update_time: - type: string - description: The timestamp indicating when the alert was updated. - required: - - display_name - - query_text - - warehouse_id - - evaluation - - schedule + The email of an active workspace user. Can only set this + field to their own email. + description: >- + Specifies the identity that will be used to run the alert. + This field allows you to configure alerts to run as a + specific user or service principal. - For user identity: Set + ``user_name`` to the email of an active workspace user. + Users can only set this to their own email. - For service + principal: Set ``service_principal_name`` to the application + ID. Requires the ``servicePrincipal/user`` role. If not + specified, the alert will run as the request user. + run_as_user_name: + type: string + description: >- + The run as username or application ID of service principal. + On Create and Update, this field can be set to application + ID of an active service principal. Setting this field + requires the servicePrincipal/user role. Deprecated: Use + ``run_as`` field instead. This field will be removed in a + future release. + update_time: + type: string + description: The timestamp indicating when the alert was updated. required: - - alert + - display_name + - query_text + - warehouse_id + - evaluation + - schedule responses: '200': description: Success @@ -1412,7 +1436,7 @@ paths: Update alert :param id: str - UUID identifying the alert. + The canonical identifier of the alert to retrieve information about. :param alert: :class:`AlertV2` :param update_mask: str The field mask must be a single string, with multiple fields separated by commas (no spaces). The @@ -1432,7 +1456,7 @@ paths: required: true schema: type: string - description: UUID identifying the alert. + description: The canonical identifier of the alert to retrieve information about. - name: update_mask in: query required: true @@ -1455,21 +1479,106 @@ paths: schema: type: object properties: - alert: + display_name: + type: string + query_text: + type: string + description: Text of the query to be run. + warehouse_id: + type: string + description: ID of the SQL warehouse attached to the alert. + evaluation: type: object properties: - display_name: + source: + type: object + properties: + name: + type: string + aggregation: + type: string + x-enum: + - AVG + - COUNT + - COUNT_DISTINCT + - MAX + - MEDIAN + - MIN + - STDDEV + - SUM + description: >- + If not set, the behavior is equivalent to using + ``First row`` in the UI. + display: + type: string + required: + - name + comparison_operator: type: string - query_text: + x-enum: + - EQUAL + - GREATER_THAN + - GREATER_THAN_OR_EQUAL + - IS_NOT_NULL + - IS_NULL + - LESS_THAN + - LESS_THAN_OR_EQUAL + - NOT_EQUAL + description: Operator used for comparison in alert evaluation. + empty_result_state: type: string - description: Text of the query to be run. - warehouse_id: + x-enum: + - ERROR + - OK + - TRIGGERED + - UNKNOWN + description: >- + Alert state if result is empty. Please avoid setting + this field to be ``UNKNOWN`` because ``UNKNOWN`` state + is planned to be deprecated. + last_evaluated_at: type: string - description: ID of the SQL warehouse attached to the alert. - evaluation: + description: Timestamp of the last evaluation. + notification: type: object properties: - source: + notify_on_ok: + type: boolean + retrigger_seconds: + type: integer + description: >- + Number of seconds an alert waits after being + triggered before it is allowed to send another + notification. If set to 0 or omitted, the alert will + not send any further notifications after the first + trigger Setting this value to 1 allows the alert to + send a notification on every evaluation where the + condition is met, effectively making it always + retrigger for notification purposes. + subscriptions: + type: array + items: + type: object + properties: + destination_id: + type: string + user_email: + type: string + description: >- + User or Notification Destination to notify when alert is + triggered. + state: + type: string + x-enum: + - ERROR + - OK + - TRIGGERED + - UNKNOWN + description: Latest state of alert evaluation. + threshold: + type: object + properties: + column: type: object properties: name: @@ -1492,268 +1601,190 @@ paths: type: string required: - name - comparison_operator: - type: string - x-enum: - - EQUAL - - GREATER_THAN - - GREATER_THAN_OR_EQUAL - - IS_NOT_NULL - - IS_NULL - - LESS_THAN - - LESS_THAN_OR_EQUAL - - NOT_EQUAL - description: Operator used for comparison in alert evaluation. - empty_result_state: - type: string - x-enum: - - ERROR - - OK - - TRIGGERED - - UNKNOWN - description: >- - Alert state if result is empty. Please avoid setting - this field to be ``UNKNOWN`` because ``UNKNOWN`` - state is planned to be deprecated. - last_evaluated_at: - type: string - description: Timestamp of the last evaluation. - notification: + value: type: object properties: - notify_on_ok: + bool_value: type: boolean - retrigger_seconds: - type: integer - description: >- - Number of seconds an alert waits after being - triggered before it is allowed to send another - notification. If set to 0 or omitted, the alert - will not send any further notifications after - the first trigger Setting this value to 1 allows - the alert to send a notification on every - evaluation where the condition is met, - effectively making it always retrigger for - notification purposes. - subscriptions: - type: array - items: - type: object - properties: - destination_id: - type: string - user_email: - type: string - description: >- - User or Notification Destination to notify when - alert is triggered. - state: - type: string - x-enum: - - ERROR - - OK - - TRIGGERED - - UNKNOWN - description: Latest state of alert evaluation. - threshold: - type: object - properties: - column: - type: object - properties: - name: - type: string - aggregation: - type: string - x-enum: - - AVG - - COUNT - - COUNT_DISTINCT - - MAX - - MEDIAN - - MIN - - STDDEV - - SUM - description: >- - If not set, the behavior is equivalent to - using ``First row`` in the UI. - display: - type: string - required: - - name - value: - type: object - properties: - bool_value: - type: boolean - double_value: - type: number - string_value: - type: string - description: >- - Threshold to user for alert evaluation, can be a - column or a value. - required: - - source - - comparison_operator - schedule: - type: object - properties: - quartz_cron_schedule: - type: string - timezone_id: - type: string - description: >- - A Java timezone id. The schedule will be resolved - using this timezone. This will be combined with the - quartz_cron_schedule to determine the schedule. See - https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html - for details. - effective_pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: >- - The actual pause status of the schedule. This is an - output-only field. - pause_status: - type: string - x-enum: - - PAUSED - - UNPAUSED - description: Indicate whether this schedule is paused or not. - required: - - quartz_cron_schedule - - timezone_id - create_time: - type: string - description: The timestamp indicating when the alert was created. - custom_description: - type: string + double_value: + type: number + string_value: + type: string description: >- - Custom description for the alert. support mustache - template. - custom_summary: + Threshold to user for alert evaluation, can be a column + or a value. + required: + - source + - comparison_operator + schedule: + type: object + properties: + quartz_cron_schedule: type: string - description: Custom summary for the alert. support mustache template. - effective_parent_path: + timezone_id: type: string description: >- - The actual workspace path of the folder containing the - alert. This is an output-only field. - effective_run_as: - type: object - properties: - service_principal_name: - type: string - user_name: - type: string - description: >- - The email of an active workspace user. Can only set - this field to their own email. - description: >- - The actual identity that will be used to execute the - alert. This is an output-only field that shows the - resolved run-as identity after applying permissions and - defaults. - id: - type: string - description: UUID identifying the alert. - lifecycle_state: + A Java timezone id. The schedule will be resolved using + this timezone. This will be combined with the + quartz_cron_schedule to determine the schedule. See + https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html + for details. + pause_status: type: string x-enum: - - ACTIVE - - DELETED - description: Indicates whether the query is trashed. - owner_user_name: + - PAUSED + - UNPAUSED + description: Indicate whether this schedule is paused or not. + required: + - quartz_cron_schedule + - timezone_id + create_time: + type: string + description: The timestamp indicating when the alert was created. + custom_description: + type: string + description: >- + Custom description for the alert. Interpreted according to + ``custom_template_format``. + custom_summary: + type: string + description: >- + Custom summary for the alert. Interpreted according to + ``custom_template_format``. + custom_template_format: + type: string + x-enum: + - HTML + - MARKDOWN + description: >- + The format used to interpret the ``custom_summary`` and + ``custom_description`` templates. ``HTML`` treats both + templates as HTML with Mustache ``{{VARIABLE_NAME}}`` + placeholders. ``MARKDOWN`` treats them as Markdown with + allowlisted ``@VARIABLE_NAME`` placeholders and converts + them to the format each notification destination expects, so + a single template renders correctly in email, Slack, and + Microsoft Teams. When unset, the API applies no default. + Responses omit the field unless a format is stored, and a + template with no format is rendered as HTML. + effective_run_as: + type: object + properties: + service_principal_name: + type: string + user_name: type: string description: >- - The owner's username. This field is set to "Unavailable" - if the user has been deleted. - parameters: - type: array - items: - type: object - properties: - name: - type: string - description: >- - The name of the parameter, referenced in the query - as ``:name``. - type: - type: string - description: >- - The SQL data type of the parameter, e.g. STRING, - INT, or DATE. Defaults to STRING. This is a string - rather than an enum because scalar subtypes such - as DECIMAL(10, 4) cannot be enumerated. Complex - types such as ARRAY, MAP, and STRUCT are not - supported. - value: - type: string - description: >- - The bound value for the parameter, given as a - string. If omitted, the value is interpreted as - NULL. - required: - - name + The email of an active workspace user. Can only set this + field to their own email. + description: >- + The actual identity that will be used to execute the alert. + This is an output-only field that shows the resolved run-as + identity after applying permissions and defaults. + id: + type: string + description: >- + The canonical identifier of the alert to retrieve + information about. + lifecycle_state: + type: string + x-enum: + - ACTIVE + - DELETED + description: Indicates whether the query is trashed. + owner_user_name: + type: string + description: >- + The owner's username. This field is set to "Unavailable" if + the user has been deleted. + parameters: + type: array + items: + type: object + properties: + name: + type: string description: >- - Redash-owned copy of the internal StatementParameter - for the external AlertV2 API. The internal - ``ordinal`` and ``args`` fields are intentionally omitted: the public API supports only flat, - named scalar parameters; complex types (ARRAY, MAP, STRUCT) are not supported. This mirrors - SEA's public StatementParameter schema, see: - cmdexec/sql-exec-api/proto/sql_exec_api_service.proto:763-779 - description: >- - Query parameters bound when executing the alert query, - referenced in the query text with ``:name`` syntax. - Static values only. - parent_path: + The name of the parameter. Reference it in the query + text as ``:name``. Required, must be non-empty, and + must be unique across the alert's parameters. + type: + type: string + description: >- + The SQL data type of the parameter, for example + ``STRING``, ``INT``, or ``DECIMAL(10, 2)``. If no type + is given the type is assumed to be ``STRING``. Complex + types such as ``ARRAY``, ``MAP``, and ``STRUCT`` are + not supported. + value: + type: string + description: >- + The value bound to the parameter, represented as a + string. If omitted, the value is interpreted as NULL. + required: + - name + description: >- + A named parameter bound to the alert query. Only flat, + named scalar parameters are supported; + complex types such as ARRAY, MAP, and STRUCT are not. + description: >- + A list of parameters to pass into the alert SQL query + statement containing parameter markers. Static values only. + Reference a parameter in the query text as ``:name``. Each + parameter must have a unique, non-empty name. Each parameter + consists of a name, a value, and optionally a type. To + represent a NULL value, the ``value`` field may be omitted + or set to ``null`` explicitly. If the ``type`` field is + omitted, the value is interpreted as a string. If the type + is given, parameters will be checked for type correctness + according to the given type. A value is correct if the + provided string can be converted to the requested type using + the ``cast`` function. The exact semantics are described in + the section `cast function + `__ + of the SQL language reference. + parent_path: + type: string + description: >- + The workspace path of the folder containing the alert. Can + only be set on create, and cannot be updated. + run_as: + type: object + properties: + service_principal_name: type: string - description: >- - The workspace path of the folder containing the alert. - Can only be set on create, and cannot be updated. - run_as: - type: object - properties: - service_principal_name: - type: string - user_name: - type: string - description: >- - The email of an active workspace user. Can only set - this field to their own email. - description: >- - Specifies the identity that will be used to run the - alert. This field allows you to configure alerts to run - as a specific user or service principal. - For user - identity: Set ``user_name`` to the email of an active - workspace user. Users can only set this to their own - email. - For service principal: Set - ``service_principal_name`` to the application ID. - Requires the ``servicePrincipal/user`` role. If not - specified, the alert will run as the request user. - run_as_user_name: + user_name: type: string description: >- - The run as username or application ID of service - principal. On Create and Update, this field can be set - to application ID of an active service principal. - Setting this field requires the servicePrincipal/user - role. Deprecated: Use ``run_as`` field instead. This - field will be removed in a future release. - update_time: - type: string - description: The timestamp indicating when the alert was updated. - required: - - display_name - - query_text - - warehouse_id - - evaluation - - schedule + The email of an active workspace user. Can only set this + field to their own email. + description: >- + Specifies the identity that will be used to run the alert. + This field allows you to configure alerts to run as a + specific user or service principal. - For user identity: Set + ``user_name`` to the email of an active workspace user. + Users can only set this to their own email. - For service + principal: Set ``service_principal_name`` to the application + ID. Requires the ``servicePrincipal/user`` role. If not + specified, the alert will run as the request user. + run_as_user_name: + type: string + description: >- + The run as username or application ID of service principal. + On Create and Update, this field can be set to application + ID of an active service principal. Setting this field + requires the servicePrincipal/user role. Deprecated: Use + ``run_as`` field instead. This field will be removed in a + future release. + update_time: + type: string + description: The timestamp indicating when the alert was updated. required: - - alert + - display_name + - query_text + - warehouse_id + - evaluation + - schedule responses: '200': description: Success @@ -4658,27 +4689,28 @@ paths: result sets efficiently. The main differences from using ``INLINE`` disposition are that the result - data is accessed with URLs, and + data is accessed with - that there are 3 supported formats: ``JSON_ARRAY``, ``ARROW_STREAM`` and - ``CSV`` compared to only + short-lived cloud-storage URLs, and that there are 3 supported formats: + ``JSON_ARRAY``, - ``JSON_ARRAY`` with ``INLINE``. + ``ARROW_STREAM`` and ``CSV`` compared to only ``JSON_ARRAY`` with + ``INLINE``. - ** URLs** + **External-link URLs** External links point to data stored within your workspace's internal - storage, in the form of a URL. + cloud storage. The URLs are valid - The URLs are valid for only a short period, <= 15 minutes. Alongside - each ``external_link`` is an + for only a short period, <= 15 minutes. Alongside each ``external_link`` + is an expiration field - expiration field indicating the time at which the URL is no longer - valid. In ``EXTERNAL_LINKS`` mode, + indicating the time at which the URL is no longer valid. In + ``EXTERNAL_LINKS`` mode, chunks can be - chunks can be resolved and fetched multiple times and in parallel. + resolved and fetched multiple times and in parallel. **Warning: Databricks strongly recommends that you protect the URLs that @@ -4687,23 +4719,19 @@ paths: ``EXTERNAL_LINKS`` disposition.** - When you use the ``EXTERNAL_LINKS`` disposition, a short-lived, URL is - generated, which can be used to - - download the results directly from . As a short-lived is embedded in - this URL, you should protect the - - URL. - + When you use the ``EXTERNAL_LINKS`` disposition, a short-lived + cloud-storage URL is generated to - Because URLs are already generated with embedded temporary s, you must - not set an ``Authorization`` + download the results. The URL contains temporary access credentials, so + protect it and do not set an - header in the download requests. + ``Authorization`` header in the download request. The ``EXTERNAL_LINKS`` disposition can be disabled upon request by - creating a support case. + creating a `support case + + `__. See also `Security best practices @@ -4759,8 +4787,8 @@ paths: 1. They point to resources *external* to the Databricks compute; therefore any associated authentication information (typically a personal access token, OAuth token, or similar) *must be removed* when fetching from these links. - 2. These are URLs with a specific expiration, indicated in the response. The behavior when - attempting to use an expired link is cloud specific. + 2. These are short-lived cloud-storage URLs with a specific expiration, indicated in the response. + The behavior when attempting to use an expired link is cloud specific. :param format: :class:`Format` (optional) Statement execution supports three result formats: ``JSON_ARRAY`` (default), ``ARROW_STREAM``, and ``CSV``. @@ -4929,9 +4957,9 @@ paths: therefore any associated authentication information (typically a personal access token, OAuth token, or similar) *must be removed* when fetching from these links. 2. These - are URLs with a specific expiration, indicated in the - response. The behavior when attempting to use an expired - link is cloud specific. + are short-lived cloud-storage URLs with a specific + expiration, indicated in the response. The behavior when + attempting to use an expired link is cloud specific. format: type: string x-enum: @@ -5300,6 +5328,8 @@ paths: - 5X-Large :param creator_name: str (optional) warehouse creator name + :param customer_version_label: str (optional) + Compute version label for a REALTIME warehouse. This field is output only. :param enable_photon: bool (optional) Configures whether the warehouse should use Photon optimized clusters. @@ -5308,6 +5338,9 @@ paths: Configures whether the warehouse should use serverless compute :param instance_profile_arn: str (optional) Deprecated. Instance profile used to pass IAM role to the cluster + :param max_dbu: int (optional) + Maximum compute capacity of a real-time SQL warehouse, in DBU per hour. Must be a multiple of 3 + between 3 and 960. The effective maximum cannot be lower than the warehouse's minimum capacity. :param max_num_clusters: int (optional) Maximum number of clusters that the autoscaler will create to handle concurrent queries. @@ -5335,8 +5368,20 @@ paths: - Must be unique within an org. - Must be less than 100 characters. + :param reyden_cluster_size_multiplier: float (optional) + Cluster size multiplier for Reyden warehouses. Scales the effective compute capacity relative to the + nominal virtual cluster size. Only meaningful when the warehouse is of Reyden type. + + Accepted range: 1.0 to the workspace-configured maximum (decimals allowed). The default maximum is + 100.0. + + - Values below 1.0 are normalized to 1.0. + - Values above the configured maximum are capped at that maximum. + - When absent, the warehouse is treated as having a multiplier of 1.0. :param spot_instance_policy: :class:`SpotInstancePolicy` (optional) Configurations whether the endpoint should use spot instances. + :param statement_timeout: int (optional) + Warehouse statement timeout in seconds. :param tags: :class:`EndpointTags` (optional) A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated with this SQL warehouse. @@ -5442,6 +5487,11 @@ paths: creator_name: type: string description: warehouse creator name + customer_version_label: + type: string + description: >- + Compute version label for a REALTIME warehouse. This field + is output only. enable_photon: type: boolean description: >- @@ -5457,6 +5507,13 @@ paths: description: >- Deprecated. Instance profile used to pass IAM role to the cluster + max_dbu: + type: integer + description: >- + Maximum compute capacity of a real-time SQL warehouse, in + DBU per hour. Must be a multiple of 3 between 3 and 960. The + effective maximum cannot be lower than the warehouse's + minimum capacity. max_num_clusters: type: integer description: >- @@ -5479,6 +5536,18 @@ paths: description: >- Logical name for the cluster. Supported values: - Must be unique within an org. - Must be less than 100 characters. + reyden_cluster_size_multiplier: + type: number + description: >- + Cluster size multiplier for Reyden warehouses. Scales the + effective compute capacity relative to the nominal virtual + cluster size. Only meaningful when the warehouse is of + Reyden type. Accepted range: 1.0 to the workspace-configured + maximum (decimals allowed). The default maximum is 100.0. - + Values below 1.0 are normalized to 1.0. - Values above the + configured maximum are capped at that maximum. - When + absent, the warehouse is treated as having a multiplier of + 1.0. spot_instance_policy: type: string x-enum: @@ -5488,6 +5557,9 @@ paths: description: >- Configurations whether the endpoint should use spot instances. + statement_timeout: + type: integer + description: Warehouse statement timeout in seconds. tags: type: object properties: @@ -5511,7 +5583,6 @@ paths: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: >- Warehouse type: ``PRO`` or ``CLASSIC``. If you want to use @@ -5642,34 +5713,27 @@ paths: schema: type: object properties: - default_warehouse_override: - type: object - properties: - type: - type: string - x-enum: - - CUSTOM - - LAST_SELECTED - description: The type of override behavior. - default_warehouse_override_id: - type: string - description: The ID component of the resource name (user ID). - name: - type: string - description: >- - The resource name of the default warehouse override. - Format: - default-warehouse-overrides/{default_warehouse_override_id} - warehouse_id: - type: string - description: >- - The specific warehouse ID when type is CUSTOM. Not set - for LAST_SELECTED type. - required: - - type - description: Required. The default warehouse override to create. + type: + type: string + x-enum: + - CUSTOM + - LAST_SELECTED + description: The type of override behavior. + default_warehouse_override_id: + type: string + description: The ID component of the resource name (user ID). + name: + type: string + description: >- + The resource name of the default warehouse override. Format: + default-warehouse-overrides/{default_warehouse_override_id} + warehouse_id: + type: string + description: >- + The specific warehouse ID when type is CUSTOM. Not set for + LAST_SELECTED type. required: - - default_warehouse_override + - type responses: '200': description: Success @@ -5830,7 +5894,7 @@ paths: message: type: string x-stackql-sdk-source: WarehousesAPI - /api/warehouses/v1/{name}: + /api/warehouses/v1/default-warehouse-overrides/{default_warehouse_override_id}: delete: operationId: warehouses_delete_default_warehouse_override summary: >- @@ -5852,12 +5916,15 @@ paths: default-warehouse-overrides/{default_warehouse_override_id} The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user. parameters: - - name: name + - name: default_warehouse_override_id in: path required: true schema: type: string description: >- + The `default_warehouse_override_id` segment of the `name` resource + name + (`default-warehouse-overrides/{default_warehouse_override_id}`). Required. The resource name of the default warehouse override to delete. Format: default-warehouse-overrides/{default_warehouse_override_id} The @@ -5903,12 +5970,15 @@ paths: :returns: :class:`DefaultWarehouseOverride` parameters: - - name: name + - name: default_warehouse_override_id in: path required: true schema: type: string description: >- + The `default_warehouse_override_id` segment of the `name` resource + name + (`default-warehouse-overrides/{default_warehouse_override_id}`). Required. The resource name of the default warehouse override to retrieve. Format: default-warehouse-overrides/{default_warehouse_override_id} The @@ -5965,13 +6035,16 @@ paths: :returns: :class:`DefaultWarehouseOverride` parameters: - - name: name + - name: default_warehouse_override_id in: path required: true schema: type: string description: >- - The resource name of the default warehouse override. Format: + The `default_warehouse_override_id` segment of the `name` resource + name + (`default-warehouse-overrides/{default_warehouse_override_id}`). The + resource name of the default warehouse override. Format: default-warehouse-overrides/{default_warehouse_override_id} - name: update_mask in: query @@ -5998,39 +6071,27 @@ paths: schema: type: object properties: - default_warehouse_override: - type: object - properties: - type: - type: string - x-enum: - - CUSTOM - - LAST_SELECTED - description: The type of override behavior. - default_warehouse_override_id: - type: string - description: The ID component of the resource name (user ID). - name: - type: string - description: >- - The resource name of the default warehouse override. - Format: - default-warehouse-overrides/{default_warehouse_override_id} - warehouse_id: - type: string - description: >- - The specific warehouse ID when type is CUSTOM. Not set - for LAST_SELECTED type. - required: - - type + type: + type: string + x-enum: + - CUSTOM + - LAST_SELECTED + description: The type of override behavior. + default_warehouse_override_id: + type: string + description: The ID component of the resource name (user ID). + name: + type: string description: >- - Required. The default warehouse override to update. The name - field must be set in the format: + The resource name of the default warehouse override. Format: default-warehouse-overrides/{default_warehouse_override_id} - The default_warehouse_override_id can be a numeric user ID - or the literal string "me" for the current user. + warehouse_id: + type: string + description: >- + The specific warehouse ID when type is CUSTOM. Not set for + LAST_SELECTED type. required: - - default_warehouse_override + - type responses: '200': description: Success @@ -6094,6 +6155,8 @@ paths: - 5X-Large :param creator_name: str (optional) warehouse creator name + :param customer_version_label: str (optional) + Compute version label for a REALTIME warehouse. This field is output only. :param enable_photon: bool (optional) Configures whether the warehouse should use Photon optimized clusters. @@ -6102,6 +6165,9 @@ paths: Configures whether the warehouse should use serverless compute :param instance_profile_arn: str (optional) Deprecated. Instance profile used to pass IAM role to the cluster + :param max_dbu: int (optional) + Maximum compute capacity of a real-time SQL warehouse, in DBU per hour. Must be a multiple of 3 + between 3 and 960. The effective maximum cannot be lower than the warehouse's minimum capacity. :param max_num_clusters: int (optional) Maximum number of clusters that the autoscaler will create to handle concurrent queries. @@ -6129,8 +6195,20 @@ paths: - Must be unique within an org. - Must be less than 100 characters. + :param reyden_cluster_size_multiplier: float (optional) + Cluster size multiplier for Reyden warehouses. Scales the effective compute capacity relative to the + nominal virtual cluster size. Only meaningful when the warehouse is of Reyden type. + + Accepted range: 1.0 to the workspace-configured maximum (decimals allowed). The default maximum is + 100.0. + + - Values below 1.0 are normalized to 1.0. + - Values above the configured maximum are capped at that maximum. + - When absent, the warehouse is treated as having a multiplier of 1.0. :param spot_instance_policy: :class:`SpotInstancePolicy` (optional) Configurations whether the endpoint should use spot instances. + :param statement_timeout: int (optional) + Warehouse statement timeout in seconds. :param tags: :class:`EndpointTags` (optional) A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated with this SQL warehouse. @@ -6243,6 +6321,11 @@ paths: creator_name: type: string description: warehouse creator name + customer_version_label: + type: string + description: >- + Compute version label for a REALTIME warehouse. This field + is output only. enable_photon: type: boolean description: >- @@ -6258,6 +6341,13 @@ paths: description: >- Deprecated. Instance profile used to pass IAM role to the cluster + max_dbu: + type: integer + description: >- + Maximum compute capacity of a real-time SQL warehouse, in + DBU per hour. Must be a multiple of 3 between 3 and 960. The + effective maximum cannot be lower than the warehouse's + minimum capacity. max_num_clusters: type: integer description: >- @@ -6280,6 +6370,18 @@ paths: description: >- Logical name for the cluster. Supported values: - Must be unique within an org. - Must be less than 100 characters. + reyden_cluster_size_multiplier: + type: number + description: >- + Cluster size multiplier for Reyden warehouses. Scales the + effective compute capacity relative to the nominal virtual + cluster size. Only meaningful when the warehouse is of + Reyden type. Accepted range: 1.0 to the workspace-configured + maximum (decimals allowed). The default maximum is 100.0. - + Values below 1.0 are normalized to 1.0. - Values above the + configured maximum are capped at that maximum. - When + absent, the warehouse is treated as having a multiplier of + 1.0. spot_instance_policy: type: string x-enum: @@ -6289,6 +6391,9 @@ paths: description: >- Configurations whether the endpoint should use spot instances. + statement_timeout: + type: integer + description: Warehouse statement timeout in seconds. tags: type: object properties: @@ -6312,7 +6417,6 @@ paths: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: >- Warehouse type: ``PRO`` or ``CLASSIC``. If you want to use @@ -6777,7 +6881,6 @@ paths: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: >- Create a collection of name/value pairs. @@ -7233,28 +7336,28 @@ components: properties: name: type: string - description: The name of the parameter, referenced in the query as ``:name``. + description: >- + The name of the parameter. Reference it in the query text as + ``:name``. Required, must be non-empty, and must be unique across + the alert's parameters. type: type: string description: >- - The SQL data type of the parameter, e.g. STRING, INT, or DATE. - Defaults to STRING. This is a string rather than an enum because - scalar subtypes such as DECIMAL(10, 4) cannot be enumerated. Complex - types such as ARRAY, MAP, and STRUCT are not supported. + The SQL data type of the parameter, for example ``STRING``, ``INT``, + or ``DECIMAL(10, 2)``. If no type is given the type is assumed to be + ``STRING``. Complex types such as ``ARRAY``, ``MAP``, and ``STRUCT`` + are not supported. value: type: string description: >- - The bound value for the parameter, given as a string. If omitted, - the value is interpreted as NULL. + The value bound to the parameter, represented as a string. If + omitted, the value is interpreted as NULL. required: - name description: >- - Redash-owned copy of the internal StatementParameter for the external - AlertV2 API. The internal - ``ordinal`` and ``args`` fields are intentionally omitted: the public API supports only flat, - named scalar parameters; complex types (ARRAY, MAP, STRUCT) are not supported. This mirrors - SEA's public StatementParameter schema, see: - cmdexec/sql-exec-api/proto/sql_exec_api_service.proto:763-779 + A named parameter bound to the alert query. Only flat, named scalar + parameters are supported; + complex types such as ARRAY, MAP, and STRUCT are not. AlertV2: type: object properties: @@ -7275,15 +7378,26 @@ components: description: The timestamp indicating when the alert was created. custom_description: type: string - description: Custom description for the alert. support mustache template. + description: >- + Custom description for the alert. Interpreted according to + ``custom_template_format``. custom_summary: - type: string - description: Custom summary for the alert. support mustache template. - effective_parent_path: type: string description: >- - The actual workspace path of the folder containing the alert. This - is an output-only field. + Custom summary for the alert. Interpreted according to + ``custom_template_format``. + custom_template_format: + $ref: '#/components/schemas/CustomTemplateFormat' + description: >- + The format used to interpret the ``custom_summary`` and + ``custom_description`` templates. ``HTML`` treats both templates as + HTML with Mustache ``{{VARIABLE_NAME}}`` placeholders. ``MARKDOWN`` + treats them as Markdown with allowlisted ``@VARIABLE_NAME`` + placeholders and converts them to the format each notification + destination expects, so a single template renders correctly in + email, Slack, and Microsoft Teams. When unset, the API applies no + default. Responses omit the field unless a format is stored, and a + template with no format is rendered as HTML. effective_run_as: $ref: '#/components/schemas/AlertV2RunAs' description: >- @@ -7292,7 +7406,7 @@ components: applying permissions and defaults. id: type: string - description: UUID identifying the alert. + description: The canonical identifier of the alert to retrieve information about. lifecycle_state: $ref: '#/components/schemas/AlertLifecycleState' description: Indicates whether the query is trashed. @@ -7306,8 +7420,19 @@ components: items: $ref: '#/components/schemas/AlertStatementParameter' description: >- - Query parameters bound when executing the alert query, referenced in - the query text with ``:name`` syntax. Static values only. + A list of parameters to pass into the alert SQL query statement + containing parameter markers. Static values only. Reference a + parameter in the query text as ``:name``. Each parameter must have a + unique, non-empty name. Each parameter consists of a name, a value, + and optionally a type. To represent a NULL value, the ``value`` + field may be omitted or set to ``null`` explicitly. If the ``type`` + field is omitted, the value is interpreted as a string. If the type + is given, parameters will be checked for type correctness according + to the given type. A value is correct if the provided string can be + converted to the requested type using the ``cast`` function. The + exact semantics are described in the section `cast function + `__ + of the SQL language reference. parent_path: type: string description: >- @@ -7643,11 +7768,6 @@ components: determine the schedule. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. - effective_pause_status: - $ref: '#/components/schemas/SchedulePauseStatus' - description: >- - The actual pause status of the schedule. This is an output-only - field. pause_status: $ref: '#/components/schemas/SchedulePauseStatus' description: Indicate whether this schedule is paused or not. @@ -7902,6 +8022,11 @@ components: creator_name: type: string description: warehouse creator name + customer_version_label: + type: string + description: >- + Compute version label for a REALTIME warehouse. This field is output + only. enable_photon: type: boolean description: >- @@ -7924,6 +8049,12 @@ components: jdbc_url: type: string description: the jdbc connection string for this warehouse + max_dbu: + type: integer + description: >- + Maximum compute capacity of a real-time SQL warehouse, in DBU per + hour. Must be a multiple of 3 between 3 and 960. The effective + maximum cannot be lower than the warehouse's minimum capacity. max_num_clusters: type: integer description: >- @@ -7953,12 +8084,25 @@ components: odbc_params: $ref: '#/components/schemas/OdbcParams' description: ODBC parameters for the SQL warehouse + reyden_cluster_size_multiplier: + type: number + description: >- + Cluster size multiplier for Reyden warehouses. Scales the effective + compute capacity relative to the nominal virtual cluster size. Only + meaningful when the warehouse is of Reyden type. Accepted range: 1.0 + to the workspace-configured maximum (decimals allowed). The default + maximum is 100.0. - Values below 1.0 are normalized to 1.0. - Values + above the configured maximum are capped at that maximum. - When + absent, the warehouse is treated as having a multiplier of 1.0. spot_instance_policy: $ref: '#/components/schemas/SpotInstancePolicy' description: Configurations whether the endpoint should use spot instances. state: $ref: '#/components/schemas/State' description: state of the endpoint + statement_timeout: + type: integer + description: Warehouse statement timeout in seconds. tags: $ref: '#/components/schemas/EndpointTags' description: >- @@ -8017,10 +8161,11 @@ components: external_link: type: string description: >- - A URL pointing to a chunk of result data, hosted by an external - service, with a short expiration time (<= 15 minutes). As this URL - contains a temporary credential, it should be considered sensitive - and the client should not expose this URL in a log. + A short-lived cloud-storage URL pointing to a chunk of result data, + hosted by an external service, with a short expiration time (<= 15 + minutes). As this URL contains a temporary credential, it should be + considered sensitive and the client should not expose this URL in a + log. http_headers: type: object description: >- @@ -8126,6 +8271,11 @@ components: creator_name: type: string description: warehouse creator name + customer_version_label: + type: string + description: >- + Compute version label for a REALTIME warehouse. This field is output + only. enable_photon: type: boolean description: >- @@ -8148,6 +8298,12 @@ components: jdbc_url: type: string description: the jdbc connection string for this warehouse + max_dbu: + type: integer + description: >- + Maximum compute capacity of a real-time SQL warehouse, in DBU per + hour. Must be a multiple of 3 between 3 and 960. The effective + maximum cannot be lower than the warehouse's minimum capacity. max_num_clusters: type: integer description: >- @@ -8177,12 +8333,25 @@ components: odbc_params: $ref: '#/components/schemas/OdbcParams' description: ODBC parameters for the SQL warehouse + reyden_cluster_size_multiplier: + type: number + description: >- + Cluster size multiplier for Reyden warehouses. Scales the effective + compute capacity relative to the nominal virtual cluster size. Only + meaningful when the warehouse is of Reyden type. Accepted range: 1.0 + to the workspace-configured maximum (decimals allowed). The default + maximum is 100.0. - Values below 1.0 are normalized to 1.0. - Values + above the configured maximum are capped at that maximum. - When + absent, the warehouse is treated as having a multiplier of 1.0. spot_instance_policy: $ref: '#/components/schemas/SpotInstancePolicy' description: Configurations whether the endpoint should use spot instances. state: $ref: '#/components/schemas/State' description: state of the endpoint + statement_timeout: + type: integer + description: Warehouse statement timeout in seconds. tags: $ref: '#/components/schemas/EndpointTags' description: >- @@ -9183,10 +9352,10 @@ components: description: >- Contains the result data of a single chunk when using ``INLINE`` disposition. When using - ``EXTERNAL_LINKS`` disposition, the array ``external_links`` is used instead to provide URLs to - the result data in cloud storage. Exactly one of these alternatives is used. (While the - ``external_links`` array prepares the API to return multiple links in a single response. - Currently only a single link is returned.) + ``EXTERNAL_LINKS`` disposition, the array ``external_links`` is used instead to provide + short-lived cloud-storage URLs to the result data in cloud storage. Exactly one of these + alternatives is used. (While the ``external_links`` array prepares the API to return multiple + links in a single response. Currently only a single link is returned.) ResultManifest: type: object properties: @@ -9992,7 +10161,6 @@ components: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: |- Create a collection of name/value pairs. @@ -10031,6 +10199,14 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + CustomTemplateFormat: + type: string + x-enum: + - HTML + - MARKDOWN + description: >- + Rendering format for the ``custom_summary`` and ``custom_description`` + templates. DatePrecision: type: string x-enum: @@ -10227,7 +10403,6 @@ components: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: |- Create a collection of name/value pairs. @@ -10272,7 +10447,6 @@ components: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: |- Create a collection of name/value pairs. @@ -10382,7 +10556,6 @@ components: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: |- Create a collection of name/value pairs. @@ -10686,7 +10859,6 @@ components: x-enum: - ALTER - ANALYZE - - CALL - COPY - CREATE - DELETE @@ -10962,20 +11134,13 @@ components: cloud configurations is: - +-------+--------------------------------------+--------------------------------+ - | Cloud | - - COST_OPTIMIZED | RELIABILITY_OPTIMIZED | - - +-------+--------------------------------------+--------------------------------+ - | AWS | On + - AWS, COST_OPTIMIZED: On Demand Driver with Spot Executors. - Demand Driver with Spot Executors | On Demand Driver and Executors | | - AZURE | On Demand Driver + - AWS, RELIABILITY_OPTIMIZED: On Demand Driver and Executors. - and Executors | On Demand Driver and Executors | + - AZURE, COST_OPTIMIZED: On Demand Driver and Executors. - +-------+--------------------------------------+--------------------------------+ + - AZURE, RELIABILITY_OPTIMIZED: On Demand Driver and Executors. State: type: string x-enum: @@ -11157,7 +11322,6 @@ components: - BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG - BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED - BUDGET_POLICY_RESOLUTION_FAILURE - - CERT_ROTATION - CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED - CLOUD_ACCOUNT_SETUP_FAILURE - CLOUD_OPERATION_CANCELLED @@ -11176,7 +11340,6 @@ components: - CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG - CONTROL_PLANE_REQUEST_FAILURE - CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG - - COST_CONTROL_ENTITLEMENT_DENIED - DATABASE_CONNECTION_FAILURE - DATA_ACCESS_CONFIG_CHANGED - DBFS_COMPONENT_UNHEALTHY @@ -11187,7 +11350,6 @@ components: - DOCKER_IMAGE_PULL_FAILURE - DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION - DOCKER_INVALID_OS_EXCEPTION - - DRIVER_DNS_RESOLUTION_FAILURE - DRIVER_EVICTION - DRIVER_LAUNCH_TIMEOUT - DRIVER_NODE_UNREACHABLE @@ -11264,8 +11426,6 @@ components: - NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG - NETWORK_CONFIGURATION_FAILURE - NFS_MOUNT_FAILURE - - NO_ACTIVATED_K8S - - NO_ACTIVATED_K8S_TESTING_TAG - NO_MATCHED_K8S - NO_MATCHED_K8S_TESTING_TAG - NPIP_TUNNEL_SETUP_FAILURE @@ -11276,11 +11436,9 @@ components: - REQUEST_REJECTED - REQUEST_THROTTLED - RESOURCE_USAGE_BLOCKED - - SECRET_CREATION_ACCESS_DENIED - SECRET_CREATION_FAILURE - SECRET_PERMISSION_DENIED - SECRET_RESOLUTION_ERROR - - SECURITY_AGENTS_FAILED_INITIAL_VERIFICATION - SECURITY_DAEMON_REGISTRATION_EXCEPTION - SELF_BOOTSTRAP_FAILURE - SERVERLESS_LONG_RUNNING_TERMINATED @@ -11312,9 +11470,8 @@ components: - WORKER_SETUP_FAILURE - WORKSPACE_CANCELLED_ERROR - WORKSPACE_CONFIGURATION_ERROR - - WORKSPACE_DELEGATION_KEY_MISCONFIGURED - WORKSPACE_UPDATE - description: The status code indicating why the cluster was terminated + description: The status code indicating why the cluster was terminated. TerminationReasonType: type: string x-enum: @@ -11338,7 +11495,6 @@ components: - CLASSIC - PRO - REALTIME - - REYDEN - TYPE_UNSPECIFIED description: |- Create a collection of name/value pairs. @@ -12056,13 +12212,15 @@ components: objectKey: $.default_warehouse_overrides delete: operation: - $ref: '#/paths/~1api~1warehouses~1v1~1{name}/delete' + $ref: >- + #/paths/~1api~1warehouses~1v1~1default-warehouse-overrides~1{default_warehouse_override_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~1warehouses~1v1~1{name}/get' + $ref: >- + #/paths/~1api~1warehouses~1v1~1default-warehouse-overrides~1{default_warehouse_override_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -12071,7 +12229,8 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~1warehouses~1v1~1{name}/patch' + $ref: >- + #/paths/~1api~1warehouses~1v1~1default-warehouse-overrides~1{default_warehouse_override_id}/patch response: mediaType: application/json openAPIDocKey: '200' diff --git a/providers/src/databricks_workspace/v00.00.00000/services/supervisoragents.yaml b/providers/src/databricks_workspace/v00.00.00000/services/supervisoragents.yaml index 52608d67..96ce9235 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/supervisoragents.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/supervisoragents.yaml @@ -6,16 +6,33 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.supervisoragents servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: - /api/2.1/{parent}/examples: + /api/2.1/supervisor-agents/{supervisor_agent_id}/examples: post: operationId: supervisor_agents_create_example summary: Creates an example for a Supervisor Agent. @@ -32,13 +49,15 @@ paths: :returns: :class:`Example` parameters: - - name: parent + - name: supervisor_agent_id in: path required: true schema: type: string description: >- - Parent resource where this example will be created. Format: + The `supervisor_agent_id` segment of the `parent` resource name + (`supervisor-agents/{supervisor_agent_id}`). Parent resource where + this example will be created. Format: supervisor-agents/{supervisor_agent_id} requestBody: content: @@ -46,31 +65,25 @@ paths: schema: type: object properties: - example: - type: object - properties: - question: - type: string - description: The example question. - guidelines: - type: array - items: - type: string - description: Guidelines for answering the question. - example_id: - type: string - description: The universally unique identifier (UUID) of the example. - name: - type: string - description: >- - Full resource name: - supervisor-agents/{supervisor_agent_id}/examples/{example_id} - required: - - question - - guidelines - description: The example to create under the parent Supervisor Agent. + question: + type: string + description: The example question. + guidelines: + type: array + items: + type: string + description: Guidelines for answering the question. + example_id: + type: string + description: The universally unique identifier (UUID) of the example. + name: + type: string + description: >- + Full resource name: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} required: - - example + - question + - guidelines responses: '200': description: Success @@ -110,14 +123,15 @@ paths: :returns: Iterator over :class:`Example` parameters: - - name: parent + - name: supervisor_agent_id in: path required: true schema: type: string description: >- - Parent resource to list from. Format: - supervisor-agents/{supervisor_agent_id} + The `supervisor_agent_id` segment of the `parent` resource name + (`supervisor-agents/{supervisor_agent_id}`). Parent resource to list + from. Format: supervisor-agents/{supervisor_agent_id} - name: page_size in: query required: false @@ -175,50 +189,44 @@ paths: schema: type: object properties: - supervisor_agent: - type: object - properties: - display_name: - type: string - create_time: - type: string - format: date-time - description: Creation timestamp. - creator: - type: string - description: The creator of the Supervisor Agent. - description: - type: string - description: Description of what this agent can do (user-facing). - endpoint_name: - type: string - description: The name of the supervisor agent's serving endpoint. - experiment_id: - type: string - description: The MLflow experiment ID. - id: - type: string - description: 'Deprecated: Use supervisor_agent_id instead.' - instructions: - type: string - description: >- - Optional natural-language instructions for the - supervisor agent. - name: - type: string - description: >- - The resource name of the SupervisorAgent. Format: - supervisor-agents/{supervisor_agent_id} - supervisor_agent_id: - type: string - description: >- - The universally unique identifier (UUID) of the - Supervisor Agent. - required: - - display_name - description: The Supervisor Agent to create. + display_name: + type: string + create_time: + type: string + format: date-time + description: Creation timestamp. + creator: + type: string + description: The creator of the Supervisor Agent. + description: + type: string + description: Description of what this agent can do (user-facing). + endpoint_name: + type: string + description: The name of the supervisor agent's serving endpoint. + experiment_id: + type: string + description: The MLflow experiment ID. + id: + type: string + description: 'Deprecated: Use supervisor_agent_id instead.' + instructions: + type: string + description: >- + Optional natural-language instructions for the supervisor + agent. + name: + type: string + description: >- + The resource name of the SupervisorAgent. Format: + supervisor-agents/{supervisor_agent_id} + supervisor_agent_id: + type: string + description: >- + The universally unique identifier (UUID) of the Supervisor + Agent. required: - - supervisor_agent + - display_name responses: '200': description: Success @@ -293,7 +301,7 @@ paths: message: type: string x-stackql-sdk-source: SupervisorAgentsAPI - /api/2.1/{parent}/tools: + /api/2.1/supervisor-agents/{supervisor_agent_id}/tools: post: operationId: supervisor_agents_create_tool summary: >- @@ -330,13 +338,15 @@ paths: :returns: :class:`Tool` parameters: - - name: parent + - name: supervisor_agent_id in: path required: true schema: type: string description: >- - Parent resource where this tool will be created. Format: + The `supervisor_agent_id` segment of the `parent` resource name + (`supervisor-agents/{supervisor_agent_id}`). Parent resource where + this tool will be created. Format: supervisor-agents/{supervisor_agent_id} - name: tool_id in: query @@ -352,224 +362,74 @@ paths: schema: type: object properties: - tool: + tool_type: + type: string + app: type: object properties: - tool_type: - type: string - app: - type: object - properties: - name: - type: string - description: App name - required: - - name - description: 'Databricks app. Supported app: custom mcp, custom agent.' - catalog: - type: object - properties: - name: - type: string - description: >- - Bare UC catalog name this tool is authorized to - search (no ``.``). - required: - - name - description: Configuration for a UC catalog asset_search scope tool. - dashboard: - type: object - properties: - dashboard_id: - type: string - description: The unique identifier of the Lakeview dashboard. - required: - - dashboard_id - description: >- - Lakeview dashboard tool. Replaces the deprecated - ``lakeview_dashboard`` field. - description: + name: type: string - description: Description of what this tool does (user-facing). - genie_space: - type: object - properties: - id: - type: string - space_id: - type: string - description: The ID of the genie space. - required: - - id + description: App name + required: + - name + description: 'Databricks app. Supported app: custom mcp, custom agent.' + description: + type: string + description: Description of what this tool does (user-facing). + genie_space: + type: object + properties: id: type: string - description: 'Deprecated: Use tool_id instead.' - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - serving_endpoint_name: - type: string - description: 'Deprecated: use knowledge_assistant_id instead.' - required: - - knowledge_assistant_id - lakeview_dashboard: - type: object - properties: - dashboard_id: - type: string - description: The unique identifier of the Lakeview dashboard. - required: - - dashboard_id - description: 'Deprecated: use ``dashboard`` instead.' + required: + - id + id: + type: string + description: 'Deprecated: Use tool_id instead.' + knowledge_assistant: + type: object + properties: + knowledge_assistant_id: + type: string + serving_endpoint_name: + type: string + description: 'Deprecated: use knowledge_assistant_id instead.' + required: + - knowledge_assistant_id + name: + type: string + description: >- + Full resource name: + supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + tool_id: + type: string + description: User specified id of the Tool. + uc_connection: + type: object + properties: + name: + type: string + required: + - name + description: >- + Databricks UC connection. Supported connection: external mcp + server. + uc_function: + type: object + properties: name: type: string - description: >- - Full resource name: - supervisor-agents/{supervisor_agent_id}/tools/{tool_id} - schema: - type: object - properties: - name: - type: string - description: >- - Full UC schema name (catalog.schema) this tool is - authorized to search. - required: - - name - description: Configuration for a UC schema asset_search scope tool. - serving_endpoint: - type: object - properties: - name: - type: string - required: - - name - skill: - type: object - properties: - path: - type: string - description: >- - Absolute WSFS path to a folder containing skill - subdirectories. Example: - /Workspace/Users/creator@company.com/.assistant/skills - required: - - path - description: >- - Skill tool. Points to a folder containing skill - subdirectories with SKILL.md files. Skills are - discovered from the folder at runtime and loaded on - demand via a read_skill tool. - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: The ID of the supervisor agent (tile ID). - required: - - supervisor_agent_id - description: Nested Supervisor Agent tool. - table: - type: object - properties: - name: - type: string - description: >- - Full UC table name (catalog.schema.table) this tool - is authorized to access. - required: - - name - description: >- - Unity Catalog table tool. Replaces the deprecated - ``uc_table`` field. - tool_id: + required: + - name + volume: + type: object + properties: + name: type: string - description: User specified id of the Tool. - uc_connection: - type: object - properties: - name: - type: string - required: - - name - description: >- - Databricks UC connection. Supported connection: external - mcp server. - uc_function: - type: object - properties: - name: - type: string - required: - - name - uc_mcp: - type: object - properties: - name: - type: string - description: >- - Three-level UC FQN of the registered MCP service - (catalog.schema.mcp_service). - required: - - name - description: >- - UC-registered MCP service tool. The ``name`` field on - UcMcpService is the three-level UC FQN - (catalog.schema.mcp_service); the supervisor resolves it - at request build time, calls ``tools/list`` against the - AI Gateway mcp-services proxy, and dynamically registers - every discovered MCP sub-tool as a separately-callable - tool. - uc_table: - type: object - properties: - name: - type: string - description: >- - Full UC table name (catalog.schema.table) this tool - is authorized to access. - required: - - name - description: 'Deprecated: use ``table`` instead.' - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Full Vector Search index name - (catalog.schema.index). - columns: - type: array - items: - type: string - description: >- - Optional columns to return from the index. If unset, - discovered from index schema at query time. - required: - - name - description: Configuration for a Vector Search index tool. - volume: - type: object - properties: - name: - type: string - required: - - name - web_search: - type: object - properties: {} - description: >- - Configuration for a public-web search tool. The - supervisor collapses multiple web_search tools on the - same agent into a single registered ``web_search`` tool - at runtime. required: - - tool_type + - name required: - - tool + - tool_type responses: '200': description: Success @@ -605,14 +465,15 @@ paths: :returns: Iterator over :class:`Tool` parameters: - - name: parent + - name: supervisor_agent_id in: path required: true schema: type: string description: >- - Parent resource to list from. Format: - supervisor-agents/{supervisor_agent_id} + The `supervisor_agent_id` segment of the `parent` resource name + (`supervisor-agents/{supervisor_agent_id}`). Parent resource to list + from. Format: supervisor-agents/{supervisor_agent_id} - name: page_size in: query required: false @@ -642,7 +503,388 @@ paths: message: type: string x-stackql-sdk-source: SupervisorAgentsAPI - /api/2.1/{name}: + /api/2.1/supervisor-agents/{supervisor_agent_id}/examples/{example_id}: + delete: + operationId: supervisor_agents_delete_example + summary: Deletes an example from a Supervisor Agent. + tags: + - supervisoragents + - supervisor_agents + description: |- + Deletes an example from a Supervisor Agent. + + :param name: str + The resource name of the example to delete. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example to delete. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example to delete. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + get: + operationId: supervisor_agents_get_example + summary: Gets an example from a Supervisor Agent. + tags: + - supervisoragents + - supervisor_agents + description: |- + Gets an example from a Supervisor Agent. + + :param name: str + The resource name of the example. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + + :returns: :class:`Example` + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Example' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + patch: + operationId: supervisor_agents_update_example + summary: Updates an example in a Supervisor Agent. + tags: + - supervisoragents + - supervisor_agents + description: |- + Updates an example in a Supervisor Agent. + + :param name: str + The resource name of the example to update. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + :param example: :class:`Example` + :param update_mask: FieldMask + Comma-delimited list of fields to update on the example. Allowed values: ``question``, + ``guidelines``. Examples: + + - ``question`` + - ``question,guidelines`` + + :returns: :class:`Example` + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example to update. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + - name: example_id + in: path + required: true + schema: + type: string + description: >- + The `example_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/examples/{example_id}`). + The resource name of the example to update. Format: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + - name: update_mask + in: query + required: true + schema: + type: object + description: >- + Comma-delimited list of fields to update on the example. Allowed + values: ``question``, ``guidelines``. Examples: - ``question`` - + ``question,guidelines`` + requestBody: + content: + application/json: + schema: + type: object + properties: + question: + type: string + description: The example question. + guidelines: + type: array + items: + type: string + description: Guidelines for answering the question. + example_id: + type: string + description: The universally unique identifier (UUID) of the example. + name: + type: string + description: >- + Full resource name: + supervisor-agents/{supervisor_agent_id}/examples/{example_id} + required: + - question + - guidelines + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Example' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + /api/2.1/supervisor-agents/{supervisor_agent_id}: + delete: + operationId: supervisor_agents_delete_supervisor_agent + summary: Deletes a Supervisor Agent. + tags: + - supervisoragents + - supervisor_agents + description: |- + Deletes a Supervisor Agent. + + :param name: str + The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id} + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}`). The resource name of + the Supervisor Agent. Format: + supervisor-agents/{supervisor_agent_id} + responses: + '200': + description: Success + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + get: + operationId: supervisor_agents_get_supervisor_agent + summary: Gets a Supervisor Agent. + tags: + - supervisoragents + - supervisor_agents + description: |- + Gets a Supervisor Agent. + + :param name: str + The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id} + + :returns: :class:`SupervisorAgent` + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}`). The resource name of + the Supervisor Agent. Format: + supervisor-agents/{supervisor_agent_id} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SupervisorAgent' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + patch: + operationId: supervisor_agents_update_supervisor_agent + summary: >- + Updates a Supervisor Agent. The fields that are required depend on the + paths specified in + tags: + - supervisoragents + - supervisor_agents + description: >- + Updates a Supervisor Agent. The fields that are required depend on the + paths specified in + + ``update_mask``. Only fields included in the mask will be updated. + + + :param name: str + The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id} + :param supervisor_agent: :class:`SupervisorAgent` + The SupervisorAgent to update. + :param update_mask: FieldMask + Field mask for fields to be updated. + + :returns: :class:`SupervisorAgent` + parameters: + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}`). The resource name of + the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id} + - name: update_mask + in: query + required: true + schema: + type: object + description: Field mask for fields to be updated. + requestBody: + content: + application/json: + schema: + type: object + properties: + display_name: + type: string + create_time: + type: string + format: date-time + description: Creation timestamp. + creator: + type: string + description: The creator of the Supervisor Agent. + description: + type: string + description: Description of what this agent can do (user-facing). + endpoint_name: + type: string + description: The name of the supervisor agent's serving endpoint. + experiment_id: + type: string + description: The MLflow experiment ID. + id: + type: string + description: 'Deprecated: Use supervisor_agent_id instead.' + instructions: + type: string + description: >- + Optional natural-language instructions for the supervisor + agent. + name: + type: string + description: >- + The resource name of the SupervisorAgent. Format: + supervisor-agents/{supervisor_agent_id} + supervisor_agent_id: + type: string + description: >- + The universally unique identifier (UUID) of the Supervisor + Agent. + required: + - display_name + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SupervisorAgent' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: SupervisorAgentsAPI + /api/2.1/supervisor-agents/{supervisor_agent_id}/tools/{tool_id}: delete: operationId: supervisor_agents_delete_tool summary: Deletes a Tool. @@ -655,13 +897,25 @@ paths: :param name: str The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} parameters: - - name: name + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). The + resource name of the Tool. Format: + supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + - name: tool_id in: path required: true schema: type: string description: >- - The resource name of the Tool. Format: + The `tool_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). The + resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} responses: '200': @@ -692,13 +946,25 @@ paths: :returns: :class:`Tool` parameters: - - name: name + - name: supervisor_agent_id + in: path + required: true + schema: + type: string + description: >- + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). The + resource name of the Tool. Format: + supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + - name: tool_id in: path required: true schema: type: string description: >- - The resource name of the Tool. Format: + The `tool_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). The + resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} responses: '200': @@ -743,13 +1009,25 @@ paths: :returns: :class:`Tool` parameters: - - name: name + - name: supervisor_agent_id in: path required: true schema: type: string description: >- - Full resource name: + The `supervisor_agent_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). Full + resource name: + supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + - name: tool_id + in: path + required: true + schema: + type: string + description: >- + The `tool_id` segment of the `name` resource name + (`supervisor-agents/{supervisor_agent_id}/tools/{tool_id}`). Full + resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} - name: update_mask in: query @@ -763,225 +1041,74 @@ paths: schema: type: object properties: - tool: + tool_type: + type: string + app: type: object properties: - tool_type: - type: string - app: - type: object - properties: - name: - type: string - description: App name - required: - - name - description: 'Databricks app. Supported app: custom mcp, custom agent.' - catalog: - type: object - properties: - name: - type: string - description: >- - Bare UC catalog name this tool is authorized to - search (no ``.``). - required: - - name - description: Configuration for a UC catalog asset_search scope tool. - dashboard: - type: object - properties: - dashboard_id: - type: string - description: The unique identifier of the Lakeview dashboard. - required: - - dashboard_id - description: >- - Lakeview dashboard tool. Replaces the deprecated - ``lakeview_dashboard`` field. - description: + name: type: string - description: Description of what this tool does (user-facing). - genie_space: - type: object - properties: - id: - type: string - space_id: - type: string - description: The ID of the genie space. - required: - - id + description: App name + required: + - name + description: 'Databricks app. Supported app: custom mcp, custom agent.' + description: + type: string + description: Description of what this tool does (user-facing). + genie_space: + type: object + properties: id: type: string - description: 'Deprecated: Use tool_id instead.' - knowledge_assistant: - type: object - properties: - knowledge_assistant_id: - type: string - serving_endpoint_name: - type: string - description: 'Deprecated: use knowledge_assistant_id instead.' - required: - - knowledge_assistant_id - lakeview_dashboard: - type: object - properties: - dashboard_id: - type: string - description: The unique identifier of the Lakeview dashboard. - required: - - dashboard_id - description: 'Deprecated: use ``dashboard`` instead.' + required: + - id + id: + type: string + description: 'Deprecated: Use tool_id instead.' + knowledge_assistant: + type: object + properties: + knowledge_assistant_id: + type: string + serving_endpoint_name: + type: string + description: 'Deprecated: use knowledge_assistant_id instead.' + required: + - knowledge_assistant_id + name: + type: string + description: >- + Full resource name: + supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + tool_id: + type: string + description: User specified id of the Tool. + uc_connection: + type: object + properties: + name: + type: string + required: + - name + description: >- + Databricks UC connection. Supported connection: external mcp + server. + uc_function: + type: object + properties: name: type: string - description: >- - Full resource name: - supervisor-agents/{supervisor_agent_id}/tools/{tool_id} - schema: - type: object - properties: - name: - type: string - description: >- - Full UC schema name (catalog.schema) this tool is - authorized to search. - required: - - name - description: Configuration for a UC schema asset_search scope tool. - serving_endpoint: - type: object - properties: - name: - type: string - required: - - name - skill: - type: object - properties: - path: - type: string - description: >- - Absolute WSFS path to a folder containing skill - subdirectories. Example: - /Workspace/Users/creator@company.com/.assistant/skills - required: - - path - description: >- - Skill tool. Points to a folder containing skill - subdirectories with SKILL.md files. Skills are - discovered from the folder at runtime and loaded on - demand via a read_skill tool. - supervisor_agent: - type: object - properties: - supervisor_agent_id: - type: string - description: The ID of the supervisor agent (tile ID). - required: - - supervisor_agent_id - description: Nested Supervisor Agent tool. - table: - type: object - properties: - name: - type: string - description: >- - Full UC table name (catalog.schema.table) this tool - is authorized to access. - required: - - name - description: >- - Unity Catalog table tool. Replaces the deprecated - ``uc_table`` field. - tool_id: + required: + - name + volume: + type: object + properties: + name: type: string - description: User specified id of the Tool. - uc_connection: - type: object - properties: - name: - type: string - required: - - name - description: >- - Databricks UC connection. Supported connection: external - mcp server. - uc_function: - type: object - properties: - name: - type: string - required: - - name - uc_mcp: - type: object - properties: - name: - type: string - description: >- - Three-level UC FQN of the registered MCP service - (catalog.schema.mcp_service). - required: - - name - description: >- - UC-registered MCP service tool. The ``name`` field on - UcMcpService is the three-level UC FQN - (catalog.schema.mcp_service); the supervisor resolves it - at request build time, calls ``tools/list`` against the - AI Gateway mcp-services proxy, and dynamically registers - every discovered MCP sub-tool as a separately-callable - tool. - uc_table: - type: object - properties: - name: - type: string - description: >- - Full UC table name (catalog.schema.table) this tool - is authorized to access. - required: - - name - description: 'Deprecated: use ``table`` instead.' - vector_search_index: - type: object - properties: - name: - type: string - description: >- - Full Vector Search index name - (catalog.schema.index). - columns: - type: array - items: - type: string - description: >- - Optional columns to return from the index. If unset, - discovered from index schema at query time. - required: - - name - description: Configuration for a Vector Search index tool. - volume: - type: object - properties: - name: - type: string - required: - - name - web_search: - type: object - properties: {} - description: >- - Configuration for a public-web search tool. The - supervisor collapses multiple web_search tools on the - same agent into a single registered ``web_search`` tool - at runtime. required: - - tool_type - description: The Tool to update. + - name required: - - tool + - tool_type responses: '200': description: Success @@ -1246,19 +1373,6 @@ components: required: - name description: 'Databricks app. Supported app: custom mcp, custom agent.' - Catalog: - type: object - properties: - name: - type: string - description: Bare UC catalog name this tool is authorized to search (no ``.``). - required: - - name - description: >- - UC catalog asset_search scope. One tool authorizes asset_search over one - catalog. Multiple - catalog tools widen the scope; the backend merges them into a single CATALOG entry in - asset_search's scoped_assets. Example: type: object properties: @@ -1290,9 +1404,6 @@ components: properties: id: type: string - space_id: - type: string - description: The ID of the genie space. required: - id GetSupervisorAgentPermissionLevelsResponse: @@ -1312,15 +1423,6 @@ components: description: 'Deprecated: use knowledge_assistant_id instead.' required: - knowledge_assistant_id - LakeviewDashboard: - type: object - properties: - dashboard_id: - type: string - description: The unique identifier of the Lakeview dashboard. - required: - - dashboard_id - description: Lakeview Dashboard tool scoped to a specific published dashboard. ListExamplesResponse: type: object properties: @@ -1349,43 +1451,6 @@ components: type: array items: $ref: '#/components/schemas/Tool' - Schema: - type: object - properties: - name: - type: string - description: >- - Full UC schema name (catalog.schema) this tool is authorized to - search. - required: - - name - description: >- - UC schema asset_search scope. One tool authorizes asset_search over one - schema. Multiple schema - tools widen the scope. - ServingEndpoint: - type: object - properties: - name: - type: string - required: - - name - Skill: - type: object - properties: - path: - type: string - description: >- - Absolute WSFS path to a folder containing skill subdirectories. - Example: /Workspace/Users/creator@company.com/.assistant/skills - required: - - path - description: >- - Skill tool. Points to a folder containing skill subdirectories with - SKILL.md files (YAML - frontmatter with name + description, followed by markdown instructions). Skills are discovered - from the folder at runtime and loaded on demand via a read_skill tool registered by the - supervisor. SupervisorAgent: type: object properties: @@ -1484,15 +1549,6 @@ components: type: string permission_level: $ref: '#/components/schemas/SupervisorAgentPermissionLevel' - SupervisorAgentTool: - type: object - properties: - supervisor_agent_id: - type: string - description: The ID of the supervisor agent (tile ID). - required: - - supervisor_agent_id - description: Nested Supervisor Agent tool. Tool: type: object properties: @@ -1500,14 +1556,6 @@ components: type: string app: $ref: '#/components/schemas/App' - catalog: - $ref: '#/components/schemas/Catalog' - description: Configuration for a UC catalog asset_search scope tool. - dashboard: - $ref: '#/components/schemas/LakeviewDashboard' - description: >- - Lakeview dashboard tool. Replaces the deprecated - ``lakeview_dashboard`` field. description: type: string description: Description of what this tool does (user-facing). @@ -1518,32 +1566,11 @@ components: description: 'Deprecated: Use tool_id instead.' knowledge_assistant: $ref: '#/components/schemas/KnowledgeAssistant' - lakeview_dashboard: - $ref: '#/components/schemas/LakeviewDashboard' - description: 'Deprecated: use ``dashboard`` instead.' name: type: string description: >- Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} - schema: - $ref: '#/components/schemas/Schema' - description: Configuration for a UC schema asset_search scope tool. - serving_endpoint: - $ref: '#/components/schemas/ServingEndpoint' - skill: - $ref: '#/components/schemas/Skill' - description: >- - Skill tool. Points to a folder containing skill subdirectories with - SKILL.md files. Skills are discovered from the folder at runtime and - loaded on demand via a read_skill tool. - supervisor_agent: - $ref: '#/components/schemas/SupervisorAgentTool' - table: - $ref: '#/components/schemas/UcTable' - description: >- - Unity Catalog table tool. Replaces the deprecated ``uc_table`` - field. tool_id: type: string description: User specified id of the Tool. @@ -1551,28 +1578,8 @@ components: $ref: '#/components/schemas/UcConnection' uc_function: $ref: '#/components/schemas/UcFunction' - uc_mcp: - $ref: '#/components/schemas/UcMcpService' - description: >- - UC-registered MCP service tool. The ``name`` field on UcMcpService - is the three-level UC FQN (catalog.schema.mcp_service); the - supervisor resolves it at request build time, calls ``tools/list`` - against the AI Gateway mcp-services proxy, and dynamically registers - every discovered MCP sub-tool as a separately-callable tool. - uc_table: - $ref: '#/components/schemas/UcTable' - description: 'Deprecated: use ``table`` instead.' - vector_search_index: - $ref: '#/components/schemas/VectorSearchIndex' - description: Configuration for a Vector Search index tool. volume: $ref: '#/components/schemas/Volume' - web_search: - $ref: '#/components/schemas/WebSearch' - description: >- - Configuration for a public-web search tool. The supervisor collapses - multiple web_search tools on the same agent into a single registered - ``web_search`` tool at runtime. required: - tool_type UcConnection: @@ -1590,54 +1597,6 @@ components: type: string required: - name - UcMcpService: - type: object - properties: - name: - type: string - description: >- - Three-level UC FQN of the registered MCP service - (catalog.schema.mcp_service). - required: - - name - description: >- - UC-registered MCP service tool. The ``name`` field is the three-level UC - FQN of the MCP service - (``catalog.schema.mcp_service``). At request build time the supervisor calls ``tools/list`` - against the AI Gateway mcp-services proxy and dynamically registers every discovered MCP - sub-tool as a separately-callable tool. Per-sub-tool config is not stored here — discovery is - dynamic so newly published MCP functions are picked up without redeploying the agent. - UcTable: - type: object - properties: - name: - type: string - description: >- - Full UC table name (catalog.schema.table) this tool is authorized to - access. - required: - - name - description: >- - Unity Catalog table. One tool represents one authorized table; the - backend collapses all - uc_table tools on a supervisor agent into a single subagent that can access the union of their - tables. - VectorSearchIndex: - type: object - properties: - name: - type: string - description: Full Vector Search index name (catalog.schema.index). - columns: - type: array - items: - type: string - description: >- - Optional columns to return from the index. If unset, discovered from - index schema at query time. - required: - - name - description: Vector Search index tool authorizing access to a single index. Volume: type: object properties: @@ -1645,15 +1604,6 @@ components: type: string required: - name - WebSearch: - type: object - properties: {} - description: >- - Public-web search tool. Empty body — backend, model registration, and - client_id are not - customer-tunable. The display name and description for this tool come from the parent - ``Tool.name`` / ``Tool.description`` fields. Reserved for future scoping (allowed domains, - region overrides). SupervisorAgentPermissionLevel: type: string x-enum: @@ -1671,24 +1621,53 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1{parent}~1examples/post' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1examples/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.1~1{parent}~1examples/get' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1examples/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.examples + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1examples~1{example_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1examples~1{example_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1examples~1{example_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/examples/methods/get' - $ref: '#/components/x-stackQL-resources/examples/methods/list' insert: - $ref: '#/components/x-stackQL-resources/examples/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/examples/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/examples/methods/delete' replace: [] supervisor_agents: id: databricks_workspace.supervisoragents.supervisor_agents @@ -1711,13 +1690,38 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.supervisor_agents + delete: + operation: + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/supervisor_agents/methods/get' - $ref: '#/components/x-stackQL-resources/supervisor_agents/methods/list' insert: - $ref: '#/components/x-stackQL-resources/supervisor_agents/methods/create' - update: [] - delete: [] + update: + - $ref: '#/components/x-stackQL-resources/supervisor_agents/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/supervisor_agents/methods/delete' replace: [] tools: id: databricks_workspace.supervisoragents.tools @@ -1729,26 +1733,30 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1{parent}~1tools/post' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1tools/post response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1api~12.1~1{parent}~1tools/get' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1tools/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tools delete: operation: - $ref: '#/paths/~1api~12.1~1{name}/delete' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1tools~1{tool_id}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1api~12.1~1{name}/get' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1tools~1{tool_id}/get response: mediaType: application/json openAPIDocKey: '200' @@ -1757,14 +1765,15 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: '#/paths/~1api~12.1~1{name}/patch' + $ref: >- + #/paths/~1api~12.1~1supervisor-agents~1{supervisor_agent_id}~1tools~1{tool_id}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tools/methods/list' - $ref: '#/components/x-stackQL-resources/tools/methods/get' + - $ref: '#/components/x-stackQL-resources/tools/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tools/methods/create' update: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml b/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml index 63146523..a085c439 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.tags servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.1/tag-policies: post: @@ -48,66 +65,29 @@ paths: schema: type: object properties: - tag_policy: - type: object - properties: - tag_key: - type: string - account_id: - type: string - description: The account ID that owns this tag policy. - create_time: - type: string - description: Timestamp when the tag policy was created - description: - type: string - id: - type: string - propagation_config: - type: object - properties: - conflict_resolution: - type: object - properties: - default_value_override: - type: object - properties: - default_value: - type: string - description: >- - The tag value to apply when conflicts are - detected. This value must be one of the - allowed values defined in the tag policy. - description: >- - Uses a specified default value to override when - conflicts happen. - description: >- - Policy that determines how to resolve conflicts when - multiple upstream sources have different tag values. - enabled: - type: boolean - description: >- - Determines whether this tag should automatically - propagate through lineage. - description: >- - Configuration that controls how tags are automatically - propagated through data lineage. - update_time: - type: string - description: Timestamp when the tag policy was last updated - values: - type: array - items: - type: object - properties: - name: - type: string - required: - - name - required: - - tag_key + tag_key: + type: string + create_time: + type: string + description: Timestamp when the tag policy was created + description: + type: string + id: + type: string + update_time: + type: string + description: Timestamp when the tag policy was last updated + values: + type: array + items: + type: object + properties: + name: + type: string + required: + - name required: - - tag_policy + - tag_key responses: '200': description: Success @@ -352,66 +332,29 @@ paths: schema: type: object properties: - tag_policy: - type: object - properties: - tag_key: - type: string - account_id: - type: string - description: The account ID that owns this tag policy. - create_time: - type: string - description: Timestamp when the tag policy was created - description: - type: string - id: - type: string - propagation_config: - type: object - properties: - conflict_resolution: - type: object - properties: - default_value_override: - type: object - properties: - default_value: - type: string - description: >- - The tag value to apply when conflicts are - detected. This value must be one of the - allowed values defined in the tag policy. - description: >- - Uses a specified default value to override when - conflicts happen. - description: >- - Policy that determines how to resolve conflicts when - multiple upstream sources have different tag values. - enabled: - type: boolean - description: >- - Determines whether this tag should automatically - propagate through lineage. - description: >- - Configuration that controls how tags are automatically - propagated through data lineage. - update_time: - type: string - description: Timestamp when the tag policy was last updated - values: - type: array - items: - type: object - properties: - name: - type: string - required: - - name - required: - - tag_key + tag_key: + type: string + create_time: + type: string + description: Timestamp when the tag policy was created + description: + type: string + id: + type: string + update_time: + type: string + description: Timestamp when the tag policy was last updated + values: + type: array + items: + type: object + properties: + name: + type: string + required: + - name required: - - tag_policy + - tag_key responses: '200': description: Success @@ -450,30 +393,25 @@ paths: schema: type: object properties: - tag_assignment: - type: object - properties: - entity_type: - type: string - entity_id: - type: string - description: >- - The identifier of the entity to which the tag is - assigned. For apps, the entity_id is the app name - tag_key: - type: string - description: >- - The key of the tag. The characters , . : / - = and - leading/trailing spaces are not allowed - tag_value: - type: string - description: The value of the tag - required: - - entity_type - - entity_id - - tag_key + entity_type: + type: string + entity_id: + type: string + description: >- + The identifier of the entity to which the tag is assigned. + For apps, the entity_id is the app name + tag_key: + type: string + description: >- + The key of the tag. The characters , . : / - = and + leading/trailing spaces are not allowed + tag_value: + type: string + description: The value of the tag required: - - tag_assignment + - entity_type + - entity_id + - tag_key responses: '200': description: Success @@ -688,30 +626,25 @@ paths: schema: type: object properties: - tag_assignment: - type: object - properties: - entity_type: - type: string - entity_id: - type: string - description: >- - The identifier of the entity to which the tag is - assigned. For apps, the entity_id is the app name - tag_key: - type: string - description: >- - The key of the tag. The characters , . : / - = and - leading/trailing spaces are not allowed - tag_value: - type: string - description: The value of the tag - required: - - entity_type - - entity_id - - tag_key + entity_type: + type: string + entity_id: + type: string + description: >- + The identifier of the entity to which the tag is assigned. + For apps, the entity_id is the app name + tag_key: + type: string + description: >- + The key of the tag. The characters , . : / - = and + leading/trailing spaces are not allowed + tag_value: + type: string + description: The value of the tag required: - - tag_assignment + - entity_type + - entity_id + - tag_key responses: '200': description: Success @@ -806,27 +739,6 @@ paths: x-stackql-sdk-source: WorkspaceEntityTagAssignmentsAPI components: schemas: - ConflictResolutionPolicy: - type: object - properties: - default_value_override: - $ref: '#/components/schemas/DefaultValueOverridePolicy' - description: Uses a specified default value to override when conflicts happen. - description: >- - Policy that determines how to resolve conflicts when multiple upstream - sources have different - tag values. - DefaultValueOverridePolicy: - type: object - properties: - default_value: - type: string - description: >- - The tag value to apply when conflicts are detected. This value must - be one of the allowed values defined in the tag policy. - description: >- - Policy that specifies a default value to use when resolving tag - conflicts during propagation. ListTagAssignmentsResponse: type: object properties: @@ -845,22 +757,6 @@ components: type: array items: $ref: '#/components/schemas/TagPolicy' - PropagationConfig: - type: object - properties: - conflict_resolution: - $ref: '#/components/schemas/ConflictResolutionPolicy' - description: >- - Policy that determines how to resolve conflicts when multiple - upstream sources have different tag values. - enabled: - type: boolean - description: >- - Determines whether this tag should automatically propagate through - lineage. - description: >- - Configuration that controls how tags are automatically propagated - through data lineage. TagAssignment: type: object properties: @@ -888,9 +784,6 @@ components: properties: tag_key: type: string - account_id: - type: string - description: The account ID that owns this tag policy. create_time: type: string description: Timestamp when the tag policy was created @@ -898,11 +791,6 @@ components: type: string id: type: string - propagation_config: - $ref: '#/components/schemas/PropagationConfig' - description: >- - Configuration that controls how tags are automatically propagated - through data lineage. update_time: type: string description: Timestamp when the tag policy was last updated diff --git a/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml index d9ff6f1a..e50a7740 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml @@ -6,14 +6,31 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.vectorsearch servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/vector-search/endpoints: post: @@ -31,8 +48,6 @@ paths: Type of endpoint :param budget_policy_id: str (optional) The budget policy id to be applied - :param num_replicas: int (optional) - Initial number of replicas for the endpoint. If not specified, defaults to 1. :param target_qps: int (optional) Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is calculated at index creation/sync time based on this value. Best-effort target; the system does not @@ -61,11 +76,6 @@ paths: budget_policy_id: type: string description: The budget policy id to be applied - num_replicas: - type: integer - description: >- - Initial number of replicas for the endpoint. If not - specified, defaults to 1. target_qps: type: integer description: >- @@ -224,12 +234,6 @@ paths: :param endpoint_name: str Name of the AI Search endpoint - :param replication_factor: int (optional) - OpenSearch replication factor. Directly sets userThroughputSettings.replicationFactor. Mutually - exclusive with target_qps (and the deprecated min_qps alias). Must be non-negative (0 = no - replication). The autoscaler caps the effective value based on endpoint scaling settings. Note: This - is the raw replication factor, not "total data copies". For the user-facing replica count (which - uses total-copies semantics), see PatchEndpointThroughputRequest.num_replicas. :param target_qps: int (optional) Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS will be achieved. @@ -247,17 +251,6 @@ paths: schema: type: object properties: - replication_factor: - type: integer - description: >- - OpenSearch replication factor. Directly sets - userThroughputSettings.replicationFactor. Mutually exclusive - with target_qps (and the deprecated min_qps alias). Must be - non-negative (0 = no replication). The autoscaler caps the - effective value based on endpoint scaling settings. Note: - This is the raw replication factor, not "total data copies". - For the user-facing replica count (which uses total-copies - semantics), see PatchEndpointThroughputRequest.num_replicas. target_qps: type: integer description: >- @@ -518,95 +511,6 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchEndpointsAPI - /api/2.0/vector-search/endpoints/{endpoint_name}/throughput: - patch: - operationId: vector_search_endpoints_patch_endpoint_throughput - summary: Update the throughput (concurrency) of an endpoint - tags: - - vectorsearch - - vector_search_endpoints - description: |- - Update the throughput (concurrency) of an endpoint - - :param endpoint_name: str - Name of the AI Search endpoint - :param all_or_nothing: bool (optional) - If true, the request will fail if the requested concurrency or limits cannot be exactly met. If - false, the request will be adjusted to the closest possible value. - :param concurrency: float (optional) - Requested concurrency (total CPU) for the endpoint. If not specified, the current concurrency is - maintained. - :param maximum_concurrency_allowed: float (optional) - Maximum concurrency allowed for the endpoint. If not specified, the current maximum is maintained. - :param minimal_concurrency_allowed: float (optional) - Minimum concurrency allowed for the endpoint. If not specified, the current minimum is maintained. - :param num_replicas: int (optional) - Requested number of data copies for the endpoint (including primary). For example: num_replicas=2 - means 2 total copies of the data (1 primary + 1 replica). If not specified, the current replication - factor is maintained. Valid range: 1-6 (where 1 = no replication, 6 = 1 primary + 5 replicas). - - :returns: :class:`PatchEndpointThroughputResponse` - parameters: - - name: endpoint_name - in: path - required: true - schema: - type: string - description: Name of the AI Search endpoint - requestBody: - content: - application/json: - schema: - type: object - properties: - all_or_nothing: - type: boolean - description: >- - If true, the request will fail if the requested concurrency - or limits cannot be exactly met. If false, the request will - be adjusted to the closest possible value. - concurrency: - type: number - description: >- - Requested concurrency (total CPU) for the endpoint. If not - specified, the current concurrency is maintained. - maximum_concurrency_allowed: - type: number - description: >- - Maximum concurrency allowed for the endpoint. If not - specified, the current maximum is maintained. - minimal_concurrency_allowed: - type: number - description: >- - Minimum concurrency allowed for the endpoint. If not - specified, the current minimum is maintained. - num_replicas: - type: integer - description: >- - Requested number of data copies for the endpoint (including - primary). For example: num_replicas=2 means 2 total copies - of the data (1 primary + 1 replica). If not specified, the - current replication factor is maintained. Valid range: 1-6 - (where 1 = no replication, 6 = 1 primary + 5 replicas). - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PatchEndpointThroughputResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: VectorSearchEndpointsAPI /api/2.0/vector-search/endpoints/{name}/metrics: post: operationId: vector_search_endpoints_retrieve_user_visible_metrics @@ -701,6 +605,96 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchEndpointsAPI + /api/2.0/vector-search/endpoints/{endpoint_name}/start: + post: + operationId: vector_search_endpoints_start_endpoint + summary: >- + Start a stopped endpoint. The endpoint serves the same indexes it had + when it stopped. + tags: + - vectorsearch + - vector_search_endpoints + description: >- + Start a stopped endpoint. The endpoint serves the same indexes it had + when it stopped. + + + :param endpoint_name: str + Name of the AI Search endpoint + + :returns: :class:`EndpointInfo` + parameters: + - name: endpoint_name + in: path + required: true + schema: + type: string + description: Name of the AI Search endpoint + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/EndpointInfo' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: VectorSearchEndpointsAPI + /api/2.0/vector-search/endpoints/{endpoint_name}/stop: + post: + operationId: vector_search_endpoints_stop_endpoint + summary: >- + Stop an endpoint. Stopping removes the endpoint's serving compute and + retains its indexes. A stopped + tags: + - vectorsearch + - vector_search_endpoints + description: >- + Stop an endpoint. Stopping removes the endpoint's serving compute and + retains its indexes. A stopped + + endpoint can't serve queries or sync indexes until it is started. + + + :param endpoint_name: str + Name of the AI Search endpoint + + :returns: :class:`EndpointInfo` + parameters: + - name: endpoint_name + in: path + required: true + schema: + type: string + description: Name of the AI Search endpoint + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/EndpointInfo' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: VectorSearchEndpointsAPI /api/2.0/vector-search/endpoints/{endpoint_name}/budget-policy: patch: operationId: vector_search_endpoints_update_endpoint_budget_policy @@ -893,11 +887,6 @@ paths: the source table are synced with the index. The primary key column and embedding source column or embedding vector column are always synced. - effective_budget_policy_id: - type: string - description: The budget policy id applied to the AI Search index - effective_usage_policy_id: - type: string embedding_source_columns: type: array items: @@ -982,13 +971,6 @@ paths: description: >- The columns that contain the embedding vectors. The format should be array[double]. - requested_schema_json: - type: string - description: >- - The index schema exactly as the user supplied it on - create, preserving the original type spellings (e.g. - ``integer``) rather than Unity Catalog's canonical names - (e.g. ``int``) that ``schema_json`` returns. schema_json: type: string description: >- @@ -1220,140 +1202,6 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchIndexesAPI - /api/2.0/vector-search/indexes/{name}/autoeval: - get: - operationId: vector_search_indexes_get_auto_eval_status - summary: Returns the status of the latest autoeval run for a vector index. - tags: - - vectorsearch - - vector_search_indexes - description: |- - Returns the status of the latest autoeval run for a vector index. - - :param name: str - Fully qualified index name (catalog.schema.index). - - :returns: :class:`GetAutoEvalStatusResponse` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Fully qualified index name (catalog.schema.index). - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetAutoEvalStatusResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: VectorSearchIndexesAPI - post: - operationId: vector_search_indexes_run_auto_eval - summary: Triggers an autoeval quality evaluation for a vector index. - tags: - - vectorsearch - - vector_search_indexes - description: |- - Triggers an autoeval quality evaluation for a vector index. - - :param name: str - Fully qualified index name (catalog.schema.index). - :param num_queries: int (optional) - Number of queries to generate for evaluation (default: 50). - :param num_results: int (optional) - Number of results to fetch per query (default: 10). - :param query_types: List[str] (optional) - Query types to evaluate (default: FULL_TEXT, ANN, HYBRID). - :param queryset_query_column: str (optional) - Column in ``queryset_table`` holding the query text. Required when ``queryset_table`` is set; - ignored otherwise. - :param queryset_relevant_docs_column: str (optional) - Optional column in ``queryset_table`` holding the ground-truth relevant document IDs for each query - (STRING or ARRAY). When set, recall@k is reported against these labels; when unset, - evaluation falls back to LLM-judged metrics only. Ignored when ``queryset_table`` is unset. - :param queryset_table: str (optional) - Fully qualified Unity Catalog table (catalog.schema.table) of evaluation queries to run against the - index. When set, queries are read from this table and synthetic query generation is skipped. The - table takes precedence over any automatically detected query source. - - :returns: :class:`RunAutoEvalResponse` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Fully qualified index name (catalog.schema.index). - requestBody: - content: - application/json: - schema: - type: object - properties: - num_queries: - type: integer - description: 'Number of queries to generate for evaluation (default: 50).' - num_results: - type: integer - description: 'Number of results to fetch per query (default: 10).' - query_types: - type: array - items: - type: string - description: 'Query types to evaluate (default: FULL_TEXT, ANN, HYBRID).' - queryset_query_column: - type: string - description: >- - Column in ``queryset_table`` holding the query text. - Required when ``queryset_table`` is set; ignored otherwise. - queryset_relevant_docs_column: - type: string - description: >- - Optional column in ``queryset_table`` holding the - ground-truth relevant document IDs for each query (STRING or - ARRAY). When set, recall@k is reported against these - labels; when unset, evaluation falls back to LLM-judged - metrics only. Ignored when ``queryset_table`` is unset. - queryset_table: - type: string - description: >- - Fully qualified Unity Catalog table (catalog.schema.table) - of evaluation queries to run against the index. When set, - queries are read from this table and synthetic query - generation is skipped. The table takes precedence over any - automatically detected query source. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/RunAutoEvalResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: VectorSearchIndexesAPI /api/2.0/vector-search/indexes/{index_name}/query: post: operationId: vector_search_indexes_query_index @@ -1484,18 +1332,6 @@ paths: properties: model: type: string - model_type: - type: string - x-enum: - - MODEL_TYPE_BASE - - MODEL_TYPE_FINETUNED - description: >- - EXPERIMENTAL. Discriminator for how the ``model`` field - is interpreted: BASE/UNSPECIFIED expects the literal - "databricks_reranker"; FINETUNED treats ``model`` as a - Model Serving endpoint name in the caller's workspace. - See the doc comment on ``model`` for the per-case - contract. parameters: type: object properties: @@ -1614,104 +1450,6 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchIndexesAPI - /api/2.0/vector-search/indexes/{name}/reranker-finetuning: - post: - operationId: vector_search_indexes_run_reranker_finetuning - summary: Triggers reranker finetuning for a vector index. - tags: - - vectorsearch - - vector_search_indexes - description: |- - Triggers reranker finetuning for a vector index. - - :param name: str - Fully qualified index name (catalog.schema.index). - :param embedding_model: str (optional) - Model-serving endpoint name. Reranker finetuning only supports managed Delta Sync indices - (Databricks-computed embeddings), so this field is informational — it is auto-derived from the - index and not used to embed training queries locally. - :param model_name: str (optional) - Fully qualified UC name for the registered finetuned model (catalog.schema.model). When unset, the - handler derives a default of ``..reranker_`` from ``name``. - :param num_queries: int (optional) - Cap on the number of queries sampled from ``query_table`` (or generated when ``query_table`` is - unset). Use -1 to process all queries (the data-gen default). Lower values cut LLM-judge cost and - run time. - :param query_column: str (optional) - Column in ``query_table`` containing the query text. Ignored when ``query_table`` is unset. Defaults - to "query_text" when omitted. - :param query_table: str (optional) - Optional fully qualified UC Delta table holding training queries (catalog.schema.table). When unset, - the data-gen job synthesises queries from the index corpus via an LLM. - - :returns: :class:`RunRerankerFinetuningResponse` - parameters: - - name: name - in: path - required: true - schema: - type: string - description: Fully qualified index name (catalog.schema.index). - requestBody: - content: - application/json: - schema: - type: object - properties: - embedding_model: - type: string - description: >- - Model-serving endpoint name. Reranker finetuning only - supports managed Delta Sync indices (Databricks-computed - embeddings), so this field is informational — it is - auto-derived from the index and not used to embed training - queries locally. - model_name: - type: string - description: >- - Fully qualified UC name for the registered finetuned model - (catalog.schema.model). When unset, the handler derives a - default of - ``..reranker_`` from - ``name``. - num_queries: - type: integer - description: >- - Cap on the number of queries sampled from ``query_table`` - (or generated when ``query_table`` is unset). Use -1 to - process all queries (the data-gen default). Lower values cut - LLM-judge cost and run time. - query_column: - type: string - description: >- - Column in ``query_table`` containing the query text. Ignored - when ``query_table`` is unset. Defaults to "query_text" when - omitted. - query_table: - type: string - description: >- - Optional fully qualified UC Delta table holding training - queries (catalog.schema.table). When unset, the data-gen job - synthesises queries from the index corpus via an LLM. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/RunRerankerFinetuningResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: VectorSearchIndexesAPI /api/2.0/vector-search/indexes/{index_name}/scan: post: operationId: vector_search_indexes_scan_index @@ -1808,57 +1546,6 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchIndexesAPI - /api/2.0/vector-search/indexes/{index_name}/usage-policy: - patch: - operationId: vector_search_indexes_update_index_budget_policy - summary: Update the budget policy of an index - tags: - - vectorsearch - - vector_search_indexes - description: |- - Update the budget policy of an index - - :param index_name: str - Name of the AI Search index - :param usage_policy_id: str (optional) - The usage policy id to be applied - - :returns: :class:`UpdateVectorIndexUsagePolicyResponse` - parameters: - - name: index_name - in: path - required: true - schema: - type: string - description: Name of the AI Search index - requestBody: - content: - application/json: - schema: - type: object - properties: - usage_policy_id: - type: string - description: The usage policy id to be applied - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateVectorIndexUsagePolicyResponse' - default: - description: Error response - content: - application/json: - schema: - type: object - properties: - error: - type: string - message: - type: string - x-stackql-sdk-source: VectorSearchIndexesAPI /api/2.0/vector-search/indexes/{index_name}/upsert-data: post: operationId: vector_search_indexes_upsert_data_vector_index @@ -1916,65 +1603,6 @@ paths: x-stackql-sdk-source: VectorSearchIndexesAPI components: schemas: - AdjustedThroughputRequest: - type: object - properties: - concurrency: - type: number - description: Adjusted concurrency (total CPU) for the endpoint - maximum_concurrency_allowed: - type: number - description: Adjusted maximum concurrency allowed for the endpoint - minimal_concurrency_allowed: - type: number - description: Adjusted minimum concurrency allowed for the endpoint - description: Adjusted throughput request parameters - AutoEvalJob: - type: object - properties: - current_stage: - $ref: '#/components/schemas/AutoEvalStage' - description: Pipeline stage currently in progress. - dashboard_url: - type: string - description: Lakeview dashboard URL for the latest run's results. - metrics_table_full_name: - type: string - description: >- - Fully qualified Delta table name where per-run metrics are persisted - (``autoeval_metrics_``). - mlflow_experiment_id: - type: string - description: >- - MLflow experiment_id used by the autoeval wheel. Stable per index. - The UI uses this to construct an "Open in MLflow" deep link without - an additional MLflow tag fetch. - mlflow_run_id: - type: string - description: MLflow run_id of the latest autoeval run. Per-run, latest only. - overall_progress: - type: number - description: >- - Overall progress across all stages, in the range [0.0, 1.0]. Capped - at 0.99 while the run is RUNNING — the bar only reaches 1.0 when - status flips to AUTO_EVAL_DISPLAY_STATUS_SUCCEEDED. - progress_on_current_stage: - type: integer - description: >- - Items completed within the current stage (e.g., queries generated, - (query_type, reranker, phase) tuples evaluated, results saved). - results_table_full_name: - type: string - description: >- - Fully qualified Delta table name where per-query results are - persisted (``autoeval_results_``). - total_for_current_stage: - type: integer - description: Total items expected within the current stage. - description: >- - State of the most recent autoeval Databricks Jobs background-compute run - for an index. The UI - uses this to render the staged progress bar. ColumnInfo: type: object properties: @@ -2033,11 +1661,6 @@ components: leave this field blank, all columns from the source table are synced with the index. The primary key column and embedding source column or embedding vector column are always synced. - effective_budget_policy_id: - type: string - description: The budget policy id applied to the AI Search index - effective_usage_policy_id: - type: string embedding_source_columns: type: array items: @@ -2082,11 +1705,6 @@ components: leave this field blank, all columns from the source table are synced with the index. The primary key column and embedding source column or embedding vector column are always synced. - effective_budget_policy_id: - type: string - description: The budget policy id applied to the AI Search index - effective_usage_policy_id: - type: string embedding_source_columns: type: array items: @@ -2132,13 +1750,6 @@ components: description: >- The columns that contain the embedding vectors. The format should be array[double]. - requested_schema_json: - type: string - description: >- - The index schema exactly as the user supplied it on create, - preserving the original type spellings (e.g. ``integer``) rather - than Unity Catalog's canonical names (e.g. ``int``) that - ``schema_json`` returns. schema_json: type: string description: >- @@ -2210,17 +1821,21 @@ components: scaling_info: $ref: '#/components/schemas/EndpointScalingInfo' description: Scaling information for the endpoint - throughput_info: - $ref: '#/components/schemas/EndpointThroughputInfo' - description: Throughput information for the endpoint EndpointScalingInfo: type: object properties: requested_target_qps: type: integer + description: >- + The requested QPS target for the endpoint. Best-effort; the system + does not guarantee this QPS will be achieved. state: $ref: '#/components/schemas/ScalingChangeState' description: The current state of the scaling change request. + description: >- + Scaling information for a Standard endpoint: the current scaling state, + the requested QPS + target, and the progress of an in-progress scaling change. EndpointStatus: type: object properties: @@ -2231,37 +1846,6 @@ components: $ref: '#/components/schemas/EndpointStatusState' description: Current state of the endpoint description: Status information of an endpoint - EndpointThroughputInfo: - type: object - properties: - change_request_message: - type: string - description: Additional information about the throughput change request - change_request_state: - $ref: '#/components/schemas/ThroughputChangeRequestState' - description: The state of the most recent throughput change request - current_concurrency: - type: number - description: The current concurrency (total CPU) allocated to the endpoint - current_concurrency_utilization_percentage: - type: number - description: The current utilization of concurrency as a percentage (0-100) - current_num_replicas: - type: integer - description: The current number of replicas allocated to the endpoint - maximum_concurrency_allowed: - type: number - description: The maximum concurrency allowed for this endpoint - minimal_concurrency_allowed: - type: number - description: The minimum concurrency allowed for this endpoint - requested_concurrency: - type: number - description: The requested concurrency (total CPU) for the endpoint - requested_num_replicas: - type: integer - description: The requested number of replicas for the endpoint - description: Throughput information for an endpoint FacetResultData: type: object properties: @@ -2278,38 +1862,6 @@ components: type: integer description: Number of facet rows returned. description: Facet aggregation rows returned by a query. - GetAutoEvalStatusResponse: - type: object - properties: - end_time_ms: - type: integer - job_id: - type: string - description: >- - Databricks Jobs job_id of the autoeval background-compute job for - this index, so the UI can surface a link to the job. Unset when no - autoeval job exists for the index yet. - latest_run: - $ref: '#/components/schemas/AutoEvalJob' - description: >- - State of the latest autoeval run, including stage progress. - Populated only while status is AUTO_EVAL_DISPLAY_STATUS_RUNNING and - the running wheel has reported at least one stage update. Absent for - terminal states. - run_as_user: - type: string - description: >- - The user the latest job run was created as. Used by the UI to - construct the per-run MLflow dashboard URL. - state_message: - type: string - description: >- - Free-form failure copy from the underlying job. Populated only when - status is AUTO_EVAL_DISPLAY_STATUS_FAILED. Capped server-side to - bound payload size when the job emits long stack traces. - status: - $ref: '#/components/schemas/AutoEvalDisplayStatus' - description: Current display status of the latest autoeval run. GetVectorSearchEndpointPermissionLevelsResponse: type: object properties: @@ -2432,17 +1984,6 @@ components: effective_budget_policy_id: type: string description: The budget policy applied to the AI Search endpoint. - PatchEndpointThroughputResponse: - type: object - properties: - adjusted_request: - $ref: '#/components/schemas/AdjustedThroughputRequest' - message: - type: string - description: Message explaining the status or any adjustments made - status: - $ref: '#/components/schemas/ThroughputPatchStatus' - description: The status of the throughput change request QueryVectorIndexResponse: type: object properties: @@ -2467,14 +2008,6 @@ components: properties: model: type: string - model_type: - $ref: '#/components/schemas/RerankerConfigModelType' - description: >- - EXPERIMENTAL. Discriminator for how the ``model`` field is - interpreted: BASE/UNSPECIFIED expects the literal - "databricks_reranker"; FINETUNED treats ``model`` as a Model Serving - endpoint name in the caller's workspace. See the doc comment on - ``model`` for the per-case contract. parameters: $ref: '#/components/schemas/RerankerConfigRerankerParameters' description: >- @@ -2535,12 +2068,6 @@ components: A token that can be used to get the next page of results. If not present, there are no more results to show. description: Response containing user-visible metrics - RunAutoEvalResponse: - type: object - properties: {} - RunRerankerFinetuningResponse: - type: object - properties: {} ScanVectorIndexResponse: type: object properties: @@ -2573,14 +2100,6 @@ components: name: type: string description: The name of the AI Search endpoint whose custom tags were updated. - UpdateVectorIndexUsagePolicyResponse: - type: object - properties: - effective_usage_policy_id: - type: string - usage_policy_id: - type: string - description: The updated usage policy id UpsertDataResult: type: object properties: @@ -2715,62 +2234,6 @@ components: type: string permission_level: $ref: '#/components/schemas/VectorSearchEndpointPermissionLevel' - AutoEvalDisplayStatus: - type: string - x-enum: - - AUTO_EVAL_DISPLAY_STATUS_FAILED - - AUTO_EVAL_DISPLAY_STATUS_PENDING - - AUTO_EVAL_DISPLAY_STATUS_RUNNING - - AUTO_EVAL_DISPLAY_STATUS_SUCCEEDED - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. - AutoEvalStage: - type: string - x-enum: - - AUTO_EVAL_STAGE_FEW_SHOT_QUERIES - - AUTO_EVAL_STAGE_GENERATE_QUERIES - - AUTO_EVAL_STAGE_GENERATE_RESULTS - - AUTO_EVAL_STAGE_METRICS_COMPUTATION - description: >- - Pipeline stages within a single autoeval run, in execution order. Used - together with AutoEvalJob - - to drive a staged progress bar in the UI. DeleteDataStatus: type: string x-enum: @@ -2822,6 +2285,9 @@ components: - ONLINE - PROVISIONING - RED_STATE + - STARTING + - STOPPED + - STOPPING - YELLOW_STATE description: Current state of the endpoint EndpointType: @@ -2864,12 +2330,6 @@ components: - ``CONTINUOUS``: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh. - RerankerConfigModelType: - type: string - x-enum: - - MODEL_TYPE_BASE - - MODEL_TYPE_FINETUNED - description: EXPERIMENTAL. Selects how ``model`` is interpreted. ScalingChangeState: type: string x-enum: @@ -2913,23 +2373,6 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. - ThroughputChangeRequestState: - type: string - x-enum: - - CHANGE_ADJUSTED - - CHANGE_FAILED - - CHANGE_IN_PROGRESS - - CHANGE_REACHED_MAXIMUM - - CHANGE_REACHED_MINIMUM - - CHANGE_SUCCESS - description: Throughput change request state - ThroughputPatchStatus: - type: string - x-enum: - - PATCH_ACCEPTED - - PATCH_FAILED - - PATCH_REJECTED - description: Response status for throughput change requests UpsertDataStatus: type: string x-enum: @@ -3039,6 +2482,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + start: + operation: + $ref: >- + #/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}~1start/post + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: >- + #/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}~1stop/post + response: + mediaType: application/json + openAPIDocKey: '200' update_endpoint_budget_policy: config: requestBodyTranslate: @@ -3084,16 +2541,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch_throughput: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}~1throughput/patch - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: [] insert: [] @@ -3264,54 +2711,6 @@ components: delete: - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' replace: [] - vector_search_indexes: - id: databricks_workspace.vectorsearch.vector_search_indexes - name: vector_search_indexes - title: Vector Search Indexes - methods: - vector_search_indexes_get_auto_eval_status: - operation: - $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{name}~1autoeval/get' - response: - mediaType: application/json - openAPIDocKey: '200' - run_auto_eval: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: '#/paths/~1api~12.0~1vector-search~1indexes~1{name}~1autoeval/post' - response: - mediaType: application/json - openAPIDocKey: '200' - run_reranker_finetuning: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1vector-search~1indexes~1{name}~1reranker-finetuning/post - response: - mediaType: application/json - openAPIDocKey: '200' - update_index_budget_policy: - config: - requestBodyTranslate: - algorithm: naive - operation: - $ref: >- - #/paths/~1api~12.0~1vector-search~1indexes~1{index_name}~1usage-policy/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/vector_search_indexes/methods/vector_search_indexes_get_auto_eval_status - insert: [] - update: [] - delete: [] - replace: [] x-stackQL-config: pagination: requestToken: diff --git a/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml index e87a2eee..d66539e8 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml @@ -6,14 +6,31 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.123.0 - x-stackql-date-generated: '2026-07-31' + x-stackql-date-generated: '2026-11-01' x-stackql-sdk-namespace: databricks.sdk.service.workspace servers: - - url: https://{deployment_name}.cloud.databricks.com + - url: https://{deployment_name}.{workspace_domain} variables: deployment_name: - description: The Databricks Workspace Deployment Name + description: >- + The Databricks workspace deployment name: the host prefix of the + workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on + Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to + default it for the session. default: dbc-abcd0123-a1bc + x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME + workspace_domain: + description: >- + The Databricks workspace domain suffix for the cloud. Selected by + DATABRICKS_CLOUD (aws, azure or gcp; default aws). + default: cloud.databricks.com + x-stackQL-envVarSelector: + envVar: DATABRICKS_CLOUD + default: aws + values: + aws: cloud.databricks.com + azure: azuredatabricks.net + gcp: gcp.databricks.com paths: /api/2.0/git-credentials: post: @@ -35,8 +52,7 @@ paths: Git provider. This field is case-insensitive. The available Git providers are ``gitHub``, ``bitbucketCloud``, ``gitLab``, ``azureDevOpsServices`` (Azure DevOps Services, including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), - ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit`` (deprecated by AWS, not - accepting new customers). + ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit``. :param git_email: str (optional) The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for @@ -75,8 +91,7 @@ paths: including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), - and ``awsCodeCommit`` (deprecated by AWS, not accepting new - customers). + and ``awsCodeCommit``. git_email: type: string description: >- @@ -290,8 +305,7 @@ paths: Git provider. This field is case-insensitive. The available Git providers are ``gitHub``, ``bitbucketCloud``, ``gitLab``, ``azureDevOpsServices`` (Azure DevOps Services, including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), - ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit`` (deprecated by AWS, not - accepting new customers). + ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit``. :param git_email: str (optional) The authenticating email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author & committer identity for commits. Required for @@ -335,8 +349,7 @@ paths: including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), - and ``awsCodeCommit`` (deprecated by AWS, not accepting new - customers). + and ``awsCodeCommit``. git_email: type: string description: >- @@ -417,8 +430,7 @@ paths: Git provider. This field is case-insensitive. The available Git providers are ``gitHub``, ``bitbucketCloud``, ``gitLab``, ``azureDevOpsServices`` (Azure DevOps Services, including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), - ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit`` (deprecated by AWS, not - accepting new customers). + ``gitLabEnterpriseEdition`` (GitLab Self-Managed), and ``awsCodeCommit``. :param git_credential_id: int (optional) Git credential ID to use when cloning the repository. The Git credential must be configured for the current user. @@ -448,8 +460,7 @@ paths: including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), - and ``awsCodeCommit`` (deprecated by AWS, not accepting new - customers). + and ``awsCodeCommit``. git_credential_id: type: integer description: >- @@ -2013,11 +2024,6 @@ paths: - ``R_MARKDOWN``: The notebook is exported to R Markdown format. - ``AUTO``: The object or directory is exported depending on the objects type. Directory exports will include notebooks and workspace files. - :param outputs: :class:`ExportOutputs` (optional) - This specifies which cell outputs should be included in the export (if the export format allows it). - If not specified, the behavior is determined by the format. For JUPYTER format, the default is to - include all outputs. This is a public endpoint, but only ALL or NONE is documented publically, - DATABRICKS is internal only :returns: :class:`ExportResponse` parameters: @@ -2046,17 +2052,6 @@ paths: R Markdown format. - ``AUTO``: The object or directory is exported depending on the objects type. Directory exports will include notebooks and workspace files. - - name: outputs - in: query - required: false - schema: - $ref: '#/components/schemas/ExportOutputs' - description: >- - This specifies which cell outputs should be included in the export - (if the export format allows it). If not specified, the behavior is - determined by the format. For JUPYTER format, the default is to - include all outputs. This is a public endpoint, but only ALL or NONE - is documented publically, DATABRICKS is internal only responses: '200': description: Success @@ -2742,7 +2737,7 @@ components: Git provider of the linked Git repository, e.g. ``gitHub``, ``azureDevOpsServices``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), or - ``awsCodeCommit`` (deprecated). + ``awsCodeCommit``. sparse_checkout: $ref: '#/components/schemas/SparseCheckout' description: Sparse checkout settings for the Git folder (repo). @@ -2770,7 +2765,7 @@ components: DevOps Services, including Microsoft Entra ID authentication), ``gitHubEnterprise``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), or - ``awsCodeCommit`` (deprecated). + ``awsCodeCommit``. git_username: type: string description: >- @@ -2901,7 +2896,7 @@ components: Git provider of the linked Git repository, e.g. ``gitHub``, ``azureDevOpsServices``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), or - ``awsCodeCommit`` (deprecated). + ``awsCodeCommit``. sparse_checkout: $ref: '#/components/schemas/SparseCheckout' description: Sparse checkout settings for the Git folder (repo). @@ -3071,7 +3066,7 @@ components: Git provider of the remote git repository, e.g. ``gitHub``, ``azureDevOpsServices``, ``bitbucketServer`` (Bitbucket Data Center), ``gitLabEnterpriseEdition`` (GitLab Self-Managed), or - ``awsCodeCommit`` (deprecated). + ``awsCodeCommit``. sparse_checkout: $ref: '#/components/schemas/SparseCheckout' description: Sparse checkout config for the git folder (repo). @@ -3247,48 +3242,6 @@ components: - R_MARKDOWN - SOURCE description: The format for workspace import and export. - ExportOutputs: - type: string - x-enum: - - ALL - - NONE - description: |- - Create a collection of name/value pairs. - - Example enumeration: - - >>> class Color(Enum): - ... RED = 1 - ... BLUE = 2 - ... GREEN = 3 - - Access them by: - - - attribute access: - - >>> Color.RED - - - - value lookup: - - >>> Color(1) - - - - name lookup: - - >>> Color['RED'] - - - Enumerations can be iterated over, and know how many members they have: - - >>> len(Color) - 3 - - >>> list(Color) - [, , ] - - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. ImportFormat: type: string x-enum: From 3c9f59b182e7e8700abda8f236dc1d8804d4a00b Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 5 Nov 2026 17:55:29 +1100 Subject: [PATCH 2/2] Pin regression job to ubuntu-24.04 and harden nginx install ubuntu-latest moved to Ubuntu 26.04 in early November 2026. On that image gpg 2.4 aborts with "/home/runner/.gnupg: directory does not exist" while dearmoring the nginx.org signing key, so the "Install and run nginx load balancer" step fails and every robot test step is skipped (run 41978771286). - run regression-testing on ubuntu-24.04, matching stackql-core build.yml - create ~/.gnupg before invoking gpg so the step survives a future image move - pass -y to the nginx apt-get install Co-Authored-By: Claude Fable 5.1 --- .github/workflows/regression.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/regression.yml b/.github/workflows/regression.yml index c7a043e3..8707114e 100644 --- a/.github/workflows/regression.yml +++ b/.github/workflows/regression.yml @@ -66,7 +66,7 @@ jobs: regression-testing: name: regression-testing - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 # pinned: ubuntu-latest moved to 26.04 in Nov 2026; matches stackql-core build.yml needs: test_python_package_build timeout-minutes: ${{ vars.DEFAULT_JOB_TIMEOUT_MIN == '' && 120 || vars.DEFAULT_JOB_TIMEOUT_MIN }} permissions: @@ -182,6 +182,7 @@ jobs: working-directory: stackql-core run: | sudo apt-get install -y curl gnupg2 ca-certificates lsb-release ubuntu-keyring + mkdir -p -m 700 "${HOME}/.gnupg" # gpg 2.4 aborts when the home dir is missing (Ubuntu 26.04 image) curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg @@ -189,7 +190,7 @@ jobs: http://nginx.org/packages/ubuntu $(lsb_release -cs) nginx" \ | sudo tee /etc/apt/sources.list.d/nginx.list sudo apt-get update - sudo apt-get install nginx + sudo apt-get install -y nginx sudo nginx -c "$(pwd)/test/tcp/reverse-proxy/nginx/dynamic-sni-proxy.conf" - name: Create materials for core tests