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 31bcab0e..cbc3a783 100644 --- a/providers/src/databricks_account/v00.00.00000/services/billing.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/billing.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.billing servers: - url: https://accounts.cloud.databricks.com @@ -468,20 +468,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -550,20 +550,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -598,20 +598,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -902,20 +902,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -950,20 +950,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1124,7 +1124,7 @@ paths: - output_format - credentials_id - storage_configuration_id - description: ':returns: :class:`WrappedLogDeliveryConfiguration`' + description: '* Log Delivery Configuration' required: - log_delivery_configuration responses: @@ -1923,20 +1923,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1964,20 +1964,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2005,20 +2005,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2046,20 +2046,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2087,20 +2087,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2166,20 +2166,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2208,20 +2208,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2250,20 +2250,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 0fd64d39..e4b2dd23 100644 --- a/providers/src/databricks_account/v00.00.00000/services/catalog.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/catalog.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.catalog servers: - url: https://accounts.cloud.databricks.com @@ -67,7 +67,6 @@ paths: - workspace_id - metastore_id - default_catalog_name - description: ':returns: :class:`AccountsCreateMetastoreAssignmentResponse`' responses: '200': description: Success @@ -194,7 +193,6 @@ paths: description: The unique ID of the metastore. required: - workspace_id - description: ':returns: :class:`AccountsUpdateMetastoreAssignmentResponse`' responses: '200': description: Success @@ -347,7 +345,6 @@ paths: description: The storage root URL for metastore required: - name - description: ':returns: :class:`AccountsCreateMetastoreResponse`' responses: '200': description: Success @@ -695,10 +692,10 @@ paths: is **STORAGE**. required: - name - description: ':param skip_validation: bool (optional) Optional, default false. Supplying true to this argument - skips validation of the created set of credentials.' skip_validation: type: boolean + description: Optional, default false. Supplying true to this argument skips validation of the created set + of credentials. responses: '200': description: Success @@ -1003,10 +1000,9 @@ paths: type: boolean description: Whether the credential is usable only for read operations. Only applicable when purpose is **STORAGE**. - description: ':param skip_validation: bool (optional) Optional. Supplying true to this argument skips validation - of the updated set of credentials.' skip_validation: type: boolean + description: Optional. Supplying true to this argument skips validation of the updated set of credentials. responses: '200': description: Success @@ -1530,7 +1526,7 @@ paths: type: string description: The resources to which the temporary Azure credential should apply. These resources are the scopes that are passed to the token provider (see https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python) - description: ':param gcp_options: :class:`GenerateTemporaryServiceCredentialGcpOptions` (optional)' + description: The Azure cloud options to customize the requested temporary credential gcp_options: type: object properties: @@ -1620,7 +1616,7 @@ paths: type: string description: The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role. - description: ':param azure_managed_identity: :class:`AzureManagedIdentity` (optional)' + description: The AWS IAM role configuration azure_managed_identity: type: object properties: @@ -1654,10 +1650,11 @@ paths: private_key_id: type: string description: The ID that represents the private key for this Service Account - description: ':param external_location_name: str (optional) The name of an existing external location to - validate. Only applicable for storage credentials (purpose is **STORAGE**.)' + description: GCP long-lived credential. Databricks-created Google Cloud Storage service account. external_location_name: type: string + description: The name of an existing external location to validate. Only applicable for storage credentials + (purpose is **STORAGE**.) purpose: type: string x-enum: @@ -2127,6 +2124,13 @@ components: properties: function_name: type: string + using_arguments: + 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. using_column_names: type: array items: @@ -2662,9 +2666,19 @@ components: type: string description: 'The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes.' + source_type: + $ref: '#/components/schemas/TagAssignmentSourceType' + 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 @@ -2850,10 +2864,14 @@ components: credential_name: type: string description: Name of the storage credential used with this location. + effective_enable_file_events: + type: boolean + description: The effective value of `enable_file_events` after applying server-side defaults. enable_file_events: type: boolean description: Whether to enable file events on this external location. Default to `true`. Set to `false` to disable - file events. + file events. The actual applied value may differ due to server-side defaults; check `effective_enable_file_events` + for the effective state. encryption_details: $ref: '#/components/schemas/EncryptionDetails' fallback: @@ -4090,6 +4108,18 @@ components: 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 Online Table data synchronization pipeline. + PolicyFunctionArgument: + type: object + properties: + column: + type: string + description: A column reference. + constant: + type: string + description: A constant literal. + description: |- + A positional argument passed to a row filter or column mask function. Distinguishes between + column references and literals. PolicyInfo: type: object properties: @@ -4670,6 +4700,13 @@ components: type: string description: The list of table columns to be passed as input to the row filter function. The column types should match the types of the filter function arguments. + input_arguments: + 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. required: - function_name - input_column_names @@ -4958,20 +4995,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5032,20 +5069,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5097,20 +5134,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5139,20 +5176,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5180,20 +5217,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5223,20 +5260,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5265,20 +5302,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5295,6 +5332,7 @@ components: x-enum: - ANY_STATIC_CREDENTIAL - BEARER_TOKEN + - EDGEGRID_AKAMAI - OAUTH_ACCESS_TOKEN - OAUTH_M2M - OAUTH_MTLS @@ -5308,7 +5346,7 @@ components: - SSWS_TOKEN - UNKNOWN_CREDENTIAL_TYPE - USERNAME_PASSWORD - description: 'Next Id: 15' + description: 'Next Id: 17' DataSourceFormat: type: string x-enum: @@ -5360,20 +5398,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5405,20 +5443,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5447,20 +5485,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5490,20 +5528,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5531,20 +5569,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5573,20 +5611,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5614,20 +5652,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5657,20 +5695,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5698,20 +5736,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5740,20 +5778,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5782,20 +5820,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5824,20 +5862,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5873,20 +5911,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5925,20 +5963,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5970,20 +6008,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6037,20 +6075,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6120,20 +6158,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6162,20 +6200,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6205,20 +6243,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6295,20 +6333,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6341,20 +6379,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6432,7 +6470,7 @@ components: - TABLE_SYSTEM_DELTASHARING - TABLE_VIEW - TABLE_VIEW_DELTASHARING - description: 'Latest kind: CONNECTION_OKTA_SYSTEM_LOGS_SSWS_TOKEN = 295; Next id: 296' + description: 'Latest kind: CONNECTION_GOOGLE_DRIVE_SERVICE_ACCOUNT = 301; Next id: 302' SecurableType: type: string x-enum: @@ -6474,20 +6512,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6516,20 +6554,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6579,20 +6617,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6621,20 +6659,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6670,20 +6708,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6695,6 +6733,11 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + TagAssignmentSourceType: + type: string + x-enum: + - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION + description: Enum representing the source type of a tag assignment ValidateCredentialResult: type: string x-enum: @@ -6737,20 +6780,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 f410c736..75839fe0 100644 --- a/providers/src/databricks_account/v00.00.00000/services/iam.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/iam.yaml @@ -5,7 +5,7 @@ info: SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.iam servers: - url: https://accounts.cloud.databricks.com @@ -208,7 +208,6 @@ paths: required: - name - etag - description: ':returns: :class:`RuleSetResponse`' required: - name - rule_set @@ -265,14 +264,14 @@ paths: schema: type: object properties: - display_name: + displayName: type: string description: String that represents a human-readable group name - external_id: + externalId: type: string - description: ':param id: str (optional) Databricks group ID' id: type: string + description: Databricks group ID members: type: array items: @@ -288,13 +287,12 @@ paths: type: string value: type: string - description: ':param meta: :class:`ResourceMeta` (optional) Container for the group identifier. Workspace - local versus account.' meta: type: object properties: resourceType: type: string + description: Container for the group identifier. Workspace local versus account. roles: type: array items: @@ -547,7 +545,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -565,8 +563,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -585,20 +581,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -610,6 +606,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -662,12 +659,11 @@ paths: schema: type: object properties: - display_name: + displayName: type: string description: String that represents a human-readable group name - external_id: + externalId: type: string - description: ':param members: List[:class:`ComplexValue`] (optional)' members: type: array items: @@ -758,17 +754,17 @@ paths: active: type: boolean description: If this user is active - application_id: + applicationId: type: string description: UUID relating to the service principal - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. - external_id: + externalId: type: string - description: ':param id: str (optional) Databricks service principal ID.' id: type: string + description: Databricks service principal ID. roles: type: array items: @@ -1018,7 +1014,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -1036,8 +1032,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -1056,20 +1050,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1081,6 +1075,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -1139,16 +1134,14 @@ paths: active: type: boolean description: If this user is active - application_id: + applicationId: type: string description: UUID relating to the service principal - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. - external_id: + externalId: type: string - description: ':param roles: List[:class:`ComplexValue`] (optional) Indicates if the group has the admin - role.' roles: type: array items: @@ -1164,6 +1157,7 @@ paths: type: string value: type: string + description: Indicates if the group has the admin role. responses: '200': description: Success @@ -1222,7 +1216,7 @@ paths: active: type: boolean description: If this user is active - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. For example `John Smith`. emails: @@ -1241,7 +1235,7 @@ paths: value: type: string description: All the emails associated with the Databricks user. - external_id: + externalId: type: string description: External ID is not currently supported. It is reserved for future use. id: @@ -1255,8 +1249,6 @@ paths: givenName: type: string description: Given name of the Databricks user. - description: ':param roles: List[:class:`ComplexValue`] (optional) Indicates if the group has the admin - role.' roles: type: array items: @@ -1272,7 +1264,8 @@ paths: type: string value: type: string - user_name: + description: Indicates if the group has the admin role. + userName: type: string description: Email address of the Databricks user. responses: @@ -1576,7 +1569,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -1594,8 +1587,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -1614,20 +1605,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1639,6 +1630,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -1699,7 +1691,7 @@ paths: active: type: boolean description: If this user is active - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. For example `John Smith`. emails: @@ -1718,7 +1710,7 @@ paths: value: type: string description: All the emails associated with the Databricks user. - external_id: + externalId: type: string description: External ID is not currently supported. It is reserved for future use. name: @@ -1729,8 +1721,6 @@ paths: givenName: type: string description: Given name of the Databricks user. - description: ':param roles: List[:class:`ComplexValue`] (optional) Indicates if the group has the admin - role.' roles: type: array items: @@ -1746,7 +1736,8 @@ paths: type: string value: type: string - user_name: + description: Indicates if the group has the admin role. + userName: type: string description: Email address of the Databricks user. responses: @@ -1878,20 +1869,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2694,20 +2685,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2735,20 +2726,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2776,20 +2767,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2818,20 +2809,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2871,20 +2862,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2902,6 +2893,7 @@ components: - CAN_ATTACH_TO - CAN_BIND - CAN_CREATE + - CAN_CREATE_APP - CAN_EDIT - CAN_EDIT_METADATA - CAN_MANAGE @@ -2943,20 +2935,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2985,20 +2977,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3028,20 +3020,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 d0b769ea..115edd14 100644 --- a/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/iamv2.yaml @@ -6,7 +6,7 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.iamv2 servers: - url: https://accounts.cloud.databricks.com 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 a0983ea6..b8ea02ba 100644 --- a/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/oauth2.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.oauth2 servers: - url: https://accounts.cloud.databricks.com @@ -37,6 +37,8 @@ paths: required: false schema: type: string + description: The identifier for the federation policy. The identifier must contain only lowercase alphanumeric characters, + numbers, hyphens, and slashes. If unspecified, the id will be assigned by Databricks. requestBody: content: application/json: @@ -110,9 +112,6 @@ paths: update_time: type: string description: Last update time of the federation policy. - description: ':param policy_id: str (optional) The identifier for the federation policy. The identifier - must contain only lowercase alphanumeric characters, numbers, hyphens, and slashes. If unspecified, the - id will be assigned by Databricks.' required: - policy responses: @@ -158,7 +157,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -303,6 +301,10 @@ paths: 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: ''description,oidc_policy.audiences''.' requestBody: content: application/json: @@ -376,11 +378,6 @@ paths: update_time: type: string description: Last update time of the federation policy. - description: ':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: ''description,oidc_policy.audiences''.' required: - policy responses: @@ -529,7 +526,6 @@ paths: required: false schema: type: boolean - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -540,7 +536,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`GetCustomAppIntegrationOutput`' responses: '200': description: Success @@ -583,7 +578,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -675,8 +669,6 @@ paths: required: true schema: type: string - description: ':param redirect_urls: List[str] (optional) List of OAuth redirect urls to be updated in the custom OAuth - app integration' requestBody: content: application/json: @@ -687,6 +679,7 @@ paths: type: array items: type: string + description: List of OAuth redirect urls to be updated in the custom OAuth app integration scopes: type: array items: @@ -883,7 +876,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -931,7 +923,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -970,7 +961,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetPublishedAppIntegrationOutput`' responses: '200': description: Success @@ -1014,8 +1004,6 @@ paths: required: true schema: type: string - description: ':param token_access_policy: :class:`TokenAccessPolicy` (optional) Token access policy to be updated - in the published OAuth app integration' requestBody: content: application/json: @@ -1041,6 +1029,7 @@ paths: description: Refresh token time to live in minutes. When single-use refresh tokens are enabled, this represents the TTL of an individual refresh token. If the refresh token is used before it expires, a new one is issued with a renewed individual TTL. + description: Token access policy to be updated in the published OAuth app integration responses: '200': description: Success @@ -1091,6 +1080,8 @@ paths: required: false schema: type: string + description: The identifier for the federation policy. The identifier must contain only lowercase alphanumeric characters, + numbers, hyphens, and slashes. If unspecified, the id will be assigned by Databricks. requestBody: content: application/json: @@ -1164,9 +1155,6 @@ paths: update_time: type: string description: Last update time of the federation policy. - description: ':param policy_id: str (optional) The identifier for the federation policy. The identifier - must contain only lowercase alphanumeric characters, numbers, hyphens, and slashes. If unspecified, the - id will be assigned by Databricks.' required: - policy responses: @@ -1220,7 +1208,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -1389,6 +1376,10 @@ paths: 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: ''description,oidc_policy.audiences''.' requestBody: content: application/json: @@ -1462,11 +1453,6 @@ paths: update_time: type: string description: Last update time of the federation policy. - description: ':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: ''description,oidc_policy.audiences''.' required: - policy responses: @@ -1585,17 +1571,17 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional) An opaque page token which was the `next_page_token` in the response - of the previous request to list the secrets for this service principal. Provide this token to retrieve the next - page of secret entries. When providing a `page_token`, all other parameters provided to the request must match the - previous request. To list all of the secrets for a service principal, it is necessary to continue requesting pages - of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be - used to determine when the listing is complete.' - name: page_token in: query required: false schema: type: string + description: An opaque page token which was the `next_page_token` in the response of the previous request to list + the secrets for this service principal. Provide this token to retrieve the next page of secret entries. When providing + a `page_token`, all other parameters provided to the request must match the previous request. To list all of the + secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains + no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is + complete. responses: '200': description: Success 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 bc513de0..4a34af70 100644 --- a/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/provisioning.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.provisioning servers: - url: https://accounts.cloud.databricks.com @@ -59,7 +59,6 @@ paths: properties: role_arn: type: string - description: ':returns: :class:`Credential`' required: - credentials_name - aws_credentials @@ -267,20 +266,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -311,7 +310,6 @@ paths: this key for encrypting EBS volumes, set to false. required: - key_arn - description: ':param gcp_key_info: :class:`CreateGcpKeyInfo` (optional)' gcp_key_info: type: object properties: @@ -550,9 +548,9 @@ paths: - subnet_region - pod_ip_range_name - service_ip_range_name - description: ':param network_name: str (optional) The human-readable name of the network configuration.' network_name: type: string + description: The human-readable name of the network configuration. security_group_ids: type: array items: @@ -577,10 +575,10 @@ paths: items: type: string description: The VPC endpoint ID used by this network to access the Databricks REST API. - description: ':param vpc_id: str (optional) The ID of the VPC associated with this network configuration. - VPC IDs can be used in multiple networks.' vpc_id: type: string + description: The ID of the VPC associated with this network configuration. VPC IDs can be used in multiple + networks. responses: '200': description: Success @@ -885,7 +883,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`PrivateAccessSettings`' responses: '200': description: Success @@ -928,7 +925,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`PrivateAccessSettings`' responses: '200': description: Success @@ -1185,7 +1181,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`StorageConfiguration`' responses: '200': description: Success @@ -1228,7 +1223,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`StorageConfiguration`' responses: '200': description: Success @@ -1398,7 +1392,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`VpcEndpoint`' responses: '200': description: Success @@ -1506,7 +1499,8 @@ paths: :param aws_region: str (optional) :param cloud: str (optional) - The cloud name. This field always has the value `gcp`. + 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`. :param cloud_resource_container: :class:`CloudResourceContainer` (optional) :param compute_mode: :class:`CustomerFacingComputeMode` (optional) If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured @@ -1587,9 +1581,10 @@ paths: properties: aws_region: type: string - description: ':param cloud: str (optional) The cloud name. This field always has the value `gcp`.' cloud: type: string + description: '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`.' cloud_resource_container: type: object properties: @@ -1598,19 +1593,16 @@ paths: properties: project_id: type: string - description: ':param compute_mode: :class:`CustomerFacingComputeMode` (optional) If the compute mode is - `SERVERLESS`, a serverless workspace is created that comes pre-configured with serverless compute and - default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don''t need - to provide any resources managed by you, such as credentials, storage, or network. If the compute mode - is `HYBRID` (which is the default option), a classic workspace is created that uses customer-managed resources.' compute_mode: type: string x-enum: - HYBRID - SERVERLESS - description: |- - Corresponds to compute mode defined here: - https://src.dev.databricks.com/databricks/universe@9076536b18479afd639d1c1f9dd5a59f72215e69/-/blob/central/api/common.proto?L872 + description: If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured + with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. + This means you don't need to provide any resources managed by you, such as credentials, storage, or network. + If the compute mode is `HYBRID` (which is the default option), a classic workspace is created that uses + customer-managed resources. credentials_id: type: string description: ID of the workspace's credential configuration object. @@ -1647,7 +1639,7 @@ 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: ':param gke_config: :class:`GkeConfig` (optional)' + description: The network configuration for the workspace. gke_config: type: object properties: @@ -1687,13 +1679,50 @@ paths: - PREMIUM - STANDARD - UNKNOWN - description: ':param private_access_settings_id: str (optional) 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].", [AWS PrivateLink]: - https://aws.amazon.com/privatelink/ [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html' + 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. 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].", [AWS PrivateLink]: https://aws.amazon.com/privatelink/ + [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html' storage_configuration_id: type: string description: ID of the workspace's storage configuration object. @@ -1784,7 +1813,6 @@ paths: required: true schema: type: integer - description: ':returns: :class:`Workspace`' responses: '200': description: Success @@ -1834,7 +1862,6 @@ paths: required: true schema: type: integer - description: ':returns: :class:`Workspace`' responses: '200': description: Success @@ -1897,6 +1924,12 @@ paths: required: false schema: 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. requestBody: content: application/json: @@ -2063,20 +2096,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2126,13 +2159,6 @@ paths: workspace_status_message: type: string description: Message describing the current workspace status. - description: ':param update_mask: str (optional) 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.' required: - customer_facing_workspace responses: @@ -2577,7 +2603,7 @@ components: $ref: '#/components/schemas/EndpointUseCase' description: This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint. If the VPC endpoint connects to the Databricks control plane for either the front-end connection - or the back-end REST API connection, the value is WORKSPACE_ACCESS. If the VPC endpoint connects to the Databricks + or the back-end REST API connection, the value is GENERAL_ACCESS. If the VPC endpoint connects to the Databricks workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS. vpc_endpoint_id: type: string @@ -2714,20 +2740,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2743,6 +2769,7 @@ components: type: string x-enum: - DATAPLANE_RELAY_ACCESS + - GENERAL_ACCESS - WORKSPACE_ACCESS description: |- Create a collection of name/value pairs. @@ -2756,20 +2783,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2822,20 +2849,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2868,20 +2895,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2910,20 +2937,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2954,20 +2981,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2996,20 +3023,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 cc082adc..ca22b922 100644 --- a/providers/src/databricks_account/v00.00.00000/services/settings.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/settings.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.settings servers: - url: https://accounts.cloud.databricks.com @@ -58,7 +58,11 @@ paths: x-enum: - ALLOW - BLOCK - description: ':param ip_addresses: List[str] (optional)' + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. ip_addresses: type: array items: @@ -255,14 +259,18 @@ paths: x-enum: - ALLOW - BLOCK - description: ':param enabled: bool Specifies whether this IP access list is enabled.' + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. enabled: type: boolean + description: Specifies whether this IP access list is enabled. ip_addresses: type: array items: type: string - description: List[str] (optional) required: - label - list_type @@ -336,15 +344,19 @@ paths: type: array items: type: string - description: ':param label: str (optional) Label for the IP access list. This **cannot** be empty.' label: type: string + description: Label for the IP access list. This **cannot** be empty. list_type: type: string x-enum: - ALLOW - BLOCK - description: :class:`ListType` (optional) + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. responses: '200': description: Success @@ -410,7 +422,7 @@ paths: required: - name - region - description: ':returns: :class:`NetworkConnectivityConfiguration`' + description: Properties of the new network connectivity configuration. required: - network_connectivity_config responses: @@ -549,7 +561,9 @@ paths: 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: ':returns: :class:`NccPrivateEndpointRule`' + description: |- + Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure + portal after initialization. required: - private_endpoint_rule responses: @@ -862,6 +876,10 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -892,11 +910,9 @@ paths: 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: ':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.' + description: |- + Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure + portal after initialization. required: - private_endpoint_rule responses: @@ -991,20 +1007,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1055,20 +1071,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1337,20 +1353,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1401,20 +1417,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3050,6 +3066,10 @@ components: properties: status: $ref: '#/components/schemas/RestrictWorkspaceAdminsMessageStatus' + 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 RestrictWorkspaceAdminsSetting: @@ -3260,20 +3280,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3307,20 +3327,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3354,20 +3374,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3422,20 +3442,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3467,20 +3487,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3517,20 +3537,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3559,20 +3579,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3621,20 +3641,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3662,20 +3682,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3710,20 +3730,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3763,20 +3783,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3829,20 +3849,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3876,20 +3896,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3929,20 +3949,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 06a1c2e3..93bc4fab 100644 --- a/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml +++ b/providers/src/databricks_account/v00.00.00000/services/settingsv2.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.settingsv2 servers: - url: https://accounts.cloud.databricks.com @@ -42,7 +42,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`Setting`' responses: '200': description: Success @@ -102,7 +101,6 @@ paths: required: true schema: type: string - description: ':param setting: :class:`Setting`' requestBody: content: application/json: @@ -140,29 +138,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -265,29 +254,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -338,29 +318,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -433,29 +404,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -562,29 +524,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -635,29 +588,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -765,29 +709,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -807,6 +742,12 @@ paths: 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: >- @@ -888,29 +829,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -930,6 +862,12 @@ paths: 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: >- @@ -1079,7 +1017,6 @@ paths: required: true schema: type: string - description: ':param setting: :class:`UserPreference`' requestBody: content: application/json: @@ -1433,6 +1370,11 @@ components: properties: status: $ref: '#/components/schemas/RestrictWorkspaceAdminsMessageStatus' + 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 Setting: @@ -1593,20 +1535,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1640,20 +1582,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1687,20 +1629,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1748,20 +1690,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 f43a7969..c529cff5 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/agentbricks.yaml @@ -6,7 +6,7 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.agentbricks servers: - url: https://{deployment_name}.cloud.databricks.com @@ -32,7 +32,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success 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 be334ff3..e5bd3bfc 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/apps.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.apps servers: - url: https://{deployment_name}.cloud.databricks.com @@ -36,6 +36,7 @@ paths: required: false schema: type: boolean + description: If true, the app will not be started after creation. requestBody: content: application/json: @@ -187,20 +188,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -390,6 +391,9 @@ paths: properties: name: type: string + app: + type: object + properties: {} database: type: object properties: @@ -413,20 +417,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -468,20 +472,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -522,20 +526,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -568,6 +572,54 @@ paths: 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: @@ -644,20 +696,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -673,6 +725,7 @@ paths: type: string x-enum: - EXECUTE + - MODIFY - READ_VOLUME - SELECT - USE_CONNECTION @@ -689,20 +742,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -714,6 +767,9 @@ paths: 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 @@ -727,6 +783,32 @@ paths: type: integer service_principal_name: 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. update_time: type: string description: The update time of the app. Formatted timestamp in ISO 6801. @@ -744,7 +826,6 @@ paths: type: string required: - name - description: ':param no_compute: bool (optional) If true, the app will not be started after creation.' required: - app responses: @@ -778,6 +859,8 @@ paths: 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. :returns: Iterator over :class:`App` parameters: @@ -793,6 +876,12 @@ paths: 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 @@ -812,439 +901,99 @@ paths: message: type: string x-stackql-sdk-source: AppsAPI - /api/2.0/apps/{app_name}/update: + /api/2.0/app-spaces: post: - operationId: apps_create_update - summary: Creates an app update and starts the update process. The update process is asynchronous and the status + operationId: apps_create_space + summary: Creates a new app space. 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. + Creates a new app space. - 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) + :param space: :class:`Space` - :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 - description: ':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.' + :returns: :class:`Operation` requestBody: content: application/json: schema: type: object properties: - update_mask: - type: string - app: + space: type: object properties: name: type: string - active_deployment: - type: object - properties: - command: - type: array - items: + 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 - 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: + app: + type: object + properties: {} + database: type: object properties: - name: + instance_name: type: string - value: + database_name: type: string - description: The value for the environment variable. - value_from: + permission: 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.' - 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 - state: - type: string - x-enum: - - CRASHED - - DEPLOYING - - RUNNING - - UNAVAILABLE - description: State of the application. - budget_policy_id: - type: string - compute_size: - type: string - x-enum: - - LARGE - - MEDIUM - description: |- - Create a collection of name/value pairs. + 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: - - >>> 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_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. - 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.' - 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). - 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: - 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.' - 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 - 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: + Enumerations can be iterated over, and know how many members they have: >>> len(Color) 3 @@ -1284,20 +1033,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1338,20 +1087,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1384,46 +1133,94 @@ paths: required: - id - permission - 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: + postgres: type: object properties: - name: - type: string - permission: + branch: 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: + 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 @@ -1460,20 +1257,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1489,6 +1286,7 @@ paths: type: string x-enum: - EXECUTE + - MODIFY - READ_VOLUME - SELECT - USE_CONNECTION @@ -1505,20 +1303,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1530,47 +1328,68 @@ paths: 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. + 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. update_time: type: string - description: The update time of the app. Formatted timestamp in ISO 6801. + 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. - url: - type: string - description: The URL of the app once it is deployed. + 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 - description: ':returns: Long-running operation waiter for :class:`AppUpdate`. See :method:wait_get_update_app_succeeded - for more details.' required: - - update_mask + - space responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AppUpdate' + type: object default: description: Error response content: @@ -1584,70 +1403,39 @@ paths: type: string x-stackql-sdk-source: AppsAPI get: - operationId: apps_get_update - summary: Gets the status of an app update. + operationId: apps_list_spaces + summary: Lists all app spaces in the workspace. tags: - apps description: |- - Gets the status of an app update. + Lists all app spaces in the workspace. - :param app_name: str - The name of the app. + :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: :class:`AppUpdate` + :returns: Iterator over :class:`Space` parameters: - - name: app_name - in: path - required: true + - name: page_size + in: query + required: false 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 + type: integer + description: Upper bound for items returned. + - name: page_token + in: query + required: false schema: type: string - description: The name of the app. + 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/App' + $ref: '#/components/schemas/ListSpacesResponse' default: description: Error response content: @@ -1660,72 +1448,52 @@ paths: message: type: string x-stackql-sdk-source: AppsAPI - get: - operationId: apps_get - summary: Retrieves information for the app with the supplied name. + /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: |- - Retrieves information for the app with the supplied name. - - :param name: str - The name of the app. + 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. - :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 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. - :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` + 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: :class:`App` + :returns: + Long-running operation waiter for :class:`AppUpdate`. + See :method:wait_get_update_app_succeeded for more details. parameters: - - name: name + - name: app_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: + 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: @@ -1871,20 +1639,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1894,179 +1662,1742 @@ paths: >>> 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. + 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_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. + 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.' + 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). + 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: + 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.' + 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: {} + 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 + 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. + 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. + + :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: + 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.' + 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 + state: + type: string + x-enum: + - CRASHED + - DEPLOYING + - RUNNING + - UNAVAILABLE + description: State of the application. + budget_policy_id: + type: string + compute_size: + type: string + x-enum: + - LARGE + - MEDIUM + 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_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. + 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.' + 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). + 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: + 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.' + 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: {} + 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 + 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. + 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: + - 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 + /api/2.0/app-spaces/{name}: + delete: + operationId: apps_delete_space + summary: Deletes an app space. + tags: + - apps + description: |- + Deletes an app space. + + :param name: str + The name of the app space. + + :returns: :class:`Operation` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app 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_get_space + summary: Retrieves information for the app space with the supplied name. + tags: + - apps + description: |- + Retrieves information for the app space with the supplied name. + + :param name: str + The name of the app space. + + :returns: :class:`Space` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app space. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Space' + 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_space + summary: Updates an app space. The update process is asynchronous and the status of the update can be checked + tags: + - apps + description: |- + Updates an app space. The update process is asynchronous and the status of the update can be checked + with the GetSpaceOperation method. + + :param name: str + The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens. + It must be unique within the workspace. + :param space: :class:`Space` + :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:`Operation` + parameters: + - name: name + in: path + required: true + schema: + type: string + description: The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens. + It must be unique within the workspace. + - 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: + space: + type: object + properties: + name: + type: string create_time: type: string - description: The creation time of the app. Formatted timestamp in ISO 6801. + 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. - 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: The email of the user that created the app space. description: type: string - description: The description of the app. - effective_budget_policy_id: - 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. - 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.' - 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). 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: - 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.' - 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. + description: The unique identifier of the app space. resources: type: array items: @@ -2074,6 +3405,9 @@ paths: properties: name: type: string + app: + type: object + properties: {} database: type: object properties: @@ -2097,20 +3431,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2152,20 +3486,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2206,20 +3540,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2252,6 +3586,54 @@ paths: 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: @@ -2328,20 +3710,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2357,6 +3739,7 @@ paths: type: string x-enum: - EXECUTE + - MODIFY - READ_VOLUME - SELECT - USE_CONNECTION @@ -2373,20 +3756,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2398,46 +3781,68 @@ paths: 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. + 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. update_time: type: string - description: The update time of the app. Formatted timestamp in ISO 6801. + 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. - url: - type: string - description: The URL of the app once it is deployed. + 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 - description: ':returns: :class:`App`' required: - - app + - space responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/App' + type: object default: description: Error response content: @@ -2832,7 +4237,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`AppPermissions`' responses: '200': description: Success @@ -2897,14 +4301,52 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`AppPermissions`' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/AppPermissions' + $ref: '#/components/schemas/AppPermissions' + 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/{name}/operation: + get: + operationId: apps_get_space_operation + summary: Gets the status of an app space update operation. + tags: + - apps + description: |- + Gets the status of an app space update 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: @@ -3073,20 +4515,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3122,20 +4564,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3183,20 +4625,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3231,20 +4673,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3280,20 +4722,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3326,20 +4768,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3378,7 +4820,6 @@ paths: - path - manifest - git_provider - description: ':returns: :class:`CustomTemplate`' required: - template responses: @@ -3610,20 +5051,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3659,20 +5100,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3720,20 +5161,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3768,20 +5209,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3817,20 +5258,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3863,20 +5304,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3915,7 +5356,6 @@ paths: - path - manifest - git_provider - description: ':returns: :class:`CustomTemplate`' required: - template responses: @@ -4004,6 +5444,13 @@ components: type: integer service_principal_name: type: string + space: + type: string + description: Name of the space this app belongs to. + telemetry_export_destinations: + type: array + items: + $ref: '#/components/schemas/TelemetryExportDestination' update_time: type: string description: The update time of the app. Formatted timestamp in ISO 6801. @@ -4234,6 +5681,8 @@ components: properties: name: type: string + app: + $ref: '#/components/schemas/AppResourceApp' database: $ref: '#/components/schemas/AppResourceDatabase' description: @@ -4245,6 +5694,8 @@ components: $ref: '#/components/schemas/AppResourceGenieSpace' job: $ref: '#/components/schemas/AppResourceJob' + postgres: + $ref: '#/components/schemas/AppResourcePostgres' secret: $ref: '#/components/schemas/AppResourceSecret' serving_endpoint: @@ -4255,6 +5706,9 @@ components: $ref: '#/components/schemas/AppResourceUcSecurable' required: - name + AppResourceApp: + type: object + properties: {} AppResourceDatabase: type: object properties: @@ -4303,6 +5757,15 @@ components: required: - id - permission + AppResourcePostgres: + type: object + properties: + branch: + type: string + database: + type: string + permission: + $ref: '#/components/schemas/AppResourcePostgresPostgresPermission' AppResourceSecret: type: object properties: @@ -4351,6 +5814,9 @@ components: $ref: '#/components/schemas/AppResourceUcSecurableUcSecurableType' permission: $ref: '#/components/schemas/AppResourceUcSecurableUcSecurablePermission' + 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 @@ -4432,6 +5898,20 @@ components: - path - manifest - git_provider + 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. EnvVar: type: object properties: @@ -4520,6 +6000,155 @@ components: type: array items: $ref: '#/components/schemas/CustomTemplate' + ListSpacesResponse: + type: object + properties: + next_page_token: + type: string + spaces: + type: array + items: + $ref: '#/components/schemas/Space' + 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. + 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: + 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: + $ref: '#/components/schemas/AppResource' + 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: + $ref: '#/components/schemas/SpaceStatus' + 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: + - name + SpaceStatus: + type: object + properties: + message: + type: string + state: + $ref: '#/components/schemas/SpaceStatusSpaceState' + description: The state of the app space. + SpaceUpdate: + type: object + properties: + description: + type: string + resources: + type: array + items: + $ref: '#/components/schemas/AppResource' + status: + $ref: '#/components/schemas/SpaceUpdateStatus' + usage_policy_id: + type: string + user_api_scopes: + type: array + items: + type: string + description: Tracks app space update information. + SpaceUpdateStatus: + type: object + properties: + message: + type: string + state: + $ref: '#/components/schemas/SpaceUpdateState' + description: Status of an app space update operation + TelemetryExportDestination: + type: object + properties: + unity_catalog: + $ref: '#/components/schemas/UnityCatalog' + description: A single telemetry export destination with its configuration and status. + UnityCatalog: + 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. AppDeploymentMode: type: string x-enum: @@ -4537,20 +6166,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4581,20 +6210,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4624,20 +6253,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4668,20 +6297,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4718,20 +6347,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4761,20 +6390,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4807,20 +6436,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4851,20 +6480,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4898,20 +6527,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4941,20 +6570,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4985,20 +6614,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5029,20 +6658,61 @@ components: Access them by: - - attribute access:: + - 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. + AppResourcePostgresPostgresPermission: + 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 - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5079,20 +6749,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5122,20 +6792,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5151,6 +6821,7 @@ components: type: string x-enum: - EXECUTE + - MODIFY - READ_VOLUME - SELECT - USE_CONNECTION @@ -5167,20 +6838,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5211,20 +6882,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5255,20 +6926,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5299,20 +6970,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5341,20 +7012,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5388,20 +7059,195 @@ components: Access them by: - - attribute access:: + - 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. + SpaceStatusSpaceState: + type: string + x-enum: + - SPACE_ACTIVE + - SPACE_CREATING + - SPACE_DELETED + - SPACE_DELETING + - SPACE_ERROR + - SPACE_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. + SpaceUpdateState: + type: string + x-enum: + - FAILED + - IN_PROGRESS + - NOT_UPDATED + - 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 - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5435,6 +7281,21 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.apps + apps_create_space: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1app-spaces/post' + response: + mediaType: application/json + openAPIDocKey: '200' + apps_list_spaces: + operation: + $ref: '#/paths/~1api~12.0~1app-spaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: '#/paths/~1api~12.0~1apps~1{name}/delete' @@ -5456,6 +7317,33 @@ components: response: mediaType: application/json openAPIDocKey: '200' + apps_delete_space: + operation: + $ref: '#/paths/~1api~12.0~1app-spaces~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + apps_get_space: + operation: + $ref: '#/paths/~1api~12.0~1app-spaces~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + apps_update_space: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1app-spaces~1{name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + apps_get_space_operation: + operation: + $ref: '#/paths/~1api~12.0~1app-spaces~1{name}~1operation/get' + response: + mediaType: application/json + openAPIDocKey: '200' start: operation: $ref: '#/paths/~1api~12.0~1apps~1{name}~1start/post' @@ -5471,13 +7359,19 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_get_space' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_get_space_operation' - $ref: '#/components/x-stackQL-resources/apps/methods/list' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_list_spaces' insert: - $ref: '#/components/x-stackQL-resources/apps/methods/create' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_create_space' update: - $ref: '#/components/x-stackQL-resources/apps/methods/update' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_update_space' delete: - $ref: '#/components/x-stackQL-resources/apps/methods/delete' + - $ref: '#/components/x-stackQL-resources/apps/methods/apps_delete_space' replace: [] app_updates: id: databricks_workspace.apps.app_updates 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 16a3d71c..8ec7f335 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/catalog.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.catalog servers: - url: https://{deployment_name}.cloud.databricks.com @@ -936,14 +936,28 @@ paths: The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes. + 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: ':returns: :class:`EntityTagAssignment`' + description: Represents a tag assignment to an entity required: - tag_assignment responses: @@ -1172,6 +1186,17 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -1195,26 +1220,28 @@ paths: The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes. + 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: >- - :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. + description: Represents a tag assignment to an entity required: - tag_assignment responses: @@ -1419,7 +1446,6 @@ paths: required: - source - target - description: ':returns: :class:`ExternalLineageRelationship`' required: - external_lineage_relationship responses: @@ -1464,7 +1490,6 @@ paths: required: true schema: $ref: '#/components/schemas/DeleteRequestExternalLineage' - description: ':class:`DeleteRequestExternalLineage`' responses: '200': description: Success @@ -1595,6 +1620,17 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -1678,19 +1714,6 @@ paths: required: - source - target - description: >- - :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. required: - external_lineage_relationship responses: @@ -1739,9 +1762,12 @@ paths: Name of the storage credential used with this location. :param comment: str (optional) User-provided free-form text description. + :param effective_enable_file_events: bool (optional) + The effective value of `enable_file_events` after applying server-side defaults. :param enable_file_events: bool (optional) Whether to enable file events on this external location. Default to `true`. Set to `false` to - disable file events. + disable file events. The actual applied value may differ due to server-side defaults; check + `effective_enable_file_events` for the effective state. :param encryption_details: :class:`EncryptionDetails` (optional) :param fallback: bool (optional) @@ -1775,11 +1801,19 @@ paths: comment: type: string description: User-provided free-form text description. + effective_enable_file_events: + type: boolean + description: >- + The effective value of `enable_file_events` after applying + server-side defaults. enable_file_events: type: boolean description: >- Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events. + The actual applied value may differ due to server-side + defaults; check `effective_enable_file_events` for the + effective state. encryption_details: type: object properties: @@ -1806,12 +1840,15 @@ paths: Server-Side Encryption properties for clients communicating with AWS s3. description: >- - :param fallback: bool (optional) Indicates whether fallback - mode is enabled for this external location. When fallback - mode is enabled, the access to the location falls back to - cluster credentials if UC credentials are not sufficient. + Encryption options that apply to clients connecting to cloud + storage. fallback: type: boolean + description: >- + Indicates whether fallback mode is enabled for this external + location. When fallback mode is enabled, the access to the + location falls back to cluster credentials if UC credentials + are not sufficient. file_event_queue: type: object properties: @@ -2180,9 +2217,12 @@ paths: User-provided free-form text description. :param credential_name: str (optional) Name of the storage credential used with this location. + :param effective_enable_file_events: bool (optional) + The effective value of `enable_file_events` after applying server-side defaults. :param enable_file_events: bool (optional) Whether to enable file events on this external location. Default to `true`. Set to `false` to - disable file events. + disable file events. The actual applied value may differ due to server-side defaults; check + `effective_enable_file_events` for the effective state. :param encryption_details: :class:`EncryptionDetails` (optional) :param fallback: bool (optional) @@ -2227,11 +2267,19 @@ paths: credential_name: type: string description: Name of the storage credential used with this location. + effective_enable_file_events: + type: boolean + description: >- + The effective value of `enable_file_events` after applying + server-side defaults. enable_file_events: type: boolean description: >- Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events. + The actual applied value may differ due to server-side + defaults; check `effective_enable_file_events` for the + effective state. encryption_details: type: object properties: @@ -2258,12 +2306,15 @@ paths: Server-Side Encryption properties for clients communicating with AWS s3. description: >- - :param fallback: bool (optional) Indicates whether fallback - mode is enabled for this external location. When fallback - mode is enabled, the access to the location falls back to - cluster credentials if UC credentials are not sufficient. + Encryption options that apply to clients connecting to cloud + storage. fallback: type: boolean + description: >- + Indicates whether fallback mode is enabled for this external + location. When fallback mode is enabled, the access to the + location falls back to cluster credentials if UC credentials + are not sufficient. file_event_queue: type: object properties: @@ -2376,10 +2427,60 @@ paths: - ISOLATION_MODE_ISOLATED - ISOLATION_MODE_OPEN description: >- - :param new_name: str (optional) New name for the external - location. + 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. new_name: type: string + description: New name for the external location. owner: type: string description: The owner of the external location. @@ -2524,7 +2625,6 @@ paths: - name - system_type - entity_type - description: ':returns: :class:`ExternalMetadata`' required: - external_metadata responses: @@ -2632,7 +2732,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2674,7 +2773,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`ExternalMetadata`' responses: '200': description: Success @@ -2743,6 +2841,17 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -2831,19 +2940,6 @@ paths: - name - system_type - entity_type - description: >- - :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. required: - external_metadata responses: @@ -3813,29 +3909,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3935,29 +4022,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4970,11 +5048,9 @@ paths: description: The comment attached to the model version created_at: type: integer - description: >- - :param created_by: str (optional) The identifier of the user - who created the model version created_by: type: string + description: The identifier of the user who created the model version id: type: string description: The unique identifier of the model version @@ -5087,11 +5163,11 @@ paths: data files are stored updated_at: type: integer - description: >- - :param updated_by: str (optional) The identifier of the user - who updated the model version last time updated_by: type: string + description: >- + The identifier of the user who updated the model version + last time responses: '200': description: Success @@ -6568,16 +6644,16 @@ paths: post: operationId: quality_monitors_cancel_refresh summary: >- - [DEPRECATED] Cancels an already-initiated refresh job. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Cancels an tags: - catalog - quality_monitors description: >- - [DEPRECATED] Cancels an already-initiated refresh job. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Cancels an - (/api/data-quality/v1/monitors). + already-initiated refresh job. :param table_name: str @@ -6598,7 +6674,6 @@ paths: required: true schema: type: integer - description: int responses: '200': description: Success @@ -6618,16 +6693,16 @@ paths: post: operationId: quality_monitors_create summary: >- - [DEPRECATED] Creates a new monitor for the specified table. Use Data - Quality Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Creates a new tags: - catalog - quality_monitors description: >- - [DEPRECATED] Creates a new monitor for the specified table. Use Data - Quality Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Creates a new - (/api/data-quality/v1/monitors). + monitor for the specified table. The caller must either: 1. be an owner of the table's parent catalog, @@ -6817,29 +6892,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6887,12 +6953,11 @@ paths: - granularities - prediction_col - model_id_col + latest_monitor_failure_msg: + type: string description: >- - :param latest_monitor_failure_msg: str (optional) [Create:ERR Update:IGN] The latest error message for a monitor failure. - latest_monitor_failure_msg: - type: string notifications: type: object properties: @@ -7014,16 +7079,16 @@ paths: delete: operationId: quality_monitors_delete summary: >- - [DEPRECATED] Deletes a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Deletes a monitor tags: - catalog - quality_monitors description: >- - [DEPRECATED] Deletes a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Deletes a monitor - (/api/data-quality/v1/monitors). + for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7084,16 +7149,16 @@ paths: get: operationId: quality_monitors_get summary: >- - [DEPRECATED] Gets a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets a monitor for tags: - catalog - quality_monitors description: >- - [DEPRECATED] Gets a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets a monitor for - (/api/data-quality/v1/monitors). + the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7153,16 +7218,16 @@ paths: put: operationId: quality_monitors_update summary: >- - [DEPRECATED] Updates a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Updates a monitor tags: - catalog - quality_monitors description: >- - [DEPRECATED] Updates a monitor for the specified table. Use Data Quality - Monitors API instead + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Updates a monitor - (/api/data-quality/v1/monitors). + for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7349,29 +7414,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7419,12 +7475,11 @@ paths: - granularities - prediction_col - model_id_col + latest_monitor_failure_msg: + type: string description: >- - :param latest_monitor_failure_msg: str (optional) [Create:ERR Update:IGN] The latest error message for a monitor failure. - latest_monitor_failure_msg: - type: string notifications: type: object properties: @@ -7535,16 +7590,16 @@ paths: get: operationId: quality_monitors_get_refresh summary: >- - [DEPRECATED] Gets info about a specific monitor refresh using the given - refresh ID. Use Data Quality + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets info about a tags: - catalog - quality_monitors description: >- - [DEPRECATED] Gets info about a specific monitor refresh using the given - refresh ID. Use Data Quality + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets info about a - Monitors API instead (/api/data-quality/v1/monitors). + specific monitor refresh using the given refresh ID. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7605,17 +7660,17 @@ paths: get: operationId: quality_monitors_list_refreshes summary: >- - [DEPRECATED] Gets an array containing the history of the most recent - refreshes (up to 25) for this + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets an array tags: - catalog - quality_monitors description: >- - [DEPRECATED] Gets an array containing the history of the most recent - refreshes (up to 25) for this + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Gets an array - table. Use Data Quality Monitors API instead - (/api/data-quality/v1/monitors). + containing the history of the most recent refreshes (up to 25) for this + table. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7670,17 +7725,17 @@ paths: post: operationId: quality_monitors_run_refresh summary: >- - [DEPRECATED] Queues a metric refresh on the monitor for the specified - table. Use Data Quality Monitors + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Queues a metric tags: - catalog - quality_monitors description: >- - [DEPRECATED] Queues a metric refresh on the monitor for the specified - table. Use Data Quality Monitors + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Queues a metric - API instead (/api/data-quality/v1/monitors). The refresh will execute in - the background. + refresh on the monitor for the specified table. The refresh will execute + in the background. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -7736,16 +7791,16 @@ paths: post: operationId: quality_monitors_regenerate_dashboard summary: >- - [DEPRECATED] Regenerates the monitoring dashboard for the specified - table. Use Data Quality Monitors + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Regenerates the tags: - catalog - quality_monitors description: >- - [DEPRECATED] Regenerates the monitoring dashboard for the specified - table. Use Data Quality Monitors + Deprecated: Use Data Quality Monitors API instead + (/api/data-quality/v1/monitors). Regenerates the - API instead (/api/data-quality/v1/monitors). + monitoring dashboard for the specified table. The caller must either: 1. be an owner of the table's parent catalog 2. @@ -8620,29 +8675,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10452,7 +10498,10 @@ paths: required: - name - child_columns - description: ':returns: :class:`TableConstraint`' + description: >- + A table constraint, as defined by *one* of the following + fields being set: + __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__. required: - full_name_arg - constraint @@ -10647,7 +10696,58 @@ paths: - METRIC_VIEW - STREAMING_TABLE - VIEW - description: ':param data_source_format: :class:`DataSourceFormat`' + 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. data_source_format: type: string x-enum: @@ -10699,6 +10799,28 @@ paths: properties: function_name: type: string + using_arguments: + type: array + items: + type: object + properties: + column: + type: string + description: A column reference. + constant: + type: string + description: A constant literal. + description: >- + A positional argument passed to a row filter or + 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. using_column_names: type: array items: @@ -10774,29 +10896,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -12797,6 +12910,16 @@ components: properties: function_name: type: string + using_arguments: + 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. using_column_names: type: array items: @@ -13398,9 +13521,21 @@ components: description: >- The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes. + source_type: + $ref: '#/components/schemas/TagAssignmentSourceType' + 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 @@ -13598,11 +13733,18 @@ components: credential_name: type: string description: Name of the storage credential used with this location. + effective_enable_file_events: + type: boolean + description: >- + The effective value of `enable_file_events` after applying + server-side defaults. enable_file_events: type: boolean description: >- Whether to enable file events on this external location. Default to - `true`. Set to `false` to disable file events. + `true`. Set to `false` to disable file events. The actual applied + value may differ due to server-side defaults; check + `effective_enable_file_events` for the effective state. encryption_details: $ref: '#/components/schemas/EncryptionDetails' fallback: @@ -15025,6 +15167,19 @@ components: The total number of rows that need to be synced in this update. This number may be an estimate. description: Progress information of the Online Table data synchronization pipeline. + PolicyFunctionArgument: + type: object + properties: + column: + type: string + description: A column reference. + constant: + type: string + description: A constant literal. + description: >- + A positional argument passed to a row filter or column mask function. + Distinguishes between + column references and literals. PolicyInfo: type: object properties: @@ -15707,6 +15862,16 @@ components: The list of table columns to be passed as input to the row filter function. The column types should match the types of the filter function arguments. + input_arguments: + 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. required: - function_name - input_column_names @@ -16021,20 +16186,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16095,20 +16260,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16160,20 +16325,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16202,20 +16367,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16243,20 +16408,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16286,20 +16451,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16328,20 +16493,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16358,6 +16523,7 @@ components: x-enum: - ANY_STATIC_CREDENTIAL - BEARER_TOKEN + - EDGEGRID_AKAMAI - OAUTH_ACCESS_TOKEN - OAUTH_M2M - OAUTH_MTLS @@ -16371,7 +16537,7 @@ components: - SSWS_TOKEN - UNKNOWN_CREDENTIAL_TYPE - USERNAME_PASSWORD - description: 'Next Id: 15' + description: 'Next Id: 17' DataSourceFormat: type: string x-enum: @@ -16423,20 +16589,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16468,20 +16634,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16510,20 +16676,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16553,20 +16719,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16594,20 +16760,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16636,20 +16802,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16677,20 +16843,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16720,20 +16886,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16761,20 +16927,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16803,20 +16969,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16845,20 +17011,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16887,20 +17053,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16936,20 +17102,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -16990,20 +17156,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17035,20 +17201,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17115,20 +17281,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17211,20 +17377,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17253,20 +17419,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17296,20 +17462,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17386,20 +17552,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17432,20 +17598,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17523,7 +17689,7 @@ components: - TABLE_SYSTEM_DELTASHARING - TABLE_VIEW - TABLE_VIEW_DELTASHARING - description: 'Latest kind: CONNECTION_OKTA_SYSTEM_LOGS_SSWS_TOKEN = 295; Next id: 296' + description: 'Latest kind: CONNECTION_GOOGLE_DRIVE_SERVICE_ACCOUNT = 301; Next id: 302' SecurableType: type: string x-enum: @@ -17565,20 +17731,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17607,20 +17773,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17670,20 +17836,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17712,20 +17878,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17761,20 +17927,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -17786,6 +17952,11 @@ components: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + TagAssignmentSourceType: + type: string + x-enum: + - TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION + description: Enum representing the source type of a tag assignment ValidateCredentialResult: type: string x-enum: @@ -17830,20 +18001,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 aea0a912..d19248b5 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/cleanrooms.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.cleanrooms servers: - url: https://{deployment_name}.cloud.databricks.com @@ -390,7 +390,7 @@ paths: required: - name - asset_type - description: ':returns: :class:`CleanRoomAsset`' + description: Metadata of the clean room asset required: - asset responses: @@ -529,7 +529,6 @@ paths: required: - etag - review_state - description: ':returns: :class:`CreateCleanRoomAssetReviewResponse`' required: - asset_type responses: @@ -1006,7 +1005,6 @@ paths: runner_collaborator_alias: type: string description: Collaborator alias of the runner covered by the rule. - description: ':returns: :class:`CleanRoomAutoApprovalRule`' required: - auto_approval_rule responses: @@ -1050,14 +1048,12 @@ paths: required: true schema: type: string - description: >- - :param page_size: int (optional) Maximum number of auto-approval - rules to return. Defaults to 100. - name: page_size in: query required: false schema: type: integer + description: Maximum number of auto-approval rules to return. Defaults to 100. - name: page_token in: query required: false @@ -1101,7 +1097,6 @@ paths: required: true schema: type: string - description: ':param rule_id: str' - name: rule_id in: path required: true @@ -1141,7 +1136,6 @@ paths: required: true schema: type: string - description: ':param rule_id: str' - name: rule_id in: path required: true @@ -1392,29 +1386,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1481,29 +1466,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1706,10 +1682,6 @@ paths: description: >- When the clean room was last updated, in epoch milliseconds. - description: >- - :returns: Long-running operation waiter for - :class:`CleanRoom`. See :method:wait_get_clean_room_active - for more details. required: - clean_room responses: @@ -1844,29 +1816,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1886,7 +1849,6 @@ paths: have their own attributes -- see the documentation for details. - description: ':returns: :class:`CreateCleanRoomOutputCatalogResponse`' required: - output_catalog responses: @@ -1970,7 +1932,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`CleanRoom`' responses: '200': description: Success @@ -2055,29 +2016,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2144,29 +2096,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2369,7 +2312,6 @@ paths: description: >- When the clean room was last updated, in epoch milliseconds. - description: ':returns: :class:`CleanRoom`' responses: '200': description: Success @@ -2790,6 +2732,8 @@ components: properties: output_catalog: $ref: '#/components/schemas/CleanRoomOutputCatalog' + required: + - output_catalog DeleteCleanRoomAssetResponse: type: object properties: {} @@ -2882,20 +2826,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2927,20 +2871,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2970,20 +2914,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3011,20 +2955,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3054,20 +2998,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3096,20 +3040,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3139,20 +3083,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3183,20 +3127,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 b4ca49cb..24b2d36b 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/compute.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.compute servers: - url: https://{deployment_name}.cloud.databricks.com @@ -658,7 +658,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ClusterPolicyPermissions`' responses: '200': description: Success @@ -731,7 +730,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ClusterPolicyPermissions`' responses: '200': description: Success @@ -838,11 +836,9 @@ paths: properties: cluster_id: type: string - description: >- - :param owner_username: str New owner of the cluster_id after - this RPC. owner_username: type: string + description: New owner of the cluster_id after this RPC. required: - cluster_id - owner_username @@ -1408,8 +1404,65 @@ paths: - SINGLE_USER - USER_ISOLATION description: >- - :param docker_image: :class:`DockerImage` (optional) Custom - docker image BYOC + Data security mode decides what data governance model to use + when accessing data from a cluster. + + + The following modes can only be used when `kind = + CLASSIC_PREVIEW`. * `DATA_SECURITY_MODE_AUTO`: + + Databricks will choose the most appropriate access mode + depending on your compute configuration. + + * `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`. + * `DATA_SECURITY_MODE_DEDICATED`: + + Alias for `SINGLE_USER`. + + + The following modes can be used regardless of `kind`. * + `NONE`: No security isolation for + + multiple users sharing the cluster. Data governance features + are not available in this mode. * + + `SINGLE_USER`: A secure cluster that can only be exclusively + used by a single user specified in + + `single_user_name`. Most programming languages, cluster + features and data governance features + + are available in this mode. * `USER_ISOLATION`: A secure + cluster that can be shared by multiple + + users. Cluster users are fully isolated so that they cannot + see each other's data and + + credentials. Most data governance features are supported in + this mode. But programming languages + + and cluster features might be limited. + + + The following modes are deprecated starting with Databricks + Runtime 15.0 and will be removed for + + future Databricks Runtime versions: + + + * `LEGACY_TABLE_ACL`: This mode is for users migrating from + legacy Table ACL clusters. * + + `LEGACY_PASSTHROUGH`: This mode is for users migrating from + legacy Passthrough on high + + concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is + for users migrating from legacy + + Passthrough on standard clusters. * + `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that + + doesn’t have UC nor passthrough enabled. docker_image: type: object properties: @@ -1424,6 +1477,7 @@ paths: url: type: string description: URL of the docker image. + description: Custom docker image BYOC driver_instance_pool_id: type: string description: >- @@ -1706,15 +1760,45 @@ paths: x-enum: - CLASSIC_PREVIEW description: >- - :param node_type_id: str (optional) This field encodes, - through a single value, the resources available to each of - the Spark nodes in this cluster. For example, the Spark - nodes can be provisioned and optimized for memory or compute - intensive workloads. A list of available node types can be - retrieved by using the :method:clusters/listNodeTypes API - call. + The kind of compute described by this compute specification. + + + Depending on `kind`, different validations and default + values will be applied. + + + Clusters with `kind = CLASSIC_PREVIEW` support the following + fields, whereas clusters with no + + specified `kind` do not. * + [is_single_node](/api/workspace/clusters/create#is_single_node) + * + + [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * + + [data_security_mode](/api/workspace/clusters/create#data_security_mode) + set to + + `DATA_SECURITY_MODE_AUTO`, `DATA_SECURITY_MODE_DEDICATED`, + or `DATA_SECURITY_MODE_STANDARD` + + + By using the [simple form], your clusters are automatically + using `kind = CLASSIC_PREVIEW`. + + + [simple form]: + https://docs.databricks.com/compute/simple-form.html node_type_id: type: string + description: >- + This field encodes, through a single value, the resources + available to each of the Spark nodes in this cluster. For + example, the Spark nodes can be provisioned and optimized + for memory or compute intensive workloads. A list of + available node types can be retrieved by using the + :method:clusters/listNodeTypes API call. num_workers: type: integer description: >- @@ -1831,10 +1915,7 @@ paths: Notebooks, Jobs required: - clients - description: >- - :returns: Long-running operation waiter for - :class:`ClusterDetails`. See - :method:wait_get_cluster_running for more details. + description: Cluster Attributes showing for clusters workload types. required: - spark_version responses: @@ -2442,8 +2523,65 @@ paths: - SINGLE_USER - USER_ISOLATION description: >- - :param docker_image: :class:`DockerImage` (optional) Custom - docker image BYOC + Data security mode decides what data governance model to use + when accessing data from a cluster. + + + The following modes can only be used when `kind = + CLASSIC_PREVIEW`. * `DATA_SECURITY_MODE_AUTO`: + + Databricks will choose the most appropriate access mode + depending on your compute configuration. + + * `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`. + * `DATA_SECURITY_MODE_DEDICATED`: + + Alias for `SINGLE_USER`. + + + The following modes can be used regardless of `kind`. * + `NONE`: No security isolation for + + multiple users sharing the cluster. Data governance features + are not available in this mode. * + + `SINGLE_USER`: A secure cluster that can only be exclusively + used by a single user specified in + + `single_user_name`. Most programming languages, cluster + features and data governance features + + are available in this mode. * `USER_ISOLATION`: A secure + cluster that can be shared by multiple + + users. Cluster users are fully isolated so that they cannot + see each other's data and + + credentials. Most data governance features are supported in + this mode. But programming languages + + and cluster features might be limited. + + + The following modes are deprecated starting with Databricks + Runtime 15.0 and will be removed for + + future Databricks Runtime versions: + + + * `LEGACY_TABLE_ACL`: This mode is for users migrating from + legacy Table ACL clusters. * + + `LEGACY_PASSTHROUGH`: This mode is for users migrating from + legacy Passthrough on high + + concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is + for users migrating from legacy + + Passthrough on standard clusters. * + `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that + + doesn’t have UC nor passthrough enabled. docker_image: type: object properties: @@ -2458,6 +2596,7 @@ paths: url: type: string description: URL of the docker image. + description: Custom docker image BYOC driver_instance_pool_id: type: string description: >- @@ -2740,15 +2879,45 @@ paths: x-enum: - CLASSIC_PREVIEW description: >- - :param node_type_id: str (optional) This field encodes, - through a single value, the resources available to each of - the Spark nodes in this cluster. For example, the Spark - nodes can be provisioned and optimized for memory or compute - intensive workloads. A list of available node types can be - retrieved by using the :method:clusters/listNodeTypes API - call. + The kind of compute described by this compute specification. + + + Depending on `kind`, different validations and default + values will be applied. + + + Clusters with `kind = CLASSIC_PREVIEW` support the following + fields, whereas clusters with no + + specified `kind` do not. * + [is_single_node](/api/workspace/clusters/create#is_single_node) + * + + [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * + + [data_security_mode](/api/workspace/clusters/create#data_security_mode) + set to + + `DATA_SECURITY_MODE_AUTO`, `DATA_SECURITY_MODE_DEDICATED`, + or `DATA_SECURITY_MODE_STANDARD` + + + By using the [simple form], your clusters are automatically + using `kind = CLASSIC_PREVIEW`. + + + [simple form]: + https://docs.databricks.com/compute/simple-form.html node_type_id: type: string + description: >- + This field encodes, through a single value, the resources + available to each of the Spark nodes in this cluster. For + example, the Spark nodes can be provisioned and optimized + for memory or compute intensive workloads. A list of + available node types can be retrieved by using the + :method:clusters/listNodeTypes API call. num_workers: type: integer description: >- @@ -2865,10 +3034,7 @@ paths: Notebooks, Jobs required: - clients - description: >- - :returns: Long-running operation waiter for - :class:`ClusterDetails`. See - :method:wait_get_cluster_running for more details. + description: Cluster Attributes showing for clusters workload types. required: - cluster_id - spark_version @@ -3009,29 +3175,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3304,7 +3461,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ClusterPermissions`' responses: '200': description: Success @@ -3377,7 +3533,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ClusterPermissions`' responses: '200': description: Success @@ -3622,7 +3777,6 @@ paths: properties: cluster_id: type: string - description: str required: - cluster_id responses: @@ -3767,10 +3921,6 @@ paths: description: The cluster to be started. restart_user: type: string - description: >- - :returns: Long-running operation waiter for - :class:`ClusterDetails`. See - :method:wait_get_cluster_running for more details. required: - cluster_id responses: @@ -3916,7 +4066,6 @@ paths: properties: cluster_id: type: string - description: str required: - cluster_id responses: @@ -4940,18 +5089,12 @@ paths: schema: type: object properties: - cluster_id: + clusterId: type: string - description: ':param command_id: str (optional)' - command_id: + commandId: type: string - context_id: + contextId: type: string - description: >- - :returns: Long-running operation waiter for - :class:`CommandStatusResponse`. See - :method:wait_command_status_command_execution_cancelled for - more details. responses: '200': description: Success @@ -5002,7 +5145,6 @@ paths: required: true schema: type: string - description: ':param context_id: str' - name: context_id in: query required: true @@ -5013,7 +5155,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`CommandStatusResponse`' responses: '200': description: Success @@ -5053,7 +5194,6 @@ paths: required: true schema: type: string - description: ':param context_id: str' - name: context_id in: query required: true @@ -5103,7 +5243,7 @@ paths: schema: type: object properties: - cluster_id: + clusterId: type: string description: Running cluster id language: @@ -5114,10 +5254,57 @@ paths: - scala - sql description: >- - :returns: Long-running operation waiter for - :class:`ContextStatusResponse`. See - :method:wait_context_status_command_execution_running for - more details. + 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. responses: '200': description: Success @@ -5155,14 +5342,13 @@ paths: schema: type: object properties: - cluster_id: + clusterId: type: string - description: ':param context_id: str' - context_id: + contextId: type: string required: - - cluster_id - - context_id + - clusterId + - contextId responses: '200': description: Success @@ -5214,13 +5400,13 @@ paths: schema: type: object properties: - cluster_id: + clusterId: type: string description: Running cluster id command: type: string description: Executable code - context_id: + contextId: type: string description: Running context id language: @@ -5231,10 +5417,57 @@ paths: - scala - sql description: >- - :returns: Long-running operation waiter for - :class:`CommandStatusResponse`. See - :method:wait_command_status_command_execution_finished_or_error - for more details. + 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. responses: '200': description: Success @@ -6002,8 +6235,6 @@ paths: upsize requests. :param min_idle_instances: int (optional) Minimum number of idle instances to keep in the instance pool - :param node_type_flexibility: :class:`NodeTypeFlexibility` (optional) - Flexible node type configuration for the pool. :param remote_disk_throughput: int (optional) If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. @@ -6063,17 +6294,6 @@ paths: description: >- Minimum number of idle instances to keep in the instance pool - node_type_flexibility: - type: object - properties: - alternate_node_type_ids: - type: array - items: - type: string - description: >- - A list of node type IDs to use as fallbacks when the - primary node type is unavailable. - description: Flexible node type configuration for the pool. remote_disk_throughput: type: integer description: >- @@ -6286,7 +6506,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`InstancePoolPermissions`' responses: '200': description: Success @@ -6360,7 +6579,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`InstancePoolPermissions`' responses: '200': description: Success @@ -8731,7 +8949,8 @@ components: environment_version: type: string description: >- - Required. Environment version used by the environment. Each version + 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: @@ -8745,7 +8964,7 @@ components: The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and DLT's environment for classic and serverless pipelines. In this minimal - environment spec, only pip dependencies are supported. + environment spec, only pip and java dependencies are supported. EventDetails: type: object properties: @@ -10609,20 +10828,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10683,20 +10902,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10726,20 +10945,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10768,20 +10987,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10901,6 +11120,7 @@ components: - AUTORECOVERY - AUTOSCALE - AUTOSCALE_V2 + - DBR_AUTOSCALE - REPLACE_BAD_NODES - USER_REQUEST description: The cause of a change in target size. @@ -10952,20 +11172,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11006,20 +11226,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11143,20 +11363,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11197,20 +11417,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11239,20 +11459,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11281,20 +11501,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11323,20 +11543,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11368,20 +11588,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11411,20 +11631,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11563,6 +11783,7 @@ components: - GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED - GKE_BASED_CLUSTER_TERMINATION - GLOBAL_INIT_SCRIPT_FAILURE + - HIVEMETASTORE_CONNECTIVITY_FAILURE - HIVE_METASTORE_PROVISIONING_FAILURE - IMAGE_PULL_PERMISSION_DENIED - INACTIVITY 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 80855593..d0562138 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/dashboards.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.dashboards servers: - url: https://{deployment_name}.cloud.databricks.com @@ -666,6 +666,298 @@ paths: 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. + tags: + - dashboards + - genie + description: >- + Create and run evaluations for multiple benchmark questions in a Genie + space. + + + :param space_id: str + The ID associated with the Genie space where the evaluations will be executed. + :param benchmark_question_ids: List[str] (optional) + List of benchmark question IDs to evaluate. These questions must exist in the specified Genie space. + If none are specified, then all benchmark questions are evaluated. + + :returns: :class:`GenieEvalRunResponse` + parameters: + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The ID associated with the Genie space where the evaluations will be + executed. + requestBody: + content: + application/json: + schema: + type: object + properties: + benchmark_question_ids: + type: array + items: + type: string + description: >- + List of benchmark question IDs to evaluate. These questions + must exist in the specified Genie space. If none are + specified, then all benchmark questions are evaluated. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieEvalRunResponse' + default: + description: Error response + content: + application/json: + schema: + type: object + properties: + error: + type: string + message: + type: string + x-stackql-sdk-source: GenieAPI + get: + operationId: genie_genie_list_eval_runs + summary: Lists all evaluation runs in a space. + tags: + - dashboards + - genie + description: |- + Lists all evaluation runs in a space. + + :param space_id: str + The ID associated with the Genie space where the evaluation run is located. + :param page_size: int (optional) + Maximum number of evaluation runs to return per page + :param page_token: str (optional) + Token to get the next page of results + + :returns: :class:`GenieListEvalRunsResponse` + parameters: + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The ID associated with the Genie space where the evaluation run is + located. + - name: page_size + in: query + required: false + schema: + type: integer + description: Maximum number of evaluation runs to return per page + - name: page_token + in: query + required: false + schema: + type: string + description: Token to get the next page of results + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieListEvalRunsResponse' + 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/{eval_run_id}/results/{result_id}: + get: + operationId: genie_genie_get_eval_result_details + summary: Get details for evaluation results. + tags: + - dashboards + - genie + description: |- + Get details for evaluation results. + + :param space_id: str + The ID associated with the Genie space where the evaluation run is located. + :param eval_run_id: str + The unique identifier for the evaluation run. + :param result_id: str + The unique identifier for the evaluation result. + + :returns: :class:`GenieEvalResultDetails` + parameters: + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The ID associated with the Genie space where the evaluation run is + located. + - name: eval_run_id + in: path + required: true + schema: + type: string + description: The unique identifier for the evaluation run. + - name: result_id + in: path + required: true + schema: + type: string + description: The unique identifier for the evaluation result. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieEvalResultDetails' + 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/{eval_run_id}: + get: + operationId: genie_genie_get_eval_run + summary: Get evaluation run details. + tags: + - dashboards + - genie + description: |- + Get evaluation run details. + + :param space_id: str + The ID associated with the Genie space where the evaluation run is located. + :param eval_run_id: str + + :returns: :class:`GenieEvalRunResponse` + parameters: + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The ID associated with the Genie space where the evaluation run is + located. + - name: eval_run_id + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieEvalRunResponse' + 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/{eval_run_id}/results: + get: + operationId: genie_genie_list_eval_results + summary: List evaluation results for a specific evaluation run. + tags: + - dashboards + - genie + description: |- + List evaluation results for a specific evaluation run. + + :param space_id: str + The ID associated with the Genie space where the evaluation run is located. + :param eval_run_id: str + The unique identifier for the evaluation run. + :param page_size: int (optional) + Maximum number of eval results to return per page. + :param page_token: str (optional) + Opaque token to retrieve the next page of results. + + :returns: :class:`GenieListEvalResultsResponse` + parameters: + - name: space_id + in: path + required: true + schema: + type: string + description: >- + The ID associated with the Genie space where the evaluation run is + located. + - name: eval_run_id + in: path + required: true + schema: + type: string + description: The unique identifier for the evaluation run. + - name: page_size + in: query + required: false + schema: + type: integer + description: Maximum number of eval results to return per page. + - name: page_token + in: query + required: false + schema: + type: string + description: Opaque token to retrieve the next page of results. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GenieListEvalResultsResponse' + 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}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/downloads/{download_id}: get: operationId: genie_get_download_full_query_result @@ -733,7 +1025,7 @@ paths: :param download_id: str Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult) - :param download_id_signature: str (optional) + :param download_id_signature: str JWT signature for the download_id to ensure secure access to query results :returns: :class:`GenieGetDownloadFullQueryResultResponse` @@ -772,7 +1064,7 @@ paths: endpoint](:method:genie/generateDownloadFullQueryResult) - name: download_id_signature in: query - required: false + required: true schema: type: string description: >- @@ -1376,6 +1668,11 @@ paths: required: false schema: type: string + description: >- + 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 + existing configuration. - name: dataset_schema in: query required: false @@ -1451,12 +1748,6 @@ paths: warehouse_id: type: string description: The warehouse ID used to run the dashboard. - description: >- - :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 - existing configuration. required: - dashboard responses: @@ -1807,6 +2098,13 @@ paths: 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. @@ -2347,6 +2645,11 @@ paths: required: false schema: type: string + description: >- + 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 + existing configuration. - name: dataset_schema in: query required: false @@ -2422,12 +2725,6 @@ paths: warehouse_id: type: string description: The warehouse ID used to run the dashboard. - description: >- - :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 - existing configuration. required: - dashboard responses: @@ -2819,20 +3116,14 @@ components: text: $ref: '#/components/schemas/TextAttachment' description: >- - Text Attachment if Genie responds with text. This also contains the + Text Attachment if Genie responds with text This also contains the final summary when available. description: Genie AI Response GenieConversation: type: object properties: - id: - type: string space_id: type: string - description: Genie space ID - user_id: - type: integer - description: ID of the user who created the conversation title: type: string description: Conversation title @@ -2842,13 +3133,17 @@ components: created_timestamp: type: integer description: Timestamp when the message was created + id: + type: string + description: Conversation ID. Legacy identifier, use conversation_id instead last_updated_timestamp: type: integer description: Timestamp when the message was last updated + user_id: + type: integer + description: ID of the user who created the conversation required: - - id - space_id - - user_id - title - conversation_id GenieConversationSummary: @@ -2856,14 +3151,132 @@ components: properties: conversation_id: type: string + created_timestamp: + type: integer title: type: string + required: + - conversation_id + GenieEvalResponse: + type: object + properties: + response: + type: string + response_type: + $ref: '#/components/schemas/GenieEvalResponseType' + description: Type of response + sql_execution_result: + type: string + description: SQL Statement Execution response. + GenieEvalResult: + type: object + properties: + result_id: + type: string + description: Unique identifier for this evaluation result. + space_id: + type: string + description: The ID of the space the evaluation result belongs to. + benchmark_question_id: + type: string + description: The ID of the benchmark question that was evaluated. + benchmark_answer: + type: string + description: Stored snapshot of original benchmark answer text. + created_by_user: + type: integer + description: User ID who created evaluation result. + question: + type: string + description: Stored snapshot of original benchmark question text. + status: + $ref: '#/components/schemas/EvaluationStatusType' + description: Current status of this evaluation result. + required: + - result_id + - space_id + - benchmark_question_id + description: >- + Shows summary information for an evaluation result. For detailed + information including SQL + execution results, actual/expected responses, and assessment scores, use + GenieGetEvalResultDetails. + GenieEvalResultDetails: + type: object + properties: + result_id: + type: string + description: The unique identifier for the evaluation result. + space_id: + type: string + description: The ID of the space the evaluation result belongs to. + benchmark_question_id: + type: string + description: The ID of the benchmark question that was evaluated. + actual_response: + type: array + items: + $ref: '#/components/schemas/GenieEvalResponse' + description: The actual response generated by Genie. + assessment: + $ref: '#/components/schemas/GenieEvalAssessment' + description: 'Assessment of the evaluation result: good, bad, or needs review' + assessment_reasons: + type: array + items: + $ref: '#/components/schemas/ScoreReason' + description: Reasons for the assessment score. + eval_run_status: + $ref: '#/components/schemas/EvaluationStatusType' + description: Current status of the evaluation run. + expected_response: + type: array + items: + $ref: '#/components/schemas/GenieEvalResponse' + description: The expected responses from the benchmark. + manual_assessment: + type: boolean + description: Whether this evaluation was manually assessed. + required: + - result_id + - space_id + - benchmark_question_id + description: Shows detailed information for an evaluation result. + GenieEvalRunResponse: + type: object + properties: + eval_run_id: + type: string created_timestamp: type: integer + description: >- + Timestamp when the evaluation run was created (milliseconds since + epoch). + eval_run_status: + $ref: '#/components/schemas/EvaluationStatusType' + description: Current status of the evaluation run. + last_updated_timestamp: + type: integer + description: >- + Timestamp when the evaluation run was last updated (milliseconds + since epoch). + num_correct: + type: integer + description: Number of questions answered correctly. + num_done: + type: integer + description: Number of questions that have been completed. + num_needs_review: + type: integer + description: Number of questions that need manual review. + num_questions: + type: integer + description: Total number of questions in the evaluation run. + run_by_user: + type: integer + description: User ID who initiated the evaluation run. required: - - conversation_id - - title - - created_timestamp + - eval_run_id GenieFeedback: type: object properties: @@ -2911,6 +3324,26 @@ components: next_page_token: type: string description: Token to get the next page of results + GenieListEvalResultsResponse: + type: object + properties: + eval_results: + type: array + items: + $ref: '#/components/schemas/GenieEvalResult' + next_page_token: + type: string + description: The token to use for retrieving the next page of results. + GenieListEvalRunsResponse: + type: object + properties: + eval_runs: + type: array + items: + $ref: '#/components/schemas/GenieEvalRunResponse' + next_page_token: + type: string + description: The token to use for retrieving the next page of results. GenieListSpacesResponse: type: object properties: @@ -2924,11 +3357,8 @@ components: GenieMessage: type: object properties: - id: - type: string space_id: type: string - description: Genie space ID conversation_id: type: string description: Conversation ID @@ -2952,6 +3382,9 @@ components: feedback: $ref: '#/components/schemas/GenieFeedback' description: User feedback for the message if provided + id: + type: string + description: Message ID. Legacy identifier, use message_id instead last_updated_timestamp: type: integer description: Timestamp when the message was last updated @@ -2967,7 +3400,6 @@ components: type: integer description: ID of the user who created the message required: - - id - space_id - conversation_id - content @@ -3020,6 +3452,9 @@ components: description: type: string description: Description of the Genie Space + parent_path: + type: string + description: Parent folder path of the Genie Space serialized_space: type: string description: >- @@ -3224,6 +3659,12 @@ components: 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. @@ -3278,20 +3719,151 @@ components: Access them by: - - attribute access:: + - 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. + EvaluationStatusType: + type: string + x-enum: + - DONE + - EVALUATION_CANCELLED + - EVALUATION_FAILED + - EVALUATION_TIMEOUT + - NOT_STARTED + - RUNNING + 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. + GenieEvalAssessment: + type: string + x-enum: + - BAD + - GOOD + - NEEDS_REVIEW + 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 - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> 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. + GenieEvalResponseType: + type: string + x-enum: + - SQL + - TEXT + 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: @@ -3327,20 +3899,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3361,6 +3933,7 @@ components: - CHAT_COMPLETION_NETWORK_EXCEPTION - CONTENT_FILTER_EXCEPTION - CONTEXT_EXCEEDED_EXCEPTION + - COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION - COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION - COULD_NOT_GET_UC_SCHEMA_EXCEPTION - DEPLOYMENT_NOT_FOUND_EXCEPTION @@ -3427,20 +4000,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3521,20 +4094,85 @@ components: Access them by: - - attribute access:: + - 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. + ScoreReason: + type: string + x-enum: + - COLUMN_TYPE_DIFFERENCE + - EMPTY_GOOD_SQL + - EMPTY_RESULT + - LLM_JUDGE_FORMATTING_ERROR + - LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT + - LLM_JUDGE_INCORRECT_FUNCTION_USAGE + - LLM_JUDGE_INCORRECT_METRIC_CALCULATION + - LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE + - LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC + - LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST + - LLM_JUDGE_MISSING_JOIN + - LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION + - LLM_JUDGE_MISSING_OR_INCORRECT_FILTER + - LLM_JUDGE_MISSING_OR_INCORRECT_JOIN + - LLM_JUDGE_OTHER + - LLM_JUDGE_SEMANTIC_ERROR + - LLM_JUDGE_SYNTAX_ERROR + - LLM_JUDGE_WRONG_AGGREGATION + - LLM_JUDGE_WRONG_COLUMNS + - LLM_JUDGE_WRONG_FILTER + - RESULT_EXTRA_COLUMNS + - RESULT_EXTRA_ROWS + - RESULT_MISSING_COLUMNS + - RESULT_MISSING_ROWS + - SINGLE_CELL_DIFFERENCE + 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 - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3651,6 +4289,42 @@ components: response: mediaType: application/json openAPIDocKey: '200' + genie_genie_create_eval_run: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1genie~1spaces~1{space_id}~1eval-runs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + genie_genie_list_eval_runs: + operation: + $ref: '#/paths/~1api~12.0~1genie~1spaces~1{space_id}~1eval-runs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + genie_genie_get_eval_result_details: + operation: + $ref: >- + #/paths/~1api~12.0~1genie~1spaces~1{space_id}~1eval-runs~1{eval_run_id}~1results~1{result_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + genie_genie_get_eval_run: + operation: + $ref: >- + #/paths/~1api~12.0~1genie~1spaces~1{space_id}~1eval-runs~1{eval_run_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + genie_genie_list_eval_results: + operation: + $ref: >- + #/paths/~1api~12.0~1genie~1spaces~1{space_id}~1eval-runs~1{eval_run_id}~1results/get + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: '#/paths/~1api~12.0~1genie~1spaces~1{space_id}/get' @@ -3674,9 +4348,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/genie/methods/genie_genie_get_eval_result_details + - $ref: >- + #/components/x-stackQL-resources/genie/methods/genie_genie_get_eval_run + - $ref: >- + #/components/x-stackQL-resources/genie/methods/genie_genie_list_eval_results + - $ref: >- + #/components/x-stackQL-resources/genie/methods/genie_genie_list_eval_runs - $ref: '#/components/x-stackQL-resources/genie/methods/get' - $ref: '#/components/x-stackQL-resources/genie/methods/list' insert: + - $ref: >- + #/components/x-stackQL-resources/genie/methods/genie_genie_create_eval_run - $ref: '#/components/x-stackQL-resources/genie/methods/create' update: - $ref: '#/components/x-stackQL-resources/genie/methods/update' 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 f057cedf..6b80a50a 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/database.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/database.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.database servers: - url: https://{deployment_name}.cloud.databricks.com @@ -54,7 +54,6 @@ paths: - name - database_instance_name - database_name - description: ':returns: :class:`DatabaseCatalog`' required: - catalog responses: @@ -392,7 +391,7 @@ paths: List Database Instances. :param page_size: int (optional) - Upper bound for items returned. + Upper bound for items returned. The maximum value is 100. :param page_token: str (optional) Pagination token to go to the next page of Database Instances. Requests first page if absent. @@ -403,7 +402,7 @@ paths: required: false schema: type: integer - description: Upper bound for items returned. + description: Upper bound for items returned. The maximum value is 100. - name: page_token in: query required: false @@ -451,13 +450,11 @@ paths: required: true schema: type: string - description: ':param database_instance_role: :class:`DatabaseInstanceRole`' - name: database_instance_name in: query required: false schema: type: string - description: ':returns: :class:`DatabaseInstanceRole`' requestBody: content: application/json: @@ -574,12 +571,12 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional) Upper bound for items returned.' - name: page_size in: query required: false schema: type: integer + description: Upper bound for items returned. - name: page_token in: query required: false @@ -638,9 +635,6 @@ paths: properties: name: type: string - description: >- - Full three-part (catalog, schema, table) name of the - table. database_instance_name: type: string description: >- @@ -663,7 +657,6 @@ paths: catalogs. required: - name - description: ':returns: :class:`DatabaseTable`' required: - table responses: @@ -708,9 +701,6 @@ paths: properties: name: type: string - description: >- - Full three-part (catalog, schema, table) name of the - table. data_synchronization_status: type: object properties: @@ -1121,7 +1111,6 @@ paths: runs asynchronously). required: - name - description: ':returns: :class:`SyncedDatabaseTable`' required: - synced_table responses: @@ -1159,7 +1148,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -1192,7 +1180,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`DatabaseCatalog`' responses: '200': description: Success @@ -1417,6 +1404,10 @@ paths: required: true schema: type: string + description: >- + 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. requestBody: content: application/json: @@ -1688,10 +1679,9 @@ paths: required: - name description: >- - :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. + A DatabaseInstance represents a logical Postgres instance, + comprised of both compute and + storage. required: - database_instance responses: @@ -1733,7 +1723,6 @@ paths: required: true schema: type: string - description: ':param name: str' - name: name in: path required: true @@ -1752,7 +1741,6 @@ paths: required: false schema: type: string - description: str (optional) responses: '200': description: Success @@ -1786,7 +1774,6 @@ paths: required: true schema: type: string - description: ':param name: str' - name: name in: path required: true @@ -1827,7 +1814,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -1860,7 +1846,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`DatabaseTable`' responses: '200': description: Success @@ -1898,14 +1883,14 @@ paths: required: true schema: type: string - description: >- - :param purge_data: bool (optional) Optional. When set to true, the - actual PostgreSQL table will be dropped from the database. - name: purge_data in: query required: false schema: type: boolean + description: >- + Optional. When set to true, the actual PostgreSQL table will be + dropped from the database. responses: '200': description: Success @@ -1938,7 +1923,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`SyncedDatabaseTable`' responses: '200': description: Success @@ -2000,9 +1984,6 @@ paths: properties: name: type: string - description: >- - Full three-part (catalog, schema, table) name of the - table. data_synchronization_status: type: object properties: @@ -2486,10 +2467,13 @@ paths: Generates a credential that can be used to access database instances. :param claims: List[:class:`RequestedClaims`] (optional) - The returned token will be scoped to the union of instance_names and instances containing the - specified UC tables, so instance_names is allowed to be empty. + 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 + connecting user additional grants to the Postgres resources that correspond to the UC resources. The + UC resources need to be something that have a Postgres counterpart. For example, a synced table or a + table in a UC database catalog. :param instance_names: List[str] (optional) - Instances to which the token will be scoped. + 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` @@ -2519,17 +2503,23 @@ paths: unspecified_resource_name: type: string description: >- - The returned token will be scoped to the union of - instance_names and instances containing the specified UC - tables, so instance_names is allowed to be empty. + 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 connecting user additional grants to the + Postgres resources that correspond to the UC resources. The + UC resources need to be something that have a Postgres + counterpart. For example, a synced table or a table in a UC + database catalog. instance_names: type: array items: type: string - description: Instances to which the token will be scoped. + description: >- + Instances to request a credential for. At least one of + instance_names or claims must be specified. request_id: type: string - description: ':returns: :class:`DatabaseCredential`' responses: '200': description: Success @@ -2951,7 +2941,6 @@ components: properties: name: type: string - description: Full three-part (catalog, schema, table) name of the table. database_instance_name: type: string description: >- @@ -2972,7 +2961,6 @@ components: catalogs. required: - name - description: 'Next field marker: 13' DeltaTableSyncInfo: type: object properties: @@ -3067,7 +3055,6 @@ components: properties: name: type: string - description: Full three-part (catalog, schema, table) name of the table. data_synchronization_status: $ref: '#/components/schemas/SyncedTableStatus' description: Synced Table data synchronization status @@ -3120,7 +3107,6 @@ components: "PROVISIONING" as it runs asynchronously). required: - name - description: 'Next field marker: 18' SyncedTableContinuousUpdateStatus: type: object properties: @@ -3341,20 +3327,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3392,20 +3378,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3438,20 +3424,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3481,20 +3467,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3529,20 +3515,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 6a53b0ef..3e1221ec 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/dataquality.yaml @@ -6,7 +6,7 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.dataquality servers: - url: https://{deployment_name}.cloud.databricks.com @@ -532,7 +532,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -810,7 +809,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false 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 e82da74f..b2111dea 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/files.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/files.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.files servers: - url: https://{deployment_name}.cloud.databricks.com @@ -1033,6 +1033,10 @@ paths: required: false schema: type: boolean + description: >- + If true or unspecified, an existing file will be overwritten. If + false, an error will be returned if the path points to an existing + file. requestBody: content: application/json: @@ -1042,10 +1046,6 @@ paths: contents: type: string format: binary - description: >- - :param overwrite: bool (optional) If true or unspecified, an - existing file will be overwritten. If false, an error will - be returned if the path points to an existing file. required: - contents responses: 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 46546729..7a32e3bf 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/iam.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.iam servers: - url: https://{deployment_name}.cloud.databricks.com @@ -40,7 +40,6 @@ paths: required: true schema: $ref: '#/components/schemas/Actor' - description: ':param permission: str' - name: permission in: query required: true @@ -58,7 +57,6 @@ paths: required: true schema: $ref: '#/components/schemas/ConsistencyToken' - description: ':param authz_identity: :class:`RequestAuthzIdentity`' - name: authz_identity in: query required: true @@ -69,7 +67,6 @@ paths: required: false schema: $ref: '#/components/schemas/ResourceInfo' - description: ':returns: :class:`CheckPolicyResponse`' responses: '200': description: Success @@ -271,7 +268,6 @@ paths: required: - name - etag - description: ':returns: :class:`RuleSetResponse`' required: - name - rule_set @@ -361,7 +357,7 @@ paths: schema: type: object properties: - display_name: + displayName: type: string description: String that represents a human-readable group name entitlements: @@ -381,9 +377,8 @@ paths: type: string description: 'Entitlements assigned to the group. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string - description: ':param groups: List[:class:`ComplexValue`] (optional)' groups: type: array items: @@ -417,13 +412,12 @@ paths: type: string value: type: string - description: ':param meta: :class:`ResourceMeta` (optional) Container for the group identifier. Workspace - local versus account.' meta: type: object properties: resourceType: type: string + description: Container for the group identifier. Workspace local versus account. roles: type: array items: @@ -458,20 +452,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -697,7 +691,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -715,8 +709,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -735,20 +727,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -760,6 +752,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -815,7 +808,7 @@ paths: schema: type: object properties: - display_name: + displayName: type: string description: String that represents a human-readable group name entitlements: @@ -835,9 +828,8 @@ paths: type: string description: 'Entitlements assigned to the group. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string - description: ':param groups: List[:class:`ComplexValue`] (optional)' groups: type: array items: @@ -868,13 +860,12 @@ paths: type: string value: type: string - description: ':param meta: :class:`ResourceMeta` (optional) Container for the group identifier. Workspace - local versus account.' meta: type: object properties: resourceType: type: string + description: Container for the group identifier. Workspace local versus account. roles: type: array items: @@ -909,20 +900,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1024,9 +1015,9 @@ paths: :param request_object_type: str The type of the request object. Can be one of the following: alerts, alertsv2, authorization, - clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, - instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or - warehouses. + clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, + experiments, files, genie, instance-pools, jobs, notebooks, pipelines, queries, registered-models, + repos, serving-endpoints, or warehouses. :param request_object_id: str The id of the request object. @@ -1038,8 +1029,8 @@ paths: schema: type: string description: 'The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, - cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, notebooks, - pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' + cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, + jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' - name: request_object_id in: path required: true @@ -1078,9 +1069,9 @@ paths: :param request_object_type: str The type of the request object. Can be one of the following: alerts, alertsv2, authorization, - clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, - instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or - warehouses. + clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, + experiments, files, genie, instance-pools, jobs, notebooks, pipelines, queries, registered-models, + repos, serving-endpoints, or warehouses. :param request_object_id: str The id of the request object. :param access_control_list: List[:class:`AccessControlRequest`] (optional) @@ -1093,8 +1084,8 @@ paths: schema: type: string description: 'The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, - cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, notebooks, - pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' + cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, + jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' - name: request_object_id in: path required: true @@ -1120,6 +1111,7 @@ paths: - CAN_ATTACH_TO - CAN_BIND - CAN_CREATE + - CAN_CREATE_APP - CAN_EDIT - CAN_EDIT_METADATA - CAN_MANAGE @@ -1143,7 +1135,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ObjectPermissions`' responses: '200': description: Success @@ -1175,9 +1166,9 @@ paths: :param request_object_type: str The type of the request object. Can be one of the following: alerts, alertsv2, authorization, - clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, - instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or - warehouses. + clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, + experiments, files, genie, instance-pools, jobs, notebooks, pipelines, queries, registered-models, + repos, serving-endpoints, or warehouses. :param request_object_id: str The id of the request object. :param access_control_list: List[:class:`AccessControlRequest`] (optional) @@ -1190,8 +1181,8 @@ paths: schema: type: string description: 'The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, - cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, notebooks, - pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' + cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, + jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' - name: request_object_id in: path required: true @@ -1217,6 +1208,7 @@ paths: - CAN_ATTACH_TO - CAN_BIND - CAN_CREATE + - CAN_CREATE_APP - CAN_EDIT - CAN_EDIT_METADATA - CAN_MANAGE @@ -1240,7 +1232,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ObjectPermissions`' responses: '200': description: Success @@ -1272,9 +1263,9 @@ paths: :param request_object_type: str The type of the request object. Can be one of the following: alerts, alertsv2, authorization, - clusters, cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, - instance-pools, jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or - warehouses. + clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, + experiments, files, genie, instance-pools, jobs, notebooks, pipelines, queries, registered-models, + repos, serving-endpoints, or warehouses. :param request_object_id: str :returns: :class:`GetPermissionLevelsResponse` @@ -1285,14 +1276,13 @@ paths: schema: type: string description: 'The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, - cluster-policies, dashboards, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, notebooks, - pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' + cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, + jobs, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.' - name: request_object_id in: path required: true schema: type: string - description: ':returns: :class:`GetPermissionLevelsResponse`' responses: '200': description: Success @@ -1352,10 +1342,10 @@ paths: active: type: boolean description: If this user is active - application_id: + applicationId: type: string description: UUID relating to the service principal - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. entitlements: @@ -1375,9 +1365,8 @@ paths: type: string description: 'Entitlements assigned to the service principal. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string - description: ':param groups: List[:class:`ComplexValue`] (optional)' groups: type: array items: @@ -1430,20 +1419,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1669,7 +1658,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -1687,8 +1676,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -1707,20 +1694,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1732,6 +1719,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -1793,10 +1781,10 @@ paths: active: type: boolean description: If this user is active - application_id: + applicationId: type: string description: UUID relating to the service principal - display_name: + displayName: type: string description: String that represents a concatenation of given and family names. entitlements: @@ -1816,9 +1804,8 @@ paths: type: string description: 'Entitlements assigned to the service principal. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string - description: ':param groups: List[:class:`ComplexValue`] (optional)' groups: type: array items: @@ -1868,20 +1855,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1957,7 +1944,7 @@ paths: active: type: boolean description: If this user is active - display_name: + displayName: type: string description: 'String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled]. Use @@ -1995,7 +1982,7 @@ paths: type: string description: 'Entitlements assigned to the user. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string description: External ID is not currently supported. It is reserved for future use. groups: @@ -2013,9 +2000,9 @@ paths: type: string value: type: string - description: ':param id: str (optional) Databricks user ID.' id: type: string + description: Databricks user ID. name: type: object properties: @@ -2024,8 +2011,6 @@ paths: givenName: type: string description: Given name of the Databricks user. - description: ':param roles: List[:class:`ComplexValue`] (optional) Corresponds to AWS instance profile/arn - role.' roles: type: array items: @@ -2041,6 +2026,7 @@ paths: type: string value: type: string + description: Corresponds to AWS instance profile/arn role. schemas: type: array items: @@ -2060,20 +2046,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2086,7 +2072,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. description: The schema of the user. - user_name: + userName: type: string description: Email address of the Databricks user. responses: @@ -2370,7 +2356,7 @@ paths: schema: type: object properties: - operations: + Operations: type: array items: type: object @@ -2388,8 +2374,6 @@ paths: value: type: object description: Value to modify - description: ':param schemas: List[:class:`PatchSchema`] (optional) The schema of the patch request. Must - be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"].' schemas: type: array items: @@ -2408,20 +2392,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2433,6 +2417,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. + description: The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. responses: '200': description: Success @@ -2499,7 +2484,7 @@ paths: active: type: boolean description: If this user is active - display_name: + displayName: type: string description: 'String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled]. Use @@ -2537,7 +2522,7 @@ paths: type: string description: 'Entitlements assigned to the user. See [assigning entitlements] for a full list of supported values. [assigning entitlements]: https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements' - external_id: + externalId: type: string description: External ID is not currently supported. It is reserved for future use. groups: @@ -2555,7 +2540,6 @@ paths: type: string value: type: string - description: ':param name: :class:`Name` (optional)' name: type: object properties: @@ -2599,20 +2583,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2625,7 +2609,7 @@ paths: Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details. description: The schema of the user. - user_name: + userName: type: string description: Email address of the Databricks user. responses: @@ -2742,7 +2726,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`PasswordPermissions`' responses: '200': description: Success @@ -2798,7 +2781,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`PasswordPermissions`' responses: '200': description: Success @@ -3496,20 +3478,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3537,20 +3519,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3578,20 +3560,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3620,20 +3602,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3673,20 +3655,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3704,6 +3686,7 @@ components: - CAN_ATTACH_TO - CAN_BIND - CAN_CREATE + - CAN_CREATE_APP - CAN_EDIT - CAN_EDIT_METADATA - CAN_MANAGE @@ -3745,20 +3728,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3787,20 +3770,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3830,20 +3813,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 13b21a0b..61492ee8 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/iamv2.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.iamv2 servers: - url: https://{deployment_name}.cloud.databricks.com 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 f5647a0d..bc9431c9 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/jobs.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.jobs servers: - url: https://{deployment_name}.cloud.databricks.com @@ -292,29 +292,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -560,6 +551,13 @@ paths: description: >- The source of the job specification in the remote repository when the job is source controlled. + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string required: - git_url - git_provider @@ -632,11 +630,8 @@ paths: - op - value description: >- - :param job_clusters: List[:class:`JobCluster`] (optional) A - list of job cluster specifications that can be shared and - reused by tasks of this job. Libraries cannot be declared in - a shared job cluster. You must declare dependent libraries - in task settings. + An optional set of health rules that can be defined for this + job. job_clusters: type: array items: @@ -652,6 +647,11 @@ paths: 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 + a shared job cluster. You must declare dependent libraries + in task settings. max_concurrent_runs: type: integer description: >- @@ -787,6 +787,43 @@ paths: properties: task_key: type: string + alert_task: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will receive alert + notifications. A subscriber can be either a user + (via email) or a notification destination (via destination_id). + description: >- + The subscribers receive alert evaluation result + notifications after the alert task is completed. + The number of subscriptions is limited to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse settings + used by the alert task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the alert file + in the workspace. The path: * must start with + "/Workspace" * must be a normalized path. User has + to select only one of alert_id or workspace_path + to identify the alert. + description: New alert v2 task clean_rooms_notebook_task: type: object properties: @@ -1467,29 +1504,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2109,29 +2137,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2678,7 +2697,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`JobPermissions`' responses: '200': description: Success @@ -2751,7 +2769,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`JobPermissions`' responses: '200': description: Success @@ -3360,9 +3377,12 @@ paths: description: Controls whether the pipeline should perform a full refresh python_named_params: type: object + python_params: + type: array + items: + type: string description: >- - :param python_params: List[str] (optional) A list of - parameters for jobs with Python tasks, for example + A list of parameters for jobs with Python tasks, for example `"python_params": ["john doe", "35"]`. The parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite the parameters @@ -3375,10 +3395,6 @@ paths: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. [job parameters]: https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown - python_params: - type: array - items: - type: string rerun_all_failed_tasks: type: boolean description: >- @@ -3509,29 +3525,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3786,6 +3793,13 @@ paths: description: >- The source of the job specification in the remote repository when the job is source controlled. + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string required: - git_url - git_provider @@ -4025,6 +4039,45 @@ paths: properties: task_key: type: string + alert_task: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will receive + alert notifications. A subscriber can be + either a user + (via email) or a notification destination (via destination_id). + description: >- + The subscribers receive alert evaluation + result notifications after the alert task is + completed. The number of subscriptions is + limited to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse + settings used by the alert task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the alert + file in the workspace. The path: * must start + with "/Workspace" * must be a normalized path. + User has to select only one of alert_id or + workspace_path to identify the alert. + description: New alert v2 task clean_rooms_notebook_task: type: object properties: @@ -4728,29 +4781,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5389,29 +5433,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5852,9 +5887,12 @@ paths: description: Controls whether the pipeline should perform a full refresh python_named_params: type: object + python_params: + type: array + items: + type: string description: >- - :param python_params: List[str] (optional) A list of - parameters for jobs with Python tasks, for example + A list of parameters for jobs with Python tasks, for example `"python_params": ["john doe", "35"]`. The parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite the parameters @@ -5867,10 +5905,6 @@ paths: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. [job parameters]: https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown - python_params: - type: array - items: - type: string queue: type: object properties: @@ -6218,6 +6252,13 @@ paths: description: >- The source of the job specification in the remote repository when the job is source controlled. + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string required: - git_url - git_provider @@ -6290,21 +6331,23 @@ paths: - op - value description: >- - :param idempotency_token: str (optional) An optional token - that can be used 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 instead. If a run with the provided token - is deleted, an error is returned. If 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]. [How to ensure idempotency - for jobs]: - https://kb.databricks.com/jobs/jobs-idempotency.html + An optional set of health rules that can be defined for this + job. idempotency_token: type: string + description: >- + An optional token that can be used to guarantee the + idempotency of job run requests. If a run with the provided + token already exists, the request does not create a new run + but returns the ID of the existing run instead. If a run + with the provided token is deleted, an error is returned. If + 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]. [How + to ensure idempotency for jobs]: + https://kb.databricks.com/jobs/jobs-idempotency.html notification_settings: type: object properties: @@ -6362,6 +6405,43 @@ paths: properties: task_key: type: string + alert_task: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will receive alert + notifications. A subscriber can be either a user + (via email) or a notification destination (via destination_id). + description: >- + The subscribers receive alert evaluation result + notifications after the alert task is completed. + The number of subscriptions is limited to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse settings + used by the alert task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the alert file + in the workspace. The path: * must start with + "/Workspace" * must be a normalized path. User has + to select only one of alert_id or workspace_path + to identify the alert. + description: New alert v2 task clean_rooms_notebook_task: type: object properties: @@ -6633,6 +6713,9 @@ paths: description: type: string description: An optional description for this task. + disable_auto_optimization: + type: boolean + description: An option to disable auto optimization in serverless email_notifications: type: object properties: @@ -6728,6 +6811,46 @@ paths: properties: task_key: type: string + alert_task: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will + receive alert notifications. A + subscriber can be either a user + (via email) or a notification destination (via destination_id). + description: >- + The subscribers receive alert evaluation + result notifications after the alert task + is completed. The number of subscriptions + is limited to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse + settings used by the alert task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the + alert file in the workspace. The path: * + must start with "/Workspace" * must be a + normalized path. User has to select only + one of alert_id or workspace_path to + identify the alert. + description: New alert v2 task clean_rooms_notebook_task: type: object properties: @@ -7443,29 +7566,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -8214,6 +8328,22 @@ paths: description: >- An optional list of libraries to be installed on the cluster. The default value is an empty list. + max_retries: + type: integer + description: >- + An optional maximum number of times to retry an + unsuccessful run. A run is considered to be + unsuccessful if it completes with the `FAILED` + result_state or `INTERNAL_ERROR` `life_cycle_state`. + The value `-1` means to retry indefinitely and the + value `0` means to never retry. + min_retry_interval_millis: + type: integer + description: >- + An optional minimal interval in milliseconds between + the start of the failed run and the subsequent retry + run. The default behavior is that unsuccessful runs + are immediately retried. new_cluster: type: string description: >- @@ -8343,29 +8473,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -8473,6 +8594,12 @@ paths: description: >- The task runs a Python wheel when the `python_wheel_task` field is present. + retry_on_timeout: + type: boolean + description: >- + An optional policy to specify whether to retry a job + when it times out. The default behavior is to not + retry on timeout. run_if: type: string x-enum: @@ -8908,12 +9035,11 @@ paths: respect the task notification settings. required: - task_key - description: >- - :param timeout_seconds: int (optional) An optional timeout - applied to each run of this job. A value of `0` means no - timeout. timeout_seconds: type: integer + description: >- + An optional timeout applied to each run of this job. A value + of `0` means no timeout. usage_policy_id: type: string description: >- @@ -9097,29 +9223,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9374,6 +9491,13 @@ paths: description: >- The source of the job specification in the remote repository when the job is source controlled. + sparse_checkout: + type: object + properties: + patterns: + type: array + items: + type: string required: - git_url - git_provider @@ -9613,6 +9737,45 @@ paths: properties: task_key: type: string + alert_task: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will receive + alert notifications. A subscriber can be + either a user + (via email) or a notification destination (via destination_id). + description: >- + The subscribers receive alert evaluation + result notifications after the alert task is + completed. The number of subscriptions is + limited to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse + settings used by the alert task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the alert + file in the workspace. The path: * must start + with "/Workspace" * must be a normalized path. + User has to select only one of alert_id or + workspace_path to identify the alert. + description: New alert v2 task clean_rooms_notebook_task: type: object properties: @@ -10316,29 +10479,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10977,29 +11131,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11407,6 +11552,48 @@ paths: x-stackql-sdk-source: PolicyComplianceForJobsAPI components: schemas: + AlertTask: + type: object + properties: + alert_id: + type: string + subscribers: + type: array + items: + $ref: '#/components/schemas/AlertTaskSubscriber' + description: >- + The subscribers receive alert evaluation result notifications after + the alert task is completed. The number of subscriptions is limited + to 100. + warehouse_id: + type: string + description: >- + The warehouse_id identifies the warehouse settings used by the alert + task. + workspace_path: + type: string + description: >- + The workspace_path is the path to the alert file in the workspace. + The path: * must start with "/Workspace" * must be a normalized + path. User has to select only one of alert_id or workspace_path to + identify the alert. + AlertTaskOutput: + type: object + properties: + alert_state: + $ref: '#/components/schemas/AlertEvaluationState' + AlertTaskSubscriber: + type: object + properties: + destination_id: + type: string + user_name: + type: string + description: A valid workspace email address. + description: >- + Represents a subscriber that will receive alert notifications. A + subscriber can be either a user + (via email) or a notification destination (via destination_id). BaseJob: type: object properties: @@ -12274,6 +12461,8 @@ components: description: >- The source of the job specification in the remote repository when the job is source controlled. + sparse_checkout: + $ref: '#/components/schemas/SparseCheckout' required: - git_url - git_provider @@ -13571,6 +13760,9 @@ components: RunOutput: type: object properties: + alert_output: + $ref: '#/components/schemas/AlertTaskOutput' + description: The output of an alert task, if available clean_rooms_notebook_output: $ref: >- #/components/schemas/CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput @@ -13771,6 +13963,9 @@ 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. + alert_task: + $ref: '#/components/schemas/AlertTask' + description: New alert v2 task attempt_number: type: integer description: >- @@ -13840,6 +14035,9 @@ components: description: type: string description: An optional description for this task. + disable_auto_optimization: + type: boolean + description: An option to disable auto optimization in serverless effective_performance_target: $ref: '#/components/schemas/PerformanceTarget' description: >- @@ -13913,6 +14111,20 @@ components: description: >- An optional list of libraries to be installed on the cluster. The default value is an empty list. + max_retries: + type: integer + description: >- + An optional maximum number of times to retry an unsuccessful run. A + run is considered to be unsuccessful if it completes with the + `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The + value `-1` means to retry indefinitely and the value `0` means to + never retry. + min_retry_interval_millis: + type: integer + description: >- + An optional minimal interval in milliseconds between the start of + the failed run and the subsequent retry run. The default behavior is + that unsuccessful runs are immediately retried. new_cluster: type: string description: >- @@ -13949,6 +14161,11 @@ components: resolved_values: $ref: '#/components/schemas/ResolvedValues' description: Parameter values including resolved references + retry_on_timeout: + type: boolean + description: >- + An optional policy to specify whether to retry a job when it times + out. The default behavior is to not retry on timeout. run_duration: type: integer description: >- @@ -14087,6 +14304,13 @@ components: type: array items: type: string + SparseCheckout: + type: object + properties: + patterns: + type: array + items: + type: string SqlAlertOutput: type: object properties: @@ -14295,6 +14519,9 @@ components: properties: task_key: type: string + alert_task: + $ref: '#/components/schemas/AlertTask' + description: New alert v2 task clean_rooms_notebook_task: $ref: '#/components/schemas/CleanRoomsNotebookTask' description: >- @@ -14339,6 +14566,9 @@ components: description: type: string description: An optional description for this task. + disable_auto_optimization: + type: boolean + description: An option to disable auto optimization in serverless email_notifications: $ref: '#/components/schemas/JobEmailNotifications' description: >- @@ -14372,6 +14602,20 @@ components: description: >- An optional list of libraries to be installed on the cluster. The default value is an empty list. + max_retries: + type: integer + description: >- + An optional maximum number of times to retry an unsuccessful run. A + run is considered to be unsuccessful if it completes with the + `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The + value `-1` means to retry indefinitely and the value `0` means to + never retry. + min_retry_interval_millis: + type: integer + description: >- + An optional minimal interval in milliseconds between the start of + the failed run and the subsequent retry run. The default behavior is + that unsuccessful runs are immediately retried. new_cluster: type: string description: >- @@ -14402,6 +14646,11 @@ components: description: >- The task runs a Python wheel when the `python_wheel_task` field is present. + retry_on_timeout: + type: boolean + description: >- + An optional policy to specify whether to retry a job when it times + out. The default behavior is to not retry on timeout. run_if: $ref: '#/components/schemas/RunIf' description: >- @@ -14520,6 +14769,9 @@ components: properties: task_key: type: string + alert_task: + $ref: '#/components/schemas/AlertTask' + description: New alert v2 task clean_rooms_notebook_task: $ref: '#/components/schemas/CleanRoomsNotebookTask' description: >- @@ -14905,6 +15157,16 @@ components: properties: message: type: string + AlertEvaluationState: + type: string + x-enum: + - ERROR + - OK + - TRIGGERED + - UNKNOWN + description: >- + Same alert evaluation state as in + redash-v2/api/proto/alertsv2/alerts.proto AuthenticationMethod: type: string x-enum: @@ -14922,20 +15184,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15003,20 +15265,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15089,20 +15351,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15137,20 +15399,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15275,20 +15537,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15317,20 +15579,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15374,20 +15636,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15623,20 +15885,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -15666,20 +15928,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 a51658e8..017d22e1 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/marketplace.yaml @@ -6,7 +6,7 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.marketplace servers: - url: https://{deployment_name}.cloud.databricks.com @@ -36,7 +36,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -47,7 +46,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`SharedDataObject`' responses: '200': description: Success @@ -103,7 +101,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -114,7 +111,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`ListingFulfillment`' responses: '200': description: Success @@ -159,7 +155,6 @@ paths: required: true schema: type: string - description: ':param accepted_consumer_terms: :class:`ConsumerTerms` (optional)' requestBody: content: application/json: @@ -175,9 +170,6 @@ paths: - version catalog_name: type: string - description: >- - :param recipient_type: :class:`DeltaSharingRecipientType` - (optional) recipient_type: type: string x-enum: @@ -202,29 +194,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -262,7 +245,6 @@ paths: description: for git repo installations share_name: type: string - description: ':returns: :class:`Installation`' responses: '200': description: Success @@ -302,7 +284,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -313,7 +294,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`InstallationDetail`' responses: '200': description: Success @@ -356,7 +336,6 @@ paths: required: true schema: type: string - description: ':param installation_id: str' - name: installation_id in: path required: true @@ -414,7 +393,6 @@ paths: required: true schema: type: string - description: ':param installation_id: str' - name: installation_id in: path required: true @@ -465,29 +443,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -537,29 +506,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -625,7 +585,6 @@ paths: updated_by: type: string description: Username of Recipient Token updater. - description: ':param rotate_token: bool (optional)' rotate_token: type: boolean required: @@ -669,7 +628,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -720,7 +678,6 @@ paths: type: array items: type: string - description: ':returns: :class:`BatchGetListingsResponse`' responses: '200': description: Success @@ -764,7 +721,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetListingResponse`' responses: '200': description: Success @@ -858,7 +814,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -962,7 +917,6 @@ paths: required: false schema: type: boolean - description: ':param is_private_exchange: bool (optional)' - name: is_private_exchange in: query required: false @@ -973,7 +927,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -1033,7 +986,6 @@ paths: required: true schema: type: string - description: ':param intended_use: str' requestBody: content: application/json: @@ -1049,17 +1001,14 @@ paths: type: string required: - version - description: ':param comment: str (optional)' comment: type: string company: type: string - description: ':param first_name: str (optional)' first_name: type: string is_from_lighthouse: type: boolean - description: ':param last_name: str (optional)' last_name: type: string recipient_type: @@ -1067,7 +1016,58 @@ paths: x-enum: - DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS - DELTA_SHARING_RECIPIENT_TYPE_OPEN - description: ':returns: :class:`CreatePersonalizationRequestResponse`' + 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: - intended_use - accepted_consumer_terms @@ -1115,7 +1115,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetPersonalizationRequestResponse`' responses: '200': description: Success @@ -1155,7 +1154,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -1206,7 +1204,6 @@ paths: type: array items: type: string - description: ':returns: :class:`BatchGetProvidersResponse`' responses: '200': description: Success @@ -1250,7 +1247,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetProviderResponse`' responses: '200': description: Success @@ -1298,7 +1294,6 @@ paths: required: false schema: type: boolean - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -1309,7 +1304,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`ProviderInfo`' responses: '200': description: Success @@ -1378,29 +1372,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1436,7 +1421,6 @@ paths: - exchange_id - filter_value - filter_type - description: ':returns: :class:`CreateExchangeFilterResponse`' required: - filter responses: @@ -1478,7 +1462,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -1489,7 +1472,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`ExchangeFilter`' responses: '200': description: Success @@ -1526,7 +1508,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -1561,7 +1542,6 @@ paths: required: true schema: type: string - description: ':param filter: :class:`ExchangeFilter`' requestBody: content: application/json: @@ -1598,29 +1578,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1699,7 +1670,6 @@ paths: properties: listing_id: type: string - description: ':param exchange_id: str' exchange_id: type: string required: @@ -1744,7 +1714,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -1755,7 +1724,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`ExchangeListing`' responses: '200': description: Success @@ -1837,29 +1805,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1923,7 +1882,6 @@ paths: type: string required: - name - description: ':returns: :class:`CreateExchangeResponse`' required: - exchange responses: @@ -1964,7 +1922,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -2006,7 +1963,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2040,7 +1996,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetExchangeResponse`' responses: '200': description: Success @@ -2079,7 +2034,6 @@ paths: required: true schema: type: string - description: ':param exchange: :class:`Exchange`' requestBody: content: application/json: @@ -2129,29 +2083,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2253,7 +2198,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2290,7 +2234,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -2301,7 +2244,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`ExchangeListing`' responses: '200': description: Success @@ -2379,29 +2321,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2424,7 +2357,6 @@ paths: parent_id: type: string description: TODO make the following fields required - description: ':param marketplace_file_type: :class:`MarketplaceFileType`' marketplace_file_type: type: string x-enum: @@ -2450,29 +2382,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2494,7 +2417,6 @@ paths: attributes -- see the documentation for details. mime_type: type: string - description: ':param display_name: str (optional)' display_name: type: string required: @@ -2540,7 +2462,6 @@ paths: required: true schema: $ref: '#/components/schemas/FileParent' - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -2551,7 +2472,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`FileInfo`' responses: '200': description: Success @@ -2588,7 +2508,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2622,7 +2541,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetFileResponse`' responses: '200': description: Success @@ -2693,29 +2611,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2781,29 +2690,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2884,29 +2784,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2956,29 +2847,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3056,29 +2938,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3141,29 +3014,20 @@ paths: Access them by: - - attribute access:: + - attribute access: + >>> Color.RED + - >>> Color.RED - - - - - - value lookup: - - - >>> Color(1) - - + - value lookup: + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3243,29 +3107,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3317,29 +3172,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3389,29 +3235,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3496,29 +3333,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3596,29 +3424,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3647,7 +3466,6 @@ paths: type: string required: - summary - description: ':returns: :class:`CreateListingResponse`' required: - listing responses: @@ -3686,7 +3504,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -3720,7 +3537,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetListingResponse`' responses: '200': description: Success @@ -3759,7 +3575,6 @@ paths: required: true schema: type: string - description: ':param listing: :class:`Listing`' requestBody: content: application/json: @@ -3798,29 +3613,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3886,29 +3692,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3989,29 +3786,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4061,29 +3849,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4161,29 +3940,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4246,29 +4016,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4348,29 +4109,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4422,29 +4174,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4494,29 +4237,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4601,29 +4335,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4701,29 +4426,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4793,7 +4509,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -4846,7 +4561,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -4903,7 +4617,6 @@ paths: required: true schema: type: string - description: ':param request_id: str' - name: request_id in: path required: true @@ -4922,7 +4635,58 @@ paths: - FULFILLED - NEW - REQUEST_PENDING - description: ':param reason: str (optional)' + 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. reason: type: string share: @@ -4954,29 +4718,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4999,7 +4754,6 @@ paths: required: - name - type - description: ':returns: :class:`UpdatePersonalizationRequestResponse`' required: - status responses: @@ -5234,7 +4988,6 @@ paths: - business_contact_email - term_of_service_link - privacy_policy_link - description: ':returns: :class:`CreateProviderResponse`' required: - provider responses: @@ -5273,7 +5026,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -5307,7 +5059,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetProviderResponse`' responses: '200': description: Success @@ -5346,7 +5097,6 @@ paths: required: true schema: type: string - description: ':param provider: :class:`ProviderInfo`' requestBody: content: application/json: @@ -5434,7 +5184,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -6284,20 +6033,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6346,20 +6095,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6388,20 +6137,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6437,20 +6186,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6479,20 +6228,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6520,20 +6269,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6563,20 +6312,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6607,20 +6356,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6649,20 +6398,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6691,20 +6440,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6733,20 +6482,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6783,20 +6532,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6825,20 +6574,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6868,20 +6617,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6912,20 +6661,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6954,20 +6703,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 bd6d4d24..916a3edf 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/ml.yaml @@ -6,7 +6,7 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.ml servers: - url: https://{deployment_name}.cloud.databricks.com @@ -985,7 +985,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ExperimentPermissions`' responses: '200': description: Success @@ -1058,7 +1057,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ExperimentPermissions`' responses: '200': description: Success @@ -2828,10 +2826,15 @@ paths: description: >- The Unity Catalog catalog name. This name is also used as the Lakebase logical database - name. + name. Quoting is handled by the backend where + needed, do not pre-quote it. schema_name: type: string - description: The Unity Catalog schema name. + 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: >- @@ -2925,18 +2928,48 @@ paths: 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: The entity columns of the Delta table. + 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: The timeseries column of the Delta table. + 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 - - entity_columns - - timeseries_column kafka_source: type: object properties: @@ -2952,8 +2985,14 @@ paths: required: - variant_expr_path description: >- - The entity column identifiers of the Kafka - source. + 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: @@ -2962,21 +3001,244 @@ paths: required: - variant_expr_path description: >- - The timeseries column identifier of the Kafka + Deprecated: Use Feature.timeseries_column + instead. Kept for backwards compatibility. The + timeseries column identifier of the Kafka source. required: - name - - entity_column_identifiers - - timeseries_column_identifier description: The data source of the feature. - inputs: - type: array - items: - type: string - description: The input columns from which the feature is computed. function: 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 + 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. + 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. + 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. + 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. + 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. + 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. + required: + - input + description: Computes the sum of values. + time_window: + type: object + properties: + continuous: + type: object + properties: + window_duration: + type: string + offset: + type: string + description: >- + The offset of the continuous window + (must be non-positive). + required: + - window_duration + sliding: + type: object + properties: + window_duration: + type: string + slide_duration: + type: string + description: >- + The slide duration (interval by which + windows advance, must be positive and + less than duration). + required: + - window_duration + - slide_duration + tumbling: + type: object + properties: + window_duration: + type: string + required: + - window_duration + description: >- + The time window over which the aggregation is + computed. + var_pop: + type: object + properties: + input: + 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: + type: string + description: >- + The input column from which the sample + variance is computed. + required: + - input + description: Computes the sample variance. + description: An aggregation function applied over a time window. + extra_parameters: + type: array + items: + 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. + description: >- + Deprecated: Use the function oneof with + AggregationFunction instead. Kept for backwards + compatibility. Extra parameters for parameterized + functions. function_type: type: string x-enum: @@ -2994,91 +3256,40 @@ paths: - 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. - extra_parameters: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the parameter. - required: - - key - - value - description: Extra parameters for parameterized functions. - required: - - function_type + 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. 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. filter_condition: type: string description: >- - The filter condition applied to the source data before - aggregation. + 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: @@ -3095,10 +3306,11 @@ paths: type: integer description: The notebook ID where this API was invoked. description: >- - 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 + 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 @@ -3139,11 +3351,24 @@ paths: type: string required: - window_duration - description: The time window in which the feature is computed. + description: >- + Deprecated: Use + Function.aggregation_function.time_window instead. Kept + for backwards compatibility. The time window in which + the feature is computed. + timeseries_column: + type: object + properties: + name: + type: string + required: + - name + description: >- + Column recording time, used for point-in-time joins, + backfills, and aggregations. required: - full_name - source - - inputs - function description: Feature to create. required: @@ -3284,18 +3509,48 @@ paths: 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: The entity columns of the Delta table. + 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: The timeseries column of the Delta table. + 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 - - entity_columns - - timeseries_column description: >- A user-provided and managed source for backfilling data. Historical data is used when creating a training set @@ -3332,7 +3587,6 @@ paths: - bootstrap_servers - subscription_mode - auth_config - description: ':returns: :class:`KafkaConfig`' required: - kafka_config responses: @@ -3475,10 +3729,16 @@ paths: type: string description: >- The Unity Catalog catalog name. This name is also - used as the Lakebase logical database name. + 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. + 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: >- @@ -3714,18 +3974,48 @@ paths: 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: The entity columns of the Delta table. + 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: The timeseries column of the Delta table. + 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 - - entity_columns - - timeseries_column kafka_source: type: object properties: @@ -3741,8 +4031,14 @@ paths: required: - variant_expr_path description: >- - The entity column identifiers of the Kafka - source. + 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: @@ -3751,21 +4047,244 @@ paths: required: - variant_expr_path description: >- - The timeseries column identifier of the Kafka + Deprecated: Use Feature.timeseries_column + instead. Kept for backwards compatibility. The + timeseries column identifier of the Kafka source. required: - name - - entity_column_identifiers - - timeseries_column_identifier description: The data source of the feature. - inputs: - type: array - items: - type: string - description: The input columns from which the feature is computed. function: 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 + 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. + 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. + 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. + 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. + 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. + 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. + required: + - input + description: Computes the sum of values. + time_window: + type: object + properties: + continuous: + type: object + properties: + window_duration: + type: string + offset: + type: string + description: >- + The offset of the continuous window + (must be non-positive). + required: + - window_duration + sliding: + type: object + properties: + window_duration: + type: string + slide_duration: + type: string + description: >- + The slide duration (interval by which + windows advance, must be positive and + less than duration). + required: + - window_duration + - slide_duration + tumbling: + type: object + properties: + window_duration: + type: string + required: + - window_duration + description: >- + The time window over which the aggregation is + computed. + var_pop: + type: object + properties: + input: + 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: + type: string + description: >- + The input column from which the sample + variance is computed. + required: + - input + description: Computes the sample variance. + description: An aggregation function applied over a time window. + extra_parameters: + type: array + items: + 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. + description: >- + Deprecated: Use the function oneof with + AggregationFunction instead. Kept for backwards + compatibility. Extra parameters for parameterized + functions. function_type: type: string x-enum: @@ -3783,91 +4302,40 @@ paths: - 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. - extra_parameters: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - description: The value of the parameter. - required: - - key - - value - description: Extra parameters for parameterized functions. - required: - - function_type + 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. 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. filter_condition: type: string description: >- - The filter condition applied to the source data before - aggregation. + 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: @@ -3884,10 +4352,11 @@ paths: type: integer description: The notebook ID where this API was invoked. description: >- - 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 + 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 @@ -3928,11 +4397,24 @@ paths: type: string required: - window_duration - description: The time window in which the feature is computed. + description: >- + Deprecated: Use + Function.aggregation_function.time_window instead. Kept + for backwards compatibility. The time window in which + the feature is computed. + timeseries_column: + type: object + properties: + name: + type: string + required: + - name + description: >- + Column recording time, used for point-in-time joins, + backfills, and aggregations. required: - full_name - source - - inputs - function description: Feature to update. required: @@ -4134,18 +4616,48 @@ paths: 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: The entity columns of the Delta table. + 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: The timeseries column of the Delta table. + 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 - - entity_columns - - timeseries_column description: >- A user-provided and managed source for backfilling data. Historical data is used when creating a training set @@ -4364,10 +4876,16 @@ paths: type: string description: >- The Unity Catalog catalog name. This name is also - used as the Lakebase logical database name. + 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. + 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: >- @@ -5103,7 +5621,6 @@ paths: required: true schema: type: string - description: ':param feature_name: str' - name: feature_name in: path required: true @@ -5124,7 +5641,7 @@ paths: type: string required: - key - description: ':returns: :class:`FeatureTag`' + description: Represents a tag on a feature in a feature table. required: - feature_tag responses: @@ -5169,7 +5686,6 @@ paths: required: true schema: type: string - description: ':param feature_name: str' - name: feature_name in: path required: true @@ -5276,7 +5792,6 @@ paths: required: true schema: type: string - description: ':param feature_name: str' - name: feature_name in: path required: true @@ -5287,7 +5802,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`FeatureTag`' responses: '200': description: Success @@ -5330,7 +5844,6 @@ paths: required: true schema: type: string - description: ':param feature_name: str' - name: feature_name in: path required: true @@ -5341,7 +5854,6 @@ paths: required: true schema: type: string - description: ':param feature_tag: :class:`FeatureTag`' - name: update_mask in: query required: false @@ -5910,29 +6422,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6755,7 +7258,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`RegisteredModelPermissions`' responses: '200': description: Success @@ -6832,7 +7334,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`RegisteredModelPermissions`' responses: '200': description: Success @@ -7045,15 +7546,15 @@ paths: required: false schema: type: integer - description: >- - :param model_name: str (optional) Registered model name If not - specified, all webhooks associated with the specified events are - listed, regardless of their associated model. - name: model_name in: query required: false schema: type: string + description: >- + Registered model name If not specified, all webhooks associated with + the specified events are listed, regardless of their associated + model. - name: page_token in: query required: false @@ -7906,29 +8407,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -8005,7 +8497,6 @@ paths: "X-Databricks-Signature": $encoded_payload }. required: - url - description: ':param job_spec: :class:`JobSpec` (optional)' job_spec: type: object properties: @@ -8032,7 +8523,21 @@ paths: - ACTIVE - DISABLED - TEST_MODE - description: ':returns: :class:`UpdateWebhookResponse`' + description: >- + Enable or disable triggering the webhook, or put the webhook + into test mode. The default is + + `ACTIVE`: * `ACTIVE`: Webhook is triggered when an + associated event happens. + + + * `DISABLED`: Webhook is not triggered. + + + * `TEST_MODE`: Webhook can be triggered through the test + endpoint, but is not triggered on a + + real event. required: - id responses: @@ -8105,16 +8610,90 @@ components: For activities, this contains the activity recorded for the action. For comments, this contains the comment details. For transition requests, this contains the transition request details. + AggregationFunction: + type: object + properties: + approx_count_distinct: + $ref: '#/components/schemas/ApproxCountDistinctFunction' + approx_percentile: + $ref: '#/components/schemas/ApproxPercentileFunction' + avg: + $ref: '#/components/schemas/AvgFunction' + count_function: + $ref: '#/components/schemas/CountFunction' + first: + $ref: '#/components/schemas/FirstFunction' + last: + $ref: '#/components/schemas/LastFunction' + max: + $ref: '#/components/schemas/MaxFunction' + min: + $ref: '#/components/schemas/MinFunction' + stddev_pop: + $ref: '#/components/schemas/StddevPopFunction' + stddev_samp: + $ref: '#/components/schemas/StddevSampFunction' + sum: + $ref: '#/components/schemas/SumFunction' + time_window: + $ref: '#/components/schemas/TimeWindow' + description: The time window over which the aggregation is computed. + var_pop: + $ref: '#/components/schemas/VarPopFunction' + var_samp: + $ref: '#/components/schemas/VarSampFunction' + description: An aggregation function applied over a time window. ApproveTransitionRequestResponse: type: object properties: activity: $ref: '#/components/schemas/Activity' + ApproxCountDistinctFunction: + 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 + description: Computes the approximate count of distinct values. + ApproxPercentileFunction: + 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. AuthConfig: type: object properties: uc_service_credential_name: type: string + AvgFunction: + type: object + properties: + input: + type: string + description: The input column from which the average is computed. + required: + - input + description: Computes the average of values. BackfillSource: type: object properties: @@ -8175,6 +8754,15 @@ components: description: The offset of the continuous window (must be non-positive). required: - window_duration + CountFunction: + type: object + properties: + input: + type: string + description: The input column from which the count is computed. + required: + - input + description: Computes the count of values. CreateCommentResponse: type: object properties: @@ -8343,18 +8931,49 @@ components: 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: The entity columns of the Delta table. + 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: The timeseries column of the Delta table. + 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 - - entity_columns - - timeseries_column + EntityColumn: + type: object + properties: + name: + type: string + required: + - name Experiment: type: object properties: @@ -8463,37 +9082,58 @@ components: source: $ref: '#/components/schemas/DataSource' description: The data source of the feature. - inputs: - type: array - items: - type: string - description: The input columns from which the feature is computed. function: $ref: '#/components/schemas/Function' description: The function by which the feature is computed. description: type: string description: The description of the feature. + entities: + type: array + items: + $ref: '#/components/schemas/EntityColumn' + description: >- + The entity columns for the feature, used as aggregation keys and for + query-time lookup. filter_condition: type: string - description: The filter condition applied to the source data before aggregation. + 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: >- - 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. + 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. time_window: $ref: '#/components/schemas/TimeWindow' - description: The time window in which the feature is computed. + 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. required: - full_name - source - - inputs - function FeatureLineage: type: object @@ -8569,6 +9209,15 @@ components: properties: model: $ref: '#/components/schemas/LoggedModel' + FirstFunction: + type: object + properties: + input: + type: string + description: The input column from which the first value is returned. + required: + - input + description: Returns the first value. ForecastingExperiment: type: object properties: @@ -8587,26 +9236,37 @@ components: Function: type: object properties: - function_type: - $ref: '#/components/schemas/FunctionFunctionType' + aggregation_function: + $ref: '#/components/schemas/AggregationFunction' extra_parameters: type: array items: $ref: '#/components/schemas/FunctionExtraParameter' - description: Extra parameters for parameterized functions. - required: - - function_type + 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: @@ -8818,14 +9478,29 @@ components: type: array items: $ref: '#/components/schemas/ColumnIdentifier' - description: The entity column identifiers of the Kafka source. + 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: The timeseries column identifier of the Kafka source. + description: >- + Deprecated: Use Feature.timeseries_column instead. Kept for + backwards compatibility. The timeseries column identifier of the + Kafka source. required: - name - - entity_column_identifiers - - timeseries_column_identifier + LastFunction: + type: object + properties: + input: + type: string + description: The input column from which the last value is returned. + required: + - input + description: Returns the last value. LineageContext: type: object properties: @@ -9117,6 +9792,15 @@ components: description: >- A materialized feature represents a feature that is continuously computed and stored. + MaxFunction: + type: object + properties: + input: + type: string + description: The input column from which the maximum is computed. + required: + - input + description: Computes the maximum value. Metric: type: object properties: @@ -9152,6 +9836,15 @@ components: type: number description: The value of the metric. description: Metric associated with a run, represented as a key-value pair. + MinFunction: + type: object + properties: + input: + type: string + description: The input column from which the minimum is computed. + required: + - input + description: Computes the minimum value. Model: type: object properties: @@ -9439,10 +10132,14 @@ components: type: string description: >- The Unity Catalog catalog name. This name is also used as the - Lakebase logical database name. + 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. + 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: >- @@ -9856,6 +10553,28 @@ components: required: - window_duration - slide_duration + StddevPopFunction: + type: object + properties: + input: + type: string + description: >- + The input column from which the population standard deviation is + computed. + required: + - input + description: Computes the population standard deviation. + StddevSampFunction: + 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. SubscriptionMode: type: object properties: @@ -9871,6 +10590,15 @@ components: description: >- A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'. + SumFunction: + type: object + properties: + input: + type: string + description: The input column from which the sum is computed. + required: + - input + description: Computes the sum of values. TestRegistryWebhookResponse: type: object properties: @@ -9888,6 +10616,13 @@ components: $ref: '#/components/schemas/SlidingWindow' tumbling: $ref: '#/components/schemas/TumblingWindow' + TimeseriesColumn: + type: object + properties: + name: + type: string + required: + - name TransitionRequest: type: object properties: @@ -9958,6 +10693,24 @@ components: properties: webhook: $ref: '#/components/schemas/RegistryWebhook' + VarPopFunction: + type: object + properties: + input: + type: string + description: The input column from which the population variance is computed. + required: + - input + description: Computes the population variance. + VarSampFunction: + type: object + properties: + input: + type: string + description: The input column from which the sample variance is computed. + required: + - input + description: Computes the sample variance. ActivityAction: type: string x-enum: @@ -10073,20 +10826,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10114,43 +10867,11 @@ components: - 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) - [, , ] + description: >- + Deprecated: Use the function-specific messages in + AggregationFunction.function_type oneof - Methods can be added to enumerations, and members can have their own - attributes -- see the documentation for details. + instead. Kept for backwards compatibility. LoggedModelStatus: type: string x-enum: @@ -10176,20 +10897,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10240,20 +10961,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10297,20 +11018,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10376,20 +11097,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 d9d9f7a9..cc46b45e 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/oauth2.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.oauth2 servers: - url: https://{deployment_name}.cloud.databricks.com @@ -110,22 +110,21 @@ paths: required: false schema: type: integer - description: >- - :param page_token: str (optional) An opaque page token which was the - `next_page_token` in the response of the previous request to list - the secrets for this service principal. Provide this token to - retrieve the next page of secret entries. When providing a - `page_token`, all other parameters provided to the request must - match the previous request. To list all of the secrets for a service - principal, it is necessary to continue requesting pages of entries - until the response contains no `next_page_token`. Note that the - number of entries returned must not be used to determine when the - listing is complete. - name: page_token in: query required: false schema: type: string + description: >- + An opaque page token which was the `next_page_token` in the response + of the previous request to list the secrets for this service + principal. Provide this token to retrieve the next page of secret + entries. When providing a `page_token`, all other parameters + provided to the request must match the previous request. To list all + of the secrets for a service principal, it is necessary to continue + requesting pages of entries until the response contains no + `next_page_token`. Note that the number of entries returned must not + be used to determine when the listing is complete. responses: '200': description: Success 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 baacce8d..c2b75592 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/pipelines.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.pipelines servers: - url: https://{deployment_name}.cloud.databricks.com @@ -380,6 +380,20 @@ paths: Allowed dependency could be , , (WSFS or Volumes in Databricks), + environment_version: + type: string + description: >- + The environment version of the serverless Python + environment used to execute customer Python code. Each + environment version includes a specific Python version + and a curated set of pre-installed libraries with + defined versions, providing a stable and reproducible + execution environment. Databricks supports a three-year + lifecycle for each environment version. For available + versions and their included packages, see + https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ + The value should be a string representing the + environment version number, for example: `"4"`. description: >- Environment specification for this pipeline used to install dependencies. @@ -469,6 +483,48 @@ paths: properties: connection_name: type: string + connector_type: + type: string + x-enum: + - CDC + - QUERY_BASED + description: >- + (Optional) Connector Type for sources. Ex: CDC, Query + Based. + data_staging_options: + type: object + properties: + catalog_name: + type: string + description: >- + (Required, Immutable) The name of the catalog for + the connector's staging storage location. + schema_name: + type: string + description: >- + (Required, Immutable) The name of the schema for the + connector's staging storage location. + volume_name: + type: string + description: >- + (Optional) The Unity Catalog-compatible name for the + storage location. This is the volume to use for the + data that is extracted by the connector. Spark + Declarative Pipelines system will automatically + create the volume under the catalog and schema. For + Combined Cdc Managed Ingestion pipelines default + name for the volume would be : + __databricks_ingestion_gateway_staging_data-$pipelineId + required: + - catalog_name + - schema_name + description: >- + (Optional) Location of staged data storage. This is + required for migration from Cdc Managed Ingestion + Pipeline with Gateway pipeline to Combined Cdc Managed + Ingestion Pipeline. If not specified, the volume for + staged data will be created in catalog and schema/target + specified in the top level pipeline definition. full_refresh_window: type: object properties: @@ -1961,9 +2017,9 @@ paths: false. dry_run: type: boolean - description: ':param edition: str (optional) Pipeline product edition.' edition: type: string + description: Pipeline product edition. environment: type: object properties: @@ -1979,6 +2035,20 @@ paths: Allowed dependency could be , , (WSFS or Volumes in Databricks), + environment_version: + type: string + description: >- + The environment version of the serverless Python + environment used to execute customer Python code. Each + environment version includes a specific Python version + and a curated set of pre-installed libraries with + defined versions, providing a stable and reproducible + execution environment. Databricks supports a three-year + lifecycle for each environment version. For available + versions and their included packages, see + https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ + The value should be a string representing the + environment version number, for example: `"4"`. description: >- Environment specification for this pipeline used to install dependencies. @@ -2062,6 +2132,48 @@ paths: properties: connection_name: type: string + connector_type: + type: string + x-enum: + - CDC + - QUERY_BASED + description: >- + (Optional) Connector Type for sources. Ex: CDC, Query + Based. + data_staging_options: + type: object + properties: + catalog_name: + type: string + description: >- + (Required, Immutable) The name of the catalog for + the connector's staging storage location. + schema_name: + type: string + description: >- + (Required, Immutable) The name of the schema for the + connector's staging storage location. + volume_name: + type: string + description: >- + (Optional) The Unity Catalog-compatible name for the + storage location. This is the volume to use for the + data that is extracted by the connector. Spark + Declarative Pipelines system will automatically + create the volume under the catalog and schema. For + Combined Cdc Managed Ingestion pipelines default + name for the volume would be : + __databricks_ingestion_gateway_staging_data-$pipelineId + required: + - catalog_name + - schema_name + description: >- + (Optional) Location of staged data storage. This is + required for migration from Cdc Managed Ingestion + Pipeline with Gateway pipeline to Combined Cdc Managed + Ingestion Pipeline. If not specified, the volume for + staged data will be created in catalog and schema/target + specified in the top level pipeline definition. full_refresh_window: type: object properties: @@ -3175,10 +3287,18 @@ paths: The email of an active workspace user. Users can only set this field to their own email. description: >- - :param schema: str (optional) The default schema (database) - where tables are read from or published to. + Write-only setting, available only in Create/Update calls. + Specifies the user or service + principal that the pipeline runs as. If not specified, the pipeline runs as the user who created + the pipeline. + + Only `user_name` or `service_principal_name` can be specified. If both are specified, an error + is thrown. schema: type: string + description: >- + The default schema (database) where tables are read from or + published to. serverless: type: boolean description: Whether serverless compute is enabled for this pipeline. @@ -3353,15 +3473,15 @@ paths: required: true schema: type: string - description: >- - :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. - name: force in: query required: false schema: type: boolean + description: >- + If true, deletion will proceed even if resource cleanup fails. By + default, deletion will fail if resources cleanup is required but + fails. responses: '200': description: Success @@ -3394,7 +3514,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`GetPipelineResponse`' responses: '200': description: Success @@ -3761,6 +3880,20 @@ paths: Allowed dependency could be , , (WSFS or Volumes in Databricks), + environment_version: + type: string + description: >- + The environment version of the serverless Python + environment used to execute customer Python code. Each + environment version includes a specific Python version + and a curated set of pre-installed libraries with + defined versions, providing a stable and reproducible + execution environment. Databricks supports a three-year + lifecycle for each environment version. For available + versions and their included packages, see + https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ + The value should be a string representing the + environment version number, for example: `"4"`. description: >- Environment specification for this pipeline used to install dependencies. @@ -3850,6 +3983,48 @@ paths: properties: connection_name: type: string + connector_type: + type: string + x-enum: + - CDC + - QUERY_BASED + description: >- + (Optional) Connector Type for sources. Ex: CDC, Query + Based. + data_staging_options: + type: object + properties: + catalog_name: + type: string + description: >- + (Required, Immutable) The name of the catalog for + the connector's staging storage location. + schema_name: + type: string + description: >- + (Required, Immutable) The name of the schema for the + connector's staging storage location. + volume_name: + type: string + description: >- + (Optional) The Unity Catalog-compatible name for the + storage location. This is the volume to use for the + data that is extracted by the connector. Spark + Declarative Pipelines system will automatically + create the volume under the catalog and schema. For + Combined Cdc Managed Ingestion pipelines default + name for the volume would be : + __databricks_ingestion_gateway_staging_data-$pipelineId + required: + - catalog_name + - schema_name + description: >- + (Optional) Location of staged data storage. This is + required for migration from Cdc Managed Ingestion + Pipeline with Gateway pipeline to Combined Cdc Managed + Ingestion Pipeline. If not specified, the volume for + staged data will be created in catalog and schema/target + specified in the top level pipeline definition. full_refresh_window: type: object properties: @@ -4963,10 +5138,18 @@ paths: The email of an active workspace user. Users can only set this field to their own email. description: >- - :param schema: str (optional) The default schema (database) - where tables are read from or published to. + Write-only setting, available only in Create/Update calls. + Specifies the user or service + principal that the pipeline runs as. If not specified, the pipeline runs as the user who created + the pipeline. + + Only `user_name` or `service_principal_name` can be specified. If both are specified, an error + is thrown. schema: type: string + description: >- + The default schema (database) where tables are read from or + published to. serverless: type: boolean description: Whether serverless compute is enabled for this pipeline. @@ -5160,7 +5343,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`PipelinePermissions`' responses: '200': description: Success @@ -5233,7 +5415,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`PipelinePermissions`' responses: '200': description: Success @@ -5487,10 +5668,20 @@ paths: 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 parameters: Dict[str,str] (optional) + Key/value map of parameters to pass to the pipeline execution :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 replace_where_overrides: List[:class:`ReplaceWhereOverride`] + (optional) + A list of predicate overrides for replace_where flows in this update. Only replace_where flows may + be specified. Flows not listed use their original predicate. + :param reset_checkpoint_selection: List[str] (optional) + A list of flows for which this update should reset the streaming checkpoint. This selection will not + clear the data in the flow's target table. Flows in this list may also appear in refresh_selection + and full_refresh_selection. :param rewind_spec: :class:`RewindSpec` (optional) The information about the requested rewind operation. If specified this is a rewind mode update. :param validate_only: bool (optional) @@ -5504,7 +5695,6 @@ paths: required: true schema: type: string - description: ':param cause: :class:`StartUpdateCause` (optional)' requestBody: content: application/json: @@ -5534,6 +5724,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. + parameters: + type: object + description: >- + Key/value map of parameters to pass to the pipeline + execution refresh_selection: type: array items: @@ -5543,6 +5738,36 @@ 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. + replace_where_overrides: + type: array + items: + type: object + properties: + flow_name: + type: string + description: Name of the flow to apply this override to. + predicate_override: + type: string + description: >- + SQL predicate string to use as replace_where + condition. Example: `date = '2024-10-10' AND city = + 'xyz'` + description: >- + Specifies a replace_where predicate override for a replace + where flow. + description: >- + A list of predicate overrides for replace_where flows in + this update. Only replace_where flows may be specified. + Flows not listed use their original predicate. + reset_checkpoint_selection: + type: array + items: + type: string + description: >- + A list of flows for which this update should reset the + streaming checkpoint. This selection will not clear the data + in the flow's target table. Flows in this list may also + appear in refresh_selection and full_refresh_selection. rewind_spec: type: object properties: @@ -5633,10 +5858,6 @@ paths: required: true schema: type: string - description: >- - :returns: Long-running operation waiter for - :class:`GetPipelineResponse`. See :method:wait_get_pipeline_idle for - more details. responses: '200': description: Success @@ -5712,6 +5933,32 @@ components: description: >- A sequence number, unique and increasing within the data plane instance. + DataStagingOptions: + type: object + properties: + catalog_name: + type: string + description: >- + (Required, Immutable) The name of the catalog for the connector's + staging storage location. + schema_name: + type: string + description: >- + (Required, Immutable) The name of the schema for the connector's + staging storage location. + volume_name: + type: string + description: >- + (Optional) The Unity Catalog-compatible name for the storage + location. This is the volume to use for the data that is extracted + by the connector. Spark Declarative Pipelines system will + automatically create the volume under the catalog and schema. For + Combined Cdc Managed Ingestion pipelines default name for the volume + would be : __databricks_ingestion_gateway_staging_data-$pipelineId + required: + - catalog_name + - schema_name + description: Location of staged data storage DeletePipelineResponse: type: object properties: {} @@ -5779,6 +6026,9 @@ components: effective_budget_policy_id: type: string description: Serverless budget policy ID of this pipeline. + effective_publishing_mode: + $ref: '#/components/schemas/PublishingMode' + description: Publishing mode of the pipeline health: $ref: '#/components/schemas/GetPipelineResponseHealth' description: The health of a pipeline. @@ -5875,6 +6125,17 @@ components: properties: connection_name: type: string + connector_type: + $ref: '#/components/schemas/ConnectorType' + description: '(Optional) Connector Type for sources. Ex: CDC, Query Based.' + data_staging_options: + $ref: '#/components/schemas/DataStagingOptions' + description: >- + (Optional) Location of staged data storage. This is required for + migration from Cdc Managed Ingestion Pipeline with Gateway pipeline + to Combined Cdc Managed Ingestion Pipeline. If not specified, the + volume for staged data will be created in catalog and schema/target + specified in the top level pipeline definition. full_refresh_window: $ref: '#/components/schemas/OperationTimeWindow' description: >- @@ -6115,6 +6376,31 @@ components: host: type: string description: The optional host name where the event was triggered + ingestion_source_catalog_name: + type: string + description: >- + The name of the source catalog name (if known) from whose data + ingestion is described by this event. + ingestion_source_connection_name: + type: string + description: >- + The name of the source UC connection (if known) from whose data + ingestion is described by this event. + ingestion_source_schema_name: + type: string + description: >- + The name of the source schema name (if known) from whose data + ingestion is described by this event. + ingestion_source_table_name: + type: string + description: >- + The name of the source table name (if known) from whose data + ingestion is described by this event. + ingestion_source_table_version: + type: string + description: >- + An optional implementation-defined source table version of a dataset + being (re)ingested. maintenance_id: type: string description: The id of a maintenance run. Globally unique. @@ -6605,6 +6891,19 @@ components: Allowed dependency could be , , (WSFS or Volumes in Databricks), + environment_version: + type: string + description: >- + The environment version of the serverless Python environment used to + execute customer Python code. Each environment version includes a + specific Python version and a curated set of pre-installed libraries + with defined versions, providing a stable and reproducible execution + environment. Databricks supports a three-year lifecycle for each + environment version. For available versions and their included + packages, see + https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ + The value should be a string representing the environment version + number, for example: `"4"`. description: >- The environment entity used to preserve serverless environment side panel, jobs' environment for @@ -6633,6 +6932,18 @@ components: description: >- PostgresSlotConfig contains the configuration for a Postgres logical replication slot + ReplaceWhereOverride: + type: object + properties: + flow_name: + type: string + description: Name of the flow to apply this override to. + predicate_override: + type: string + description: >- + SQL predicate string to use as replace_where condition. Example: + `date = '2024-10-10' AND city = 'xyz'` + description: Specifies a replace_where predicate override for a replace where flow. ReportSpec: type: object properties: @@ -6973,6 +7284,9 @@ 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. + parameters: + type: object + description: Key/value map of parameters used to initiate the update pipeline_id: type: string description: The ID of the pipeline. @@ -7010,6 +7324,19 @@ components: x-enum: - MIGRATE_TO_UC description: Enum to specify which mode of clone to execute + ConnectorType: + type: string + x-enum: + - CDC + - QUERY_BASED + description: >- + For certain database sources LakeFlow Connect offers both query based + and cdc ingestion, + + ConnectorType can bse used to convey the type of ingestion. If + connection_name is provided for + + database sources, we default to Query Based ingestion DayOfWeek: type: string x-enum: @@ -7078,20 +7405,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7153,6 +7480,12 @@ components: - HEALTHY - UNHEALTHY description: The health of a pipeline. + PublishingMode: + type: string + x-enum: + - DEFAULT_PUBLISHING_MODE + - LEGACY_PUBLISHING_MODE + description: Enum representing the publishing mode of a pipeline. StartUpdateCause: type: string x-enum: 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 8cce07da..c4b6a7f1 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/postgres.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.postgres servers: - url: https://{deployment_name}.cloud.databricks.com @@ -274,6 +274,190 @@ paths: message: type: string x-stackql-sdk-source: PostgresAPI + /api/2.0/postgres/{parent}/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. + + :returns: :class:`Operation` + parameters: + - name: parent + 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 + 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. + requestBody: + content: + application/json: + schema: + type: object + properties: + database: + type: object + properties: + create_time: + type: string + format: date-time + description: A timestamp indicating when the database 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: + postgres_database: + type: string + role: + type: string + description: >- + The name of the role that owns the database. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} + To change the owner, pass valid existing Role name + when updating the Database A database always has an + owner. + description: The desired state of the Database. + status: + type: object + properties: + postgres_database: + type: string + 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. + description: The desired specification of a Database. + required: + - database + 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_databases + summary: List Databases. + tags: + - postgres + description: |- + List Databases. + + :param parent: str + The Branch that owns this collection of databases. Format: + projects/{project_id}/branches/{branch_id} + :param page_size: int (optional) + Upper bound for items returned. + :param page_token: str (optional) + Pagination token to go to the next page of Databases. Requests first page if absent. + + :returns: Iterator over :class:`Database` + parameters: + - name: parent + in: path + required: true + schema: + type: string + description: >- + The Branch that owns this collection of databases. Format: + projects/{project_id}/branches/{branch_id} + - 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 Databases. Requests first + page if absent. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListDatabasesResponse' + 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}/endpoints: post: operationId: postgres_create_endpoint @@ -366,6 +550,35 @@ paths: 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: >- @@ -404,6 +617,7 @@ paths: type: string x-enum: - ACTIVE + - DEGRADED - IDLE - INIT description: The state of the compute endpoint. @@ -422,6 +636,31 @@ paths: 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: @@ -433,6 +672,17 @@ paths: 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. description: >- Contains host information for connecting to the endpoint. @@ -440,6 +690,7 @@ paths: type: string x-enum: - ACTIVE + - DEGRADED - IDLE - INIT description: The state of the compute endpoint. @@ -593,6 +844,41 @@ paths: create_time: type: string format: date-time + initial_endpoint_spec: + type: object + properties: + 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: >- + Configuration settings for the initial Read/Write + endpoint created inside the default 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: >- @@ -601,6 +887,28 @@ paths: 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_endpoint_settings: type: object properties: @@ -636,13 +944,18 @@ paths: 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 true. 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 0s and 2592000s (up - to 30 days). + project. Value should be between 172800s (2 days) + and 2592000s (30 days). pg_version: type: integer description: >- @@ -658,6 +971,22 @@ paths: properties: branch_logical_size_limit_bytes: type: integer + budget_policy_id: + type: string + description: The budget policy that is applied to the project. + 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_endpoint_settings: type: object properties: @@ -691,6 +1020,11 @@ paths: 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: >- @@ -752,7 +1086,7 @@ paths: :param page_size: int (optional) - Upper bound for items returned. Cannot be negative. + 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. @@ -763,7 +1097,9 @@ paths: required: false schema: type: integer - description: Upper bound for items returned. Cannot be negative. + description: >- + Upper bound for items returned. Cannot be negative. The maximum + value is 100. - name: page_token in: query required: false @@ -859,6 +1195,21 @@ paths: 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: @@ -866,8 +1217,14 @@ paths: - NO_LOGIN - PG_PASSWORD_SCRAM_SHA_256 description: >- - How the role is authenticated when connecting to - Postgres. + 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: this is ignored for the Databricks identity + type GROUP, and NO_LOGIN is implicitly assumed + instead for the GROUP identity type. identity_type: type: string x-enum: @@ -879,6 +1236,18 @@ paths: 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: >- @@ -899,6 +1268,21 @@ paths: 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: @@ -915,6 +1299,18 @@ paths: - 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. @@ -1022,9 +1418,6 @@ paths: NOTE: setting this requires spinning up a compute to succeed, since it involves running SQL queries. - TODO: #LKB-7187 implement reassign_owned_to on LBM side. This might end-up being a synchronous query - when this parameter is used. - :returns: :class:`Operation` parameters: - name: name @@ -1044,9 +1437,7 @@ paths: 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. TODO: #LKB-7187 implement reassign_owned_to on - LBM side. This might end-up being a synchronous query when this - parameter is used. + running SQL queries. responses: '200': description: Success @@ -1114,21 +1505,24 @@ paths: type: string x-stackql-sdk-source: PostgresAPI patch: - operationId: postgres_update_project - summary: Updates the specified database project. + operationId: postgres_update_role + summary: Update a role for a branch. tags: - postgres description: |- - Updates the specified database project. + Update a role for a branch. :param name: str - Output only. The full resource path of the project. Format: projects/{project_id} - :param project: :class:`Project` - The Project to update. + 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 project's `name` field is used to identify the project to update. Format: projects/{project_id} + 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 - The list of fields to update. If unspecified, all fields will be updated when possible. + The list of fields to update in Postgres Role. If unspecified, all fields will be updated when + possible. :returns: :class:`Operation` parameters: @@ -1138,23 +1532,23 @@ paths: schema: type: string description: >- - Output only. The full resource path of the project. Format: - projects/{project_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: >- - The list of fields to update. If unspecified, all fields will be - updated when possible. + The list of fields to update in Postgres Role. If unspecified, all + fields will be updated when possible. requestBody: content: application/json: schema: type: object properties: - project: + role: type: object properties: create_time: @@ -1163,133 +1557,147 @@ paths: name: type: string description: >- - Output only. The full resource path of the project. - Format: projects/{project_id} + 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} spec: type: object properties: - default_endpoint_settings: + attributes: 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: + bypassrls: type: boolean - description: >- - When set to true, explicitly disables automatic - suspension (never suspend). Should be set to - true when provided. - 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). - description: A collection of settings for a compute endpoint. - display_name: + 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: >- - Human-readable project name. Length should be - between 1 and 256 characters. - history_retention_duration: + 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: this is ignored for the Databricks identity + type GROUP, and NO_LOGIN is implicitly assumed + instead for the GROUP identity type. + identity_type: type: string + x-enum: + - GROUP + - SERVICE_PRINCIPAL + - USER 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 0s and 2592000s (up - to 30 days). - pg_version: - type: integer + 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: >- - The major Postgres version number. Supported - versions are 16 and 17. + 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 2. group name for + IdentityType.GROUP description: >- - The spec contains the project configuration, including - display_name, pg_version (Postgres version), - history_retention_duration, and - default_endpoint_settings. + The spec contains the role configuration, including + identity type, authentication method, and role + attributes. status: type: object properties: - branch_logical_size_limit_bytes: - type: integer - default_endpoint_settings: + attributes: 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: + bypassrls: type: boolean - description: >- - When set to true, explicitly disables automatic - suspension (never suspend). Should be set to - true when provided. - 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). - description: The effective default endpoint settings. - display_name: - type: string - description: The effective human-readable project name. - history_retention_duration: + 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: >- - The effective number of seconds to retain the shared - history for point in time recovery. - owner: + How the role is authenticated when connecting to + Postgres. + identity_type: type: string - description: The email of the project owner. - pg_version: - type: integer - description: The effective major Postgres version number. - synthetic_storage_size_bytes: - type: integer + 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: >- - 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. + 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. + description: >- + Current status of the role, including its identity type, + authentication method, and role attributes. update_time: type: string format: date-time - description: >- - A timestamp indicating when the project was last - updated. description: >- - The Project to update. The project's `name` field is used to - identify the project to update. Format: - projects/{project_id} + 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} required: - - project + - role responses: '200': description: Success @@ -1365,29 +1773,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1562,6 +1961,34 @@ components: type: string format: date-time description: A timestamp indicating when the `current_state` began. + Database: + type: object + properties: + create_time: + type: string + format: date-time + description: A timestamp indicating when the database 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: + $ref: '#/components/schemas/DatabaseDatabaseSpec' + description: The desired state of the Database. + status: + $ref: '#/components/schemas/DatabaseDatabaseStatus' + description: The observed state of the Database. + update_time: + type: string + format: date-time + description: A timestamp indicating when the database was last updated. + description: Database represents a Postgres database within a Branch. DatabaseCredential: type: object properties: @@ -1573,6 +2000,31 @@ components: description: >- The OAuth token that can be used as a password when connecting to a database. + DatabaseDatabaseSpec: + type: object + properties: + postgres_database: + type: string + role: + type: string + description: >- + The name of the role that owns the database. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} To change + the owner, pass valid existing Role name when updating the Database + A database always has an owner. + DatabaseDatabaseStatus: + type: object + properties: + postgres_database: + type: string + role: + type: string + description: >- + The name of the role that owns the database. Format: + projects/{project_id}/branches/{branch_id}/roles/{role_id} + DatabaseOperationMetadata: + type: object + properties: {} DatabricksServiceExceptionWithDetailsProto: type: object properties: @@ -1618,6 +2070,47 @@ components: type: string format: date-time description: A timestamp indicating when the compute endpoint was last updated. + EndpointGroupSpec: + 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 + EndpointGroupStatus: + 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 EndpointHosts: type: object properties: @@ -1628,6 +2121,14 @@ components: 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. description: >- Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint. @@ -1659,6 +2160,13 @@ components: this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. + group: + $ref: '#/components/schemas/EndpointGroupSpec' + 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: >- @@ -1694,6 +2202,9 @@ components: endpoint_type: $ref: '#/components/schemas/EndpointType' description: The endpoint type. A branch can only have one READ_WRITE endpoint. + group: + $ref: '#/components/schemas/EndpointGroupStatus' + description: Details on the HA configuration of the endpoint. hosts: $ref: '#/components/schemas/EndpointHosts' description: Contains host information for connecting to the endpoint. @@ -1706,6 +2217,11 @@ components: description: >- Duration of inactivity after which the compute endpoint is automatically suspended. + InitialEndpointSpec: + type: object + properties: + group: + $ref: '#/components/schemas/EndpointGroupSpec' ListBranchesResponse: type: object properties: @@ -1716,6 +2232,16 @@ components: next_page_token: type: string description: Token to request the next page of branches. + ListDatabasesResponse: + type: object + properties: + databases: + type: array + items: + $ref: '#/components/schemas/Database' + next_page_token: + type: string + description: Pagination token to request the next page of databases. ListEndpointsResponse: type: object properties: @@ -1787,6 +2313,16 @@ components: create_time: type: string format: date-time + initial_endpoint_spec: + $ref: '#/components/schemas/InitialEndpointSpec' + description: >- + Configuration settings for the initial Read/Write endpoint created + inside the default 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: >- @@ -1808,6 +2344,14 @@ components: type: string format: date-time description: A timestamp indicating when the project was last updated. + ProjectCustomTag: + type: object + properties: + key: + type: string + value: + type: string + description: The value of the custom tag. ProjectDefaultEndpointSettings: type: object properties: @@ -1838,6 +2382,19 @@ components: ProjectSpec: type: object properties: + budget_policy_id: + type: string + custom_tags: + type: array + items: + $ref: '#/components/schemas/ProjectCustomTag' + 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_endpoint_settings: $ref: '#/components/schemas/ProjectDefaultEndpointSettings' display_name: @@ -1845,12 +2402,17 @@ components: 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 true. 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 - 0s and 2592000s (up to 30 days). + 172800s (2 days) and 2592000s (30 days). pg_version: type: integer description: The major Postgres version number. Supported versions are 16 and 17. @@ -1859,12 +2421,25 @@ components: properties: branch_logical_size_limit_bytes: type: integer + budget_policy_id: + type: string + description: The budget policy that is applied to the project. + custom_tags: + type: array + items: + $ref: '#/components/schemas/ProjectCustomTag' + description: The effective custom tags associated with 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: >- @@ -1925,20 +2500,49 @@ components: type: string format: date-time description: Role represents a Postgres role within a Branch. + RoleAttributes: + 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. RoleOperationMetadata: type: object properties: {} RoleRoleSpec: type: object properties: + attributes: + $ref: '#/components/schemas/RoleAttributes' auth_method: $ref: '#/components/schemas/RoleAuthMethod' + description: >- + 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: this is + ignored for the Databricks identity type GROUP, and NO_LOGIN is + implicitly assumed instead for the GROUP identity type. 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: >- @@ -1953,11 +2557,18 @@ components: RoleRoleStatus: type: object properties: + attributes: + $ref: '#/components/schemas/RoleAttributes' auth_method: $ref: '#/components/schemas/RoleAuthMethod' identity_type: $ref: '#/components/schemas/RoleIdentityType' description: The type of the role. + 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. @@ -1974,6 +2585,7 @@ components: type: string x-enum: - ACTIVE + - DEGRADED - IDLE - INIT description: The state of the compute endpoint. @@ -2086,20 +2698,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -2130,6 +2742,11 @@ components: to create a regular Postgres role not associated with a Databricks identity. + RoleMembershipRole: + type: string + x-enum: + - DATABRICKS_SUPERUSER + description: Roles that the DatabaseInstanceRole can be a member of. x-stackQL-resources: postgres_branches: id: databricks_workspace.postgres.postgres_branches @@ -2160,6 +2777,36 @@ components: update: [] delete: [] replace: [] + postgres: + id: databricks_workspace.postgres.postgres + name: postgres + title: Postgres + methods: + postgres_create_database: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1databases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + postgres_list_databases: + operation: + $ref: '#/paths/~1api~12.0~1postgres~1{parent}~1databases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/postgres/methods/postgres_list_databases + insert: + - $ref: >- + #/components/x-stackQL-resources/postgres/methods/postgres_create_database + update: [] + delete: [] + replace: [] postgres_endpoints: id: databricks_workspace.postgres.postgres_endpoints name: postgres_endpoints 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 1455fdd2..5e5b8099 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/qualitymonitorv2.yaml @@ -6,7 +6,7 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.qualitymonitorv2 servers: - url: https://{deployment_name}.cloud.databricks.com @@ -19,14 +19,16 @@ paths: post: operationId: quality_monitor_v2_create_quality_monitor summary: >- - [DEPRECATED] Create a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Create a quality tags: - qualitymonitorv2 - quality_monitor_v2 description: >- - [DEPRECATED] Create a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Create a quality + + monitor on UC object. :param quality_monitor: :class:`QualityMonitor` @@ -113,7 +115,6 @@ paths: required: - object_type - object_id - description: ':returns: :class:`QualityMonitor`' required: - quality_monitor responses: @@ -138,14 +139,16 @@ paths: get: operationId: quality_monitor_v2_list_quality_monitor summary: >- - [DEPRECATED] (Unimplemented) List quality monitors. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). (Unimplemented) tags: - qualitymonitorv2 - quality_monitor_v2 description: >- - [DEPRECATED] (Unimplemented) List quality monitors. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). (Unimplemented) + + List quality monitors. :param page_size: int (optional) @@ -160,7 +163,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -189,14 +191,16 @@ paths: delete: operationId: quality_monitor_v2_delete_quality_monitor summary: >- - [DEPRECATED] Delete a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Delete a quality tags: - qualitymonitorv2 - quality_monitor_v2 description: >- - [DEPRECATED] Delete a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Delete a quality + + monitor on UC object. :param object_type: str @@ -236,14 +240,16 @@ paths: get: operationId: quality_monitor_v2_get_quality_monitor summary: >- - [DEPRECATED] Read a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Read a quality tags: - qualitymonitorv2 - quality_monitor_v2 description: >- - [DEPRECATED] Read a quality monitor on UC object. Use Data Quality - Monitoring API instead. + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). Read a quality + + monitor on UC object. :param object_type: str @@ -289,16 +295,16 @@ paths: put: operationId: quality_monitor_v2_update_quality_monitor summary: >- - [DEPRECATED] (Unimplemented) Update a quality monitor on UC object. Use - Data Quality Monitoring API + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). (Unimplemented) tags: - qualitymonitorv2 - quality_monitor_v2 description: >- - [DEPRECATED] (Unimplemented) Update a quality monitor on UC object. Use - Data Quality Monitoring API + Deprecated: Use Data Quality Monitoring API instead + (/api/data-quality/v1/monitors). (Unimplemented) - instead. + Update a quality monitor on UC object. :param object_type: str @@ -404,7 +410,6 @@ paths: required: - object_type - object_id - description: ':returns: :class:`QualityMonitor`' required: - quality_monitor responses: 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 59ce3985..dcfd0ec1 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/serving.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.serving servers: - url: https://{deployment_name}.cloud.databricks.com @@ -115,64 +115,14 @@ paths: - BLOCK - MASK - 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.' + 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)\n\ + 3\n\n>>> list(Color)\n[, , ]\n\nMethods can\ + \ be added to enumerations, and members can have their own\nattributes -- see the documentation\ + \ for details." description: Configuration for guardrail PII filter. safety: type: boolean @@ -199,64 +149,14 @@ paths: - BLOCK - MASK - 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.' + 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)\n\ + 3\n\n>>> list(Color)\n[, , ]\n\nMethods can\ + \ be added to enumerations, and members can have their own\nattributes -- see the documentation\ + \ for details." description: Configuration for guardrail PII filter. safety: type: boolean @@ -297,64 +197,13 @@ paths: type: string x-enum: - minute - 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: "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." calls: type: integer description: Used to specify how many calls are allowed for a key within the renewal_period. @@ -449,64 +298,14 @@ paths: - google-cloud-vertex-ai - openai - palm - 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: "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." name: type: string description: The name of the external model. @@ -915,7 +714,6 @@ paths: description: The core config of the serving endpoint. description: type: string - description: ':param email_notifications: :class:`EmailNotifications` (optional) Email notification settings.' email_notifications: type: object properties: @@ -929,6 +727,7 @@ paths: type: string description: A list of email addresses to be notified when an endpoint successfully updates its configuration or state. + description: Email notification settings. rate_limits: type: array items: @@ -1122,64 +921,14 @@ paths: - BLOCK - MASK - 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.' + 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)\n\ + 3\n\n>>> list(Color)\n[, , ]\n\nMethods can\ + \ be added to enumerations, and members can have their own\nattributes -- see the documentation\ + \ for details." description: Configuration for guardrail PII filter. safety: type: boolean @@ -1206,64 +955,14 @@ paths: - BLOCK - MASK - 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.' + 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)\n\ + 3\n\n>>> list(Color)\n[, , ]\n\nMethods can\ + \ be added to enumerations, and members can have their own\nattributes -- see the documentation\ + \ for details." description: Configuration for guardrail PII filter. safety: type: boolean @@ -1304,64 +1003,13 @@ paths: type: string x-enum: - minute - 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: "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." calls: type: integer description: Used to specify how many calls are allowed for a key within the renewal_period. @@ -1461,7 +1109,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -1703,7 +1350,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ServingEndpointPermissions`' responses: '200': description: Success @@ -1765,7 +1411,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`ServingEndpointPermissions`' responses: '200': description: Success @@ -1797,7 +1442,10 @@ paths: \ 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 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\n:returns: :class:`HttpRequestResponse`" + :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: @@ -1825,6 +1473,11 @@ paths: params: type: string description: Query parameters for the request. + sub_domain: + type: string + description: Optional subdomain to prepend to the connection URL's host. If provided, this will be added + as a prefix to the connection URL's host. For example, if the connection URL is `https://api.example.com/v1` + and `sub_domain` is `"custom"`, the resulting URL will be `https://custom.api.example.com/v1`. required: - connection_name - method @@ -2079,64 +1732,13 @@ paths: - BLOCK - MASK - 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.' + 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." description: Configuration for guardrail PII filter. safety: type: boolean @@ -2163,64 +1765,13 @@ paths: - BLOCK - MASK - 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.' + 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." description: Configuration for guardrail PII filter. safety: type: boolean @@ -2260,64 +1811,13 @@ paths: type: string x-enum: - minute - 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: "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\n\ + attributes -- see the documentation for details." calls: type: integer description: Used to specify how many calls are allowed for a key within the renewal_period. @@ -2613,64 +2113,13 @@ paths: - google-cloud-vertex-ai - openai - palm - 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: "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." name: type: string description: The name of the external model. @@ -3220,8 +2669,6 @@ paths: description: The name of the served model this route configures traffic for. required: - traffic_percentage - description: ':returns: Long-running operation waiter for :class:`ServingEndpointDetailed`. See :method:wait_get_serving_endpoint_not_updating - for more details.' required: - config responses: @@ -4522,64 +3969,12 @@ components: - BLOCK - MASK - 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.' + 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." AiGatewayRateLimitKey: type: string x-enum: @@ -4587,126 +3982,22 @@ components: - service_principal - user - user_group - 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: "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." AiGatewayRateLimitRenewalPeriod: type: string x-enum: - minute - 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: "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." AmazonBedrockConfigBedrockProvider: type: string x-enum: @@ -4714,64 +4005,12 @@ components: - amazon - anthropic - cohere - 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: "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." ChatMessageRole: type: string x-enum: @@ -4791,127 +4030,23 @@ components: - NOT_UPDATING - UPDATE_CANCELED - UPDATE_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.' + 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." EndpointStateReady: type: string x-enum: - NOT_READY - 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.' + 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." ExternalFunctionRequestHttpMethod: type: string x-enum: @@ -4920,64 +4055,12 @@ components: - PATCH - POST - PUT - 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: "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." ExternalModelProvider: type: string x-enum: @@ -4990,64 +4073,12 @@ components: - google-cloud-vertex-ai - openai - palm - 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: "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." QueryEndpointResponseObject: type: string x-enum: @@ -5062,126 +4093,22 @@ components: x-enum: - endpoint - 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.' + 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." RateLimitRenewalPeriod: type: string x-enum: - minute - 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: "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." ServedModelInputWorkloadType: type: string x-enum: @@ -5199,128 +4126,24 @@ components: - DEPLOYMENT_FAILED - DEPLOYMENT_READY - DEPLOYMENT_RECOVERING - 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: "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." ServingEndpointDetailedPermissionLevel: type: string x-enum: - CAN_MANAGE - CAN_QUERY - 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.' + 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." ServingEndpointPermissionLevel: type: string x-enum: 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 acdf9fc6..2b38d3f9 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/settings.yaml @@ -5,7 +5,7 @@ info: Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.settings servers: - url: https://{deployment_name}.cloud.databricks.com @@ -167,20 +167,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -209,15 +209,14 @@ paths: per workspace. required: - aibi_dashboard_embedding_access_policy - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -396,15 +395,14 @@ paths: per workspace. required: - aibi_dashboard_embedding_approved_domains - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -568,20 +566,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -615,20 +613,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -664,15 +662,14 @@ paths: per workspace. required: - automatic_cluster_update_workspace - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -828,15 +825,14 @@ paths: per workspace. required: - compliance_security_profile_workspace - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -892,7 +888,7 @@ paths: type: integer description: The ID of the workspace. description: The partition of Credentials store - token_type: + tokenType: type: array items: type: string @@ -911,7 +907,7 @@ paths: description: Array of scopes for the token request. required: - partition_id - - token_type + - tokenType - scopes responses: '200': @@ -1074,15 +1070,14 @@ paths: per workspace. required: - csp_enablement_account - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -1257,15 +1252,14 @@ paths: per workspace. required: - boolean_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -1448,15 +1442,22 @@ paths: per workspace. required: - namespace - description: ':param field_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.' + description: |- + This represents the setting configuration for the default namespace in the Databricks workspace. + Setting the default catalog for the workspace determines the catalog that is used when queries + do not reference a fully qualified 3 level name. For example, if the default catalog is set to + 'retail_prod' then a query 'SELECT * FROM myTable' would reference the object + 'retail_prod.default.myTable' (the schema 'default' is always assumed). This setting requires a + restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only + applies when using Unity Catalog-enabled compute. field_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. required: - allow_missing - setting @@ -1631,15 +1632,14 @@ paths: per workspace. required: - string_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -1814,15 +1814,14 @@ paths: per workspace. required: - disable_legacy_access - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -1997,15 +1996,14 @@ paths: per workspace. required: - disable_legacy_dbfs - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2196,15 +2194,14 @@ paths: per workspace. required: - disable_legacy_features - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2307,15 +2304,14 @@ paths: not be respected even if it's set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be 'default' if the setting only has one instance per workspace. - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2506,15 +2502,14 @@ paths: per workspace. required: - acct_ip_acl_enable - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2617,15 +2612,14 @@ paths: not be respected even if it's set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be 'default' if the setting only has one instance per workspace. - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2728,15 +2722,14 @@ paths: not be respected even if it's set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be 'default' if the setting only has one instance per workspace. - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -2868,15 +2861,14 @@ paths: per workspace. required: - enhanced_security_monitoring_workspace - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -3016,15 +3008,14 @@ paths: per workspace. required: - esm_enablement_account - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -3091,7 +3082,11 @@ paths: x-enum: - ALLOW - BLOCK - description: ':param ip_addresses: List[str] (optional)' + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. ip_addresses: type: array items: @@ -3268,14 +3263,18 @@ paths: x-enum: - ALLOW - BLOCK - description: ':param enabled: bool Specifies whether this IP access list is enabled.' + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. enabled: type: boolean + description: Specifies whether this IP access list is enabled. ip_addresses: type: array items: type: string - description: List[str] (optional) required: - label - list_type @@ -3345,15 +3344,19 @@ paths: type: array items: type: string - description: ':param label: str (optional) Label for the IP access list. This **cannot** be empty.' label: type: string + description: Label for the IP access list. This **cannot** be empty. list_type: type: string x-enum: - ALLOW - BLOCK - description: :class:`ListType` (optional) + description: |- + Type of IP access list. Valid values are as follows and are case-sensitive: + + * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or + range. IP addresses in the block list are excluded even if they are included in an allow list. responses: '200': description: Success @@ -3484,15 +3487,14 @@ paths: per workspace. required: - boolean_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -3631,15 +3633,14 @@ paths: per workspace. required: - boolean_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -3814,15 +3815,14 @@ paths: per workspace. required: - boolean_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -4000,7 +4000,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -4042,7 +4041,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -4076,7 +4074,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`NotificationDestination`' responses: '200': description: Success @@ -4418,15 +4415,14 @@ paths: per workspace. required: - personal_compute - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -4607,20 +4603,20 @@ paths: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -4632,6 +4628,10 @@ paths: 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 etag: @@ -4649,15 +4649,14 @@ paths: per workspace. required: - restrict_workspace_admins - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -4832,15 +4831,14 @@ paths: per workspace. required: - boolean_val - description: ':param field_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.' field_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. required: - allow_missing - setting @@ -5090,7 +5088,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`TokenPermissions`' responses: '200': description: Success @@ -5146,7 +5143,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`TokenPermissions`' responses: '200': description: Success @@ -5356,7 +5352,6 @@ paths: required: true schema: type: string - description: ':returns: Dict[str,str]' responses: '200': description: Success @@ -7026,6 +7021,10 @@ components: properties: status: $ref: '#/components/schemas/RestrictWorkspaceAdminsMessageStatus' + 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 RestrictWorkspaceAdminsSetting: @@ -7236,20 +7235,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7283,20 +7282,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7330,20 +7329,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7398,20 +7397,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7443,20 +7442,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7493,20 +7492,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7535,20 +7534,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7597,20 +7596,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7638,20 +7637,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7686,20 +7685,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7739,20 +7738,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7805,20 +7804,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7852,20 +7851,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7905,20 +7904,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 3a8aae7a..3acb925a 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/settingsv2.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.settingsv2 servers: - url: https://{deployment_name}.cloud.databricks.com @@ -135,29 +135,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -260,29 +251,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -333,29 +315,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -428,29 +401,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -557,29 +521,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -630,29 +585,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -760,29 +706,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -802,6 +739,12 @@ paths: 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: >- @@ -883,29 +826,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -925,6 +859,12 @@ paths: 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: >- @@ -941,7 +881,6 @@ paths: Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value. - description: ':returns: :class:`Setting`' required: - setting responses: @@ -1164,6 +1103,11 @@ components: properties: status: $ref: '#/components/schemas/RestrictWorkspaceAdminsMessageStatus' + 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 Setting: @@ -1324,20 +1268,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1371,20 +1315,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1418,20 +1362,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1479,20 +1423,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 48ee2084..1db97298 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/sharing.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.sharing servers: - url: https://{deployment_name}.cloud.databricks.com @@ -58,11 +58,10 @@ paths: - OAUTH_CLIENT_CREDENTIALS - OIDC_FEDERATION - TOKEN - description: >- - :param comment: str (optional) Description about the - provider. + description: The delta sharing authentication type. comment: type: string + description: Description about the provider. recipient_profile_str: type: string description: >- @@ -808,7 +807,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -1000,11 +998,10 @@ paths: - OAUTH_CLIENT_CREDENTIALS - OIDC_FEDERATION - TOKEN - description: >- - :param comment: str (optional) Description about the - recipient. + description: The delta sharing authentication type. comment: type: string + description: Description about the recipient. data_recipient_global_metastore_id: type: string description: >- @@ -1822,29 +1819,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3015,11 +3003,6 @@ components: id: type: string description: The id of the table. - internal_attributes: - $ref: '#/components/schemas/TableInternalAttributes' - description: >- - Internal information for D2D sharing that should not be disclosed to - external users. materialization_namespace: type: string description: The catalog and schema of the materialized table @@ -3041,47 +3024,6 @@ components: tags: type: string description: The Tags of the table. - TableInternalAttributes: - type: object - properties: - auxiliary_managed_location: - type: string - description: Managed Delta Metadata location for foreign iceberg tables. - dependency_storage_locations: - type: array - items: - type: string - description: >- - Storage locations of all table dependencies for shared views. Used - on the recipient side for SEG (Secure Egress Gateway) whitelisting. - has_delta_uniform_iceberg: - type: boolean - description: Whether the table has uniform enabled. - parent_storage_location: - type: string - description: >- - Will be populated in the reconciliation response for VIEW and - FOREIGN_TABLE, with the value of the parent UC entity's - storage_location, following the same logic as getManagedEntityPath - in CreateStagingTableHandler, which is used to store the - materialized table for a shared VIEW/FOREIGN_TABLE for D2O queries. - The value will be used on the recipient side to be whitelisted when - SEG is enabled on the workspace of the recipient, to allow the - recipient users to query this shared VIEW/FOREIGN_TABLE. - storage_location: - type: string - description: >- - The cloud storage location of a shard table with - DIRECTORY_BASED_TABLE type. - type: - $ref: '#/components/schemas/TableInternalAttributesSharedTableType' - description: The type of the shared table. - view_definition: - type: string - description: The view definition of a shared view. DEPRECATED. - description: >- - Internal information for D2D sharing that should not be disclosed to - external users. UpdateSharePermissionsResponse: type: object properties: @@ -3100,11 +3042,6 @@ components: This id maps to the shared_volume_id in database Recipient needs shared_volume_id for recon to check if this volume is already in recipient's DB or not. - internal_attributes: - $ref: '#/components/schemas/VolumeInternalAttributes' - description: >- - Internal attributes for D2D sharing that should not be disclosed to - external users. name: type: string description: The name of the volume. @@ -3120,18 +3057,6 @@ components: tags: type: string description: The tags of the volume. - VolumeInternalAttributes: - type: object - properties: - storage_location: - type: string - description: The cloud storage location of the volume - type: - type: string - description: The type of the shared volume. - description: >- - Internal information for D2D sharing that should not be disclosed to - external users. AuthenticationType: type: string x-enum: @@ -3187,20 +3112,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3229,20 +3154,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3271,20 +3196,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3356,20 +3281,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3407,20 +3332,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3449,20 +3374,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3491,20 +3416,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3534,20 +3459,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -3566,55 +3491,6 @@ components: - FUNCTION_REGISTERED_MODEL - FUNCTION_STANDARD description: The SecurableKind of a delta-shared object. - TableInternalAttributesSharedTableType: - type: string - x-enum: - - DELTA_ICEBERG_TABLE - - DIRECTORY_BASED_TABLE - - FILE_BASED_TABLE - - FOREIGN_ICEBERG_TABLE - - FOREIGN_TABLE - - MATERIALIZED_VIEW - - METRIC_VIEW - - STREAMING_TABLE - - 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. x-stackQL-resources: providers: id: databricks_workspace.sharing.providers 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 9a257294..09195f2c 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/sql.yaml @@ -6,7 +6,7 @@ info: generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.sql servers: - url: https://{deployment_name}.cloud.databricks.com @@ -68,29 +68,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -182,13 +173,12 @@ paths: triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again. + auto_resolve_display_name: + type: boolean description: >- - :param auto_resolve_display_name: bool (optional) If true, - automatically resolve alert display name conflicts. + If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name. - auto_resolve_display_name: - type: boolean responses: '200': description: Success @@ -236,7 +226,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -287,7 +276,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -321,7 +309,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`Alert`' responses: '200': description: Success @@ -373,17 +360,6 @@ paths: required: true schema: type: string - description: >- - :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. requestBody: content: application/json: @@ -392,6 +368,18 @@ paths: 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. alert: type: object properties: @@ -423,29 +411,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -539,13 +518,12 @@ paths: triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again. + auto_resolve_display_name: + type: boolean description: >- - :param auto_resolve_display_name: bool (optional) If true, - automatically resolve alert display name conflicts. + If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name. - auto_resolve_display_name: - type: boolean required: - update_mask responses: @@ -770,7 +748,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -813,7 +790,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`LegacyAlert`' responses: '200': description: Success @@ -867,7 +843,6 @@ paths: required: true schema: type: string - description: ':param name: str Name of the alert.' requestBody: content: application/json: @@ -876,6 +851,7 @@ paths: properties: name: type: string + description: Name of the alert. options: type: object properties: @@ -1221,7 +1197,6 @@ paths: - warehouse_id - evaluation - schedule - description: ':returns: :class:`AlertV2`' required: - alert responses: @@ -1262,7 +1237,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -1306,7 +1280,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`AlertV2`' responses: '200': description: Success @@ -1354,14 +1327,14 @@ paths: required: true schema: type: string - description: >- - :param purge: bool (optional) Whether to permanently delete the - alert. If not set, the alert will only be soft deleted. - name: purge in: query required: false schema: type: boolean + description: >- + Whether to permanently delete the alert. If not set, the alert will + only be soft deleted. responses: '200': description: Success @@ -1413,6 +1386,17 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -1665,19 +1649,6 @@ paths: - warehouse_id - evaluation - schedule - description: >- - :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. required: - alert responses: @@ -1776,9 +1747,9 @@ paths: updated_at: type: string description: Timestamp of the last time this object was updated. - description: ':param width: int Width of a widget' width: type: integer + description: Width of a widget text: type: string description: >- @@ -1932,9 +1903,9 @@ paths: updated_at: type: string description: Timestamp of the last time this object was updated. - description: ':param width: int Width of a widget' width: type: integer + description: Width of a widget text: type: string description: >- @@ -1985,6 +1956,13 @@ paths: be shared. + **Warning**: This API is deprecated. Please use the AI/BI Dashboards API + instead. [Learn more] + + + [Learn more]: https://docs.databricks.com/en/dashboards/ + + :param dashboard_id: str parameters: - name: dashboard_id @@ -1992,7 +1970,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2021,6 +1998,13 @@ paths: visualization and query objects. + **Warning**: This API is deprecated. Please use the AI/BI Dashboards API + instead. [Learn more] + + + [Learn more]: https://docs.databricks.com/en/dashboards/ + + :param dashboard_id: str @@ -2031,7 +2015,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`Dashboard`' responses: '200': description: Success @@ -2069,6 +2052,13 @@ paths: **Note**: You cannot undo this operation. + **Warning**: This API is deprecated. Please use the AI/BI Dashboards API + instead. [Learn more] + + + [Learn more]: https://docs.databricks.com/en/dashboards/ + + :param dashboard_id: str :param name: str (optional) @@ -2086,9 +2076,6 @@ paths: required: true schema: type: string - description: >- - :param name: str (optional) The title of this dashboard that appears - in list views and at the top of the dashboard page. requestBody: content: application/json: @@ -2097,6 +2084,9 @@ paths: properties: name: type: string + description: >- + The title of this dashboard that appears in list views and + at the top of the dashboard page. run_as_role: type: string x-enum: @@ -2110,7 +2100,6 @@ paths: type: array items: type: string - description: ':returns: :class:`Dashboard`' responses: '200': description: Success @@ -2147,6 +2136,13 @@ paths: degradation, or a temporary ban. + **Warning**: This API is deprecated. Please use the AI/BI Dashboards API + instead. [Learn more] + + + [Learn more]: https://docs.databricks.com/en/dashboards/ + + :param order: :class:`ListOrder` (optional) Name of dashboard attribute to order by. :param page: int (optional) @@ -2215,6 +2211,13 @@ paths: shared. + **Warning**: This API is deprecated. Please use the AI/BI Dashboards API + instead. [Learn more] + + + [Learn more]: https://docs.databricks.com/en/dashboards/ + + :param dashboard_id: str parameters: - name: dashboard_id @@ -2222,7 +2225,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2427,7 +2429,6 @@ paths: `CAN_MANAGE`: Can manage the query user_name: type: string - description: ':returns: :class:`SetResponse`' required: - object_type responses: @@ -2761,7 +2762,6 @@ paths: warehouse_id: type: string description: ID of the SQL warehouse attached to the query. - description: ':returns: :class:`Query`' responses: '200': description: Success @@ -2809,7 +2809,6 @@ paths: required: false schema: type: integer - description: ':param page_token: str (optional)' - name: page_token in: query required: false @@ -2860,7 +2859,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -2894,7 +2892,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`Query`' responses: '200': description: Success @@ -2946,17 +2943,6 @@ paths: required: true schema: type: string - description: >- - :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. requestBody: content: application/json: @@ -2965,6 +2951,18 @@ paths: 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. auto_resolve_display_name: type: boolean description: >- @@ -3171,7 +3169,6 @@ paths: warehouse_id: type: string description: ID of the SQL warehouse attached to the query. - description: ':returns: :class:`Query`' required: - update_mask responses: @@ -3214,7 +3211,6 @@ paths: required: true schema: type: string - description: ':param page_size: int (optional)' - name: page_size in: query required: false @@ -3225,7 +3221,6 @@ paths: required: false schema: type: string - description: ':returns: Iterator over :class:`Visualization`' responses: '200': description: Success @@ -3355,7 +3350,6 @@ paths: type: array items: type: string - description: ':returns: :class:`LegacyQuery`' responses: '200': description: Success @@ -3505,7 +3499,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -3553,7 +3546,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`LegacyQuery`' responses: '200': description: Success @@ -3623,11 +3615,6 @@ paths: required: true schema: type: string - description: >- - :param data_source_id: str (optional) Data source ID maps to the ID - of the data source used by the resource and is distinct from the - warehouse ID. [Learn more] [Learn more]: - https://docs.databricks.com/api/workspace/datasources/list requestBody: content: application/json: @@ -3636,6 +3623,11 @@ paths: properties: data_source_id: type: string + description: >- + Data source ID maps to the ID of the data source used by the + resource and is distinct from the warehouse ID. [Learn more] + [Learn more]: + https://docs.databricks.com/api/workspace/datasources/list description: type: string description: >- @@ -3669,7 +3661,6 @@ paths: type: array items: type: string - description: ':returns: :class:`LegacyQuery`' responses: '200': description: Success @@ -3719,7 +3710,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -3878,7 +3868,6 @@ paths: description: >- The type of visualization: counter, table, funnel, and so on. - description: ':returns: :class:`Visualization`' responses: '200': description: Success @@ -3915,7 +3904,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -3964,17 +3952,6 @@ paths: required: true schema: type: string - description: >- - :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. requestBody: content: application/json: @@ -3983,6 +3960,18 @@ paths: 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. visualization: type: object properties: @@ -4007,7 +3996,6 @@ paths: description: >- The type of visualization: counter, table, funnel, and so on. - description: ':returns: :class:`Visualization`' required: - update_mask responses: @@ -4212,11 +4200,11 @@ paths: properties: created_at: type: string - description: >- - :param description: str (optional) A short description of - this visualization. This is not displayed in the UI. description: type: string + description: >- + A short description of this visualization. This is not + displayed in the UI. name: type: string description: >- @@ -4466,14 +4454,13 @@ paths: visualization by copying description objects received _from the API_ and then using them to create a new one with a POST request to the same endpoint. Databricks does not recommend constructing ad-hoc visualizations entirely in JSON. - description: >- - :param type: str (optional) The type of visualization: - chart, table, pivot table, and so on. type: type: string + description: >- + The type of visualization: chart, table, pivot table, and so + on. updated_at: type: string - description: ':returns: :class:`LegacyVisualization`' responses: '200': description: Success @@ -5172,7 +5159,6 @@ paths: required: true schema: type: integer - description: ':returns: :class:`ResultData`' responses: '200': description: Success @@ -5218,13 +5204,13 @@ paths: max_num_clusters. Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - 2X-Large - 3X-Large - - 4X-Large + 4X-Large - 5X-Large :param creator_name: str (optional) warehouse creator name :param enable_photon: bool (optional) Configures whether the warehouse should use Photon optimized clusters. - Defaults to false. + Defaults to true. :param enable_serverless_compute: bool (optional) Configures whether the warehouse should use serverless compute :param instance_profile_arn: str (optional) @@ -5306,29 +5292,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -5357,7 +5334,7 @@ paths: larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters. Supported values: - 2X-Small - X-Small - Small - Medium - Large - - X-Large - 2X-Large - 3X-Large - 4X-Large + X-Large - 2X-Large - 3X-Large - 4X-Large - 5X-Large creator_name: type: string description: warehouse creator name @@ -5365,7 +5342,7 @@ paths: type: boolean description: >- Configures whether the warehouse should use Photon optimized - clusters. Defaults to false. + clusters. Defaults to true. enable_serverless_compute: type: boolean description: >- @@ -5471,8 +5448,8 @@ paths: When paginating, all other parameters provided to `ListWarehouses` must match the call that provided the page token. :param run_as_user_id: int (optional) - Service Principal which will be used to fetch the list of endpoints. If not specified, SQL Gateway - will use the user from the session header. + Deprecated: this field is ignored by the server. Service Principal which will be used to fetch the + list of endpoints. If not specified, SQL Gateway will use the user from the session header. :returns: Iterator over :class:`EndpointInfo` parameters: @@ -5498,9 +5475,9 @@ paths: schema: type: integer description: >- - Service Principal which will be used to fetch the list of endpoints. - If not specified, SQL Gateway will use the user from the session - header. + Deprecated: this field is ignored by the server. Service Principal + which will be used to fetch the list of endpoints. If not specified, + SQL Gateway will use the user from the session header. responses: '200': description: Success @@ -5995,13 +5972,13 @@ paths: max_num_clusters. Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - 2X-Large - 3X-Large - - 4X-Large + 4X-Large - 5X-Large :param creator_name: str (optional) warehouse creator name :param enable_photon: bool (optional) Configures whether the warehouse should use Photon optimized clusters. - Defaults to false. + Defaults to true. :param enable_serverless_compute: bool (optional) Configures whether the warehouse should use serverless compute :param instance_profile_arn: str (optional) @@ -6090,29 +6067,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6141,7 +6109,7 @@ paths: larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters. Supported values: - 2X-Small - X-Small - Small - Medium - Large - - X-Large - 2X-Large - 3X-Large - 4X-Large + X-Large - 2X-Large - 3X-Large - 4X-Large - 5X-Large creator_name: type: string description: warehouse creator name @@ -6149,7 +6117,7 @@ paths: type: boolean description: >- Configures whether the warehouse should use Photon optimized - clusters. Defaults to false. + clusters. Defaults to true. enable_serverless_compute: type: boolean description: >- @@ -6381,7 +6349,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`WarehousePermissions`' responses: '200': description: Success @@ -6458,7 +6425,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`WarehousePermissions`' responses: '200': description: Success @@ -6533,7 +6499,7 @@ paths: :param data_access_config: List[:class:`EndpointConfPair`] (optional) Spark confs for external hive metastore configuration JSON serialized size must be less than <= 512K :param enable_serverless_compute: bool (optional) - Enable Serverless compute for SQL warehouses + Deprecated: only setting this to true is allowed. :param enabled_warehouse_types: List[:class:`WarehouseTypePair`] (optional) List of Warehouse Types allowed in this workspace (limits allowed value of the type field in @@ -6591,29 +6557,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -6670,7 +6627,7 @@ paths: serialized size must be less than <= 512K enable_serverless_compute: type: boolean - description: Enable Serverless compute for SQL warehouses + description: 'Deprecated: only setting this to true is allowed.' enabled_warehouse_types: type: array items: @@ -6707,29 +6664,20 @@ paths: Access them by: - - attribute access:: - - - >>> Color.RED - - + - attribute access: + >>> Color.RED + - value lookup: - - >>> Color(1) - - - + >>> Color(1) + - name lookup: - - >>> Color['RED'] - - - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -7767,7 +7715,7 @@ components: size of a spark cluster allows you to run larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters. Supported values: - 2X-Small - X-Small - Small - - Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large + Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large - 5X-Large creator_name: type: string description: warehouse creator name @@ -7775,7 +7723,7 @@ components: type: boolean description: >- Configures whether the warehouse should use Photon optimized - clusters. Defaults to false. + clusters. Defaults to true. enable_serverless_compute: type: boolean description: Configures whether the warehouse should use serverless compute @@ -7990,7 +7938,7 @@ components: size of a spark cluster allows you to run larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters. Supported values: - 2X-Small - X-Small - Small - - Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large + Medium - Large - X-Large - 2X-Large - 3X-Large - 4X-Large - 5X-Large creator_name: type: string description: warehouse creator name @@ -7998,7 +7946,7 @@ components: type: boolean description: >- Configures whether the warehouse should use Photon optimized - clusters. Defaults to false. + clusters. Defaults to true. enable_serverless_compute: type: boolean description: Configures whether the warehouse should use serverless compute @@ -8080,7 +8028,7 @@ components: serialized size must be less than <= 512K enable_serverless_compute: type: boolean - description: Enable Serverless compute for SQL warehouses + description: 'Deprecated: only setting this to true is allowed.' enabled_warehouse_types: type: array items: @@ -9545,20 +9493,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9602,20 +9550,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9649,20 +9597,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9699,20 +9647,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9743,20 +9691,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9818,20 +9766,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9861,20 +9809,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9904,20 +9852,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -9961,20 +9909,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10003,20 +9951,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10051,20 +9999,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10094,20 +10042,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10137,20 +10085,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10202,20 +10150,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10245,20 +10193,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10295,20 +10243,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10337,20 +10285,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10379,20 +10327,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10438,20 +10386,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10483,20 +10431,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10567,20 +10515,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10621,20 +10569,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10663,20 +10611,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10705,20 +10653,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10759,20 +10707,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10860,20 +10808,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10903,20 +10851,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -10944,20 +10892,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -11070,6 +11018,7 @@ components: - GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED - GKE_BASED_CLUSTER_TERMINATION - GLOBAL_INIT_SCRIPT_FAILURE + - HIVEMETASTORE_CONNECTIVITY_FAILURE - HIVE_METASTORE_PROVISIONING_FAILURE - IMAGE_PULL_PERMISSION_DENIED - INACTIVITY @@ -11194,20 +11143,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: 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 9aacabb5..799e2714 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/tags.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.tags servers: - url: https://{deployment_name}.cloud.databricks.com @@ -77,7 +77,6 @@ paths: - name required: - tag_key - description: ':returns: :class:`TagPolicy`' required: - tag_policy responses: @@ -197,7 +196,6 @@ paths: required: true schema: type: string - description: str responses: '200': description: Success @@ -248,7 +246,6 @@ paths: required: true schema: type: string - description: ':returns: :class:`TagPolicy`' responses: '200': description: Success @@ -315,7 +312,6 @@ paths: required: true schema: type: string - description: ':param tag_policy: :class:`TagPolicy`' - name: update_mask in: query required: true @@ -413,7 +409,7 @@ paths: type: string description: >- The identifier of the entity to which the tag is - assigned + assigned. For apps, the entity_id is the app name tag_key: type: string description: >- @@ -426,7 +422,6 @@ paths: - entity_type - entity_id - tag_key - description: ':returns: :class:`TagAssignment`' required: - tag_assignment responses: @@ -459,9 +454,10 @@ paths: Delete a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, + notebooks :param entity_id: str - The identifier of the entity to which the tag is assigned + The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed parameters: @@ -472,13 +468,15 @@ paths: type: string description: >- The type of entity to which the tag is assigned. Allowed values are - apps, dashboards, geniespaces + apps, dashboards, geniespaces, notebooks - name: entity_id in: path required: true schema: type: string - description: The identifier of the entity to which the tag is assigned + description: >- + The identifier of the entity to which the tag is assigned. For apps, + the entity_id is the app name - name: tag_key in: path required: true @@ -512,9 +510,10 @@ paths: Get a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, + notebooks :param entity_id: str - The identifier of the entity to which the tag is assigned + The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed @@ -527,13 +526,15 @@ paths: type: string description: >- The type of entity to which the tag is assigned. Allowed values are - apps, dashboards, geniespaces + apps, dashboards, geniespaces, notebooks - name: entity_id in: path required: true schema: type: string - description: The identifier of the entity to which the tag is assigned + description: >- + The identifier of the entity to which the tag is assigned. For apps, + the entity_id is the app name - name: tag_key in: path required: true @@ -571,9 +572,10 @@ paths: Update a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, + notebooks :param entity_id: str - The identifier of the entity to which the tag is assigned + The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed :param tag_assignment: :class:`TagAssignment` @@ -597,13 +599,15 @@ paths: type: string description: >- The type of entity to which the tag is assigned. Allowed values are - apps, dashboards, geniespaces + apps, dashboards, geniespaces, notebooks - name: entity_id in: path required: true schema: type: string - description: The identifier of the entity to which the tag is assigned + description: >- + The identifier of the entity to which the tag is assigned. For apps, + the entity_id is the app name - name: tag_key in: path required: true @@ -617,6 +621,17 @@ paths: required: true schema: 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. requestBody: content: application/json: @@ -632,7 +647,7 @@ paths: type: string description: >- The identifier of the entity to which the tag is - assigned + assigned. For apps, the entity_id is the app name tag_key: type: string description: >- @@ -645,19 +660,6 @@ paths: - entity_type - entity_id - tag_key - description: >- - :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. required: - tag_assignment responses: @@ -690,9 +692,10 @@ paths: List the tag assignments for an entity :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, + notebooks :param entity_id: str - The identifier of the entity to which the tag is assigned + The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param page_size: int (optional) Optional. Maximum number of tag assignments to return in a single page :param page_token: str (optional) @@ -707,13 +710,15 @@ paths: type: string description: >- The type of entity to which the tag is assigned. Allowed values are - apps, dashboards, geniespaces + apps, dashboards, geniespaces, notebooks - name: entity_id in: path required: true schema: type: string - description: The identifier of the entity to which the tag is assigned + description: >- + The identifier of the entity to which the tag is assigned. For apps, + the entity_id is the app name - name: page_size in: query required: false @@ -776,7 +781,9 @@ components: type: string entity_id: type: string - description: The identifier of the entity to which the tag is assigned + 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: >- 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 97582232..8dc443b6 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/vectorsearch.yaml @@ -6,7 +6,7 @@ info: (workspace-level APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.vectorsearch servers: - url: https://{deployment_name}.cloud.databricks.com @@ -31,6 +31,9 @@ paths: Type of endpoint :param budget_policy_id: str (optional) The budget policy id to be applied + :param min_qps: int (optional) + Min QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is + calculated at index creation/sync time based on this value. :returns: Long-running operation waiter for :class:`EndpointInfo`. @@ -52,6 +55,12 @@ paths: budget_policy_id: type: string description: The budget policy id to be applied + min_qps: + type: integer + description: >- + Min QPS for the endpoint. Mutually exclusive with + num_replicas. The actual replica count is calculated at + index creation/sync time based on this value. required: - name - endpoint_type @@ -186,6 +195,58 @@ paths: message: type: string x-stackql-sdk-source: VectorSearchEndpointsAPI + patch: + operationId: vector_search_endpoints_patch_endpoint + summary: Update an endpoint + tags: + - vectorsearch + - vector_search_endpoints + description: |- + Update an endpoint + + :param endpoint_name: str + Name of the vector search endpoint + :param min_qps: int (optional) + Min QPS for the endpoint. Positive integer sets QPS target; -1 resets to default scaling behavior. + + :returns: :class:`EndpointInfo` + parameters: + - name: endpoint_name + in: path + required: true + schema: + type: string + description: Name of the vector search endpoint + requestBody: + content: + application/json: + schema: + type: object + properties: + min_qps: + type: integer + description: >- + Min QPS for the endpoint. Positive integer sets QPS target; + -1 resets to default scaling behavior. + 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/{name}/metrics: post: operationId: vector_search_endpoints_retrieve_user_visible_metrics @@ -446,10 +507,19 @@ paths: - DELTA_SYNC - DIRECT_ACCESS description: >- - :param delta_sync_index_spec: - :class:`DeltaSyncVectorIndexSpecRequest` (optional) - Specification for Delta Sync Index. Required if `index_type` - is `DELTA_SYNC`. + There are 2 types of Vector Search indexes: - `DELTA_SYNC`: + An index that automatically syncs + + with a source Delta Table, automatically and incrementally + updating the index as the underlying + + data in the Delta Table changes. - `DIRECT_ACCESS`: An index + that supports direct read and write + + of vectors and metadata through our REST and SDK APIs. With + this model, the user manages index + + updates. delta_sync_index_spec: type: object properties: @@ -506,6 +576,9 @@ paths: source_table: type: string description: The name of the source table. + description: >- + Specification for Delta Sync Index. Required if `index_type` + is `DELTA_SYNC`. direct_access_index_spec: type: object properties: @@ -1306,6 +1379,17 @@ components: num_indexes: type: integer description: Number of indexes on the endpoint + scaling_info: + $ref: '#/components/schemas/EndpointScalingInfo' + description: Scaling information for the endpoint + EndpointScalingInfo: + type: object + properties: + requested_min_qps: + type: integer + state: + $ref: '#/components/schemas/ScalingChangeState' + description: The current state of the scaling change request. EndpointStatus: type: object properties: @@ -1611,20 +1695,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1670,6 +1754,49 @@ components: processes new data as it arrives in the source table to keep vector index fresh. + ScalingChangeState: + type: string + x-enum: + - SCALING_CHANGE_APPLIED + - SCALING_CHANGE_IN_PROGRESS + - SCALING_CHANGE_UNSPECIFIED + 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. UpsertDataStatus: type: string x-enum: @@ -1688,20 +1815,20 @@ components: Access them by: - - attribute access:: + - attribute access: - >>> Color.RED - + >>> Color.RED + - value lookup: - >>> Color(1) - + >>> Color(1) + - name lookup: - >>> Color['RED'] - + >>> Color['RED'] + Enumerations can be iterated over, and know how many members they have: @@ -1806,6 +1933,29 @@ components: delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' replace: [] + vector_search_endpoints: + id: databricks_workspace.vectorsearch.vector_search_endpoints + name: vector_search_endpoints + title: Vector Search Endpoints + methods: + vector_search_endpoints_patch_endpoint: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1api~12.0~1vector-search~1endpoints~1{endpoint_name}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vector_search_endpoints/methods/vector_search_endpoints_patch_endpoint + delete: [] + replace: [] indexes: id: databricks_workspace.vectorsearch.indexes name: indexes 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 d21f2c0b..3d75e16b 100644 --- a/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml +++ b/providers/src/databricks_workspace/v00.00.00000/services/workspace.yaml @@ -6,7 +6,7 @@ info: APIs), generated from the Databricks Python SDK. version: 0.1.0 x-stackql-sdk-version: 0.86.0 - x-stackql-date-generated: '2026-02-24' + x-stackql-date-generated: '2026-03-20' x-stackql-sdk-namespace: databricks.sdk.service.workspace servers: - url: https://{deployment_name}.cloud.databricks.com @@ -19,20 +19,16 @@ paths: post: operationId: git_credentials_create summary: >- - Creates a Git credential entry for the user. Only one Git credential per - user is supported, so any + Creates a Git credential entry for the user. Use the PATCH endpoint to + update existing credentials, or tags: - workspace - git_credentials description: >- - Creates a Git credential entry for the user. Only one Git credential per - user is supported, so any + Creates a Git credential entry for the user. Use the PATCH endpoint to + update existing credentials, or - attempts to create credentials if an entry already exists will fail. Use - the PATCH endpoint to update - - existing credentials, or the DELETE endpoint to delete existing - credentials. + the DELETE endpoint to delete existing credentials. :param git_provider: str @@ -838,7 +834,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`RepoPermissions`' responses: '200': description: Success @@ -912,7 +907,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`RepoPermissions`' responses: '200': description: Success @@ -2181,7 +2175,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`WorkspaceObjectPermissions`' responses: '200': description: Success @@ -2270,7 +2263,6 @@ paths: user_name: type: string description: name of the user - description: ':returns: :class:`WorkspaceObjectPermissions`' responses: '200': description: Success