diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index 60205f80aa8..d5de729c9af 100644 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -0a8a9c3e98b49cbd21bb5d6c859971d0406d2267 \ No newline at end of file +e13a7b6206adbdb6c4008e2a58b7cc785e32cb1c \ No newline at end of file diff --git a/.codegen/cli.json b/.codegen/cli.json index 603802a304a..7a6d7486e24 100644 --- a/.codegen/cli.json +++ b/.codegen/cli.json @@ -1693,60 +1693,60 @@ } }, "aifunctions.Batch": { - "description": "An asynchronous run of one AI function over a file of requests.", + "description": "The AI Functions Asynchronous API lets you process large volumes of requests as a batch in a single call.", "fields": { "create_time": { - "description": "Output only. Time the batch was created.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. The time when the batch was created.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "endpoint": { - "description": "The AI function to run for every request, for example `ai_extract`.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "The AI function, for example `ai_parse_document`.", + "launch_stage": "PUBLIC_BETA" }, "input_ref": { - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "launch_stage": "PUBLIC_BETA" }, "name": { - "description": "ID of the batch, in the form `batch_\u003cid\u003e`. The service assigns it.", - "launch_stage": "PRIVATE_PREVIEW" - }, - "output_ref": { - "description": "Path on a Unity Catalog volume to write the JSONL output to. When it is omitted, the output\nstays on Databricks-managed storage and a finished batch returns a short-lived download URL\nin this field instead.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. Identifier. Resource name of the batch, returned by create. Format: `batch_\u003cid\u003e`.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL" + "OUTPUT_ONLY" ] }, + "output_ref": { + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", + "launch_stage": "PUBLIC_BETA" + }, "params": { - "description": "Function options applied to every request in the batch, for example the extraction schema.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Parameters of the function other than its input, applied to every request in the batch, for example\n`schema` for `ai_extract`. Put function options, such as `version`, in a nested `options` object. For\nthe parameters of each function, see [AI Functions](/large-language-models/ai-functions).", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" ] }, "percent_complete": { - "description": "Output only. Percentage of the requests that finished, from 0 to 100. Returned when one batch\nis read, not when batches are listed.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. The percentage of requests that are processed, from 0 to 100. Returned when you get a batch, not when you\nlist batches.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "request_counts": { - "description": "Output only. Request counts. Returned when one batch is read, not when batches are listed.", + "description": "Output only. The number of requests in the batch, by result. Returned when you get a batch, not when you list\nbatches.", "ref": "aifunctions.BatchRequestCounts", - "launch_stage": "PRIVATE_PREVIEW", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "status": { - "description": "Output only. Status of the batch.", + "description": "Output only. The status of the batch.", "ref": "aifunctions.BatchStatus", - "launch_stage": "PRIVATE_PREVIEW", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] @@ -1757,22 +1757,22 @@ "description": "Counts of the requests in a batch.", "fields": { "failed": { - "description": "Output only. Number of requests that failed and will not be retried.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. The number of requests that failed. The service does not retry them.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "succeeded": { - "description": "Output only. Number of requests that finished successfully.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. The number of requests that were processed successfully.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "total": { - "description": "Output only. Number of requests in the input file.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "Output only. The number of requests in the batch.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] @@ -1786,20 +1786,18 @@ "IN_PROGRESS", "FINALIZING", "COMPLETED", - "EXPIRED", "CANCELLING", "CANCELLED", "FAILED" ], "enum_launch_stages": { - "CANCELLED": "PRIVATE_PREVIEW", - "CANCELLING": "PRIVATE_PREVIEW", - "COMPLETED": "PRIVATE_PREVIEW", - "EXPIRED": "PRIVATE_PREVIEW", - "FAILED": "PRIVATE_PREVIEW", - "FINALIZING": "PRIVATE_PREVIEW", - "IN_PROGRESS": "PRIVATE_PREVIEW", - "PENDING": "PRIVATE_PREVIEW" + "CANCELLED": "PUBLIC_BETA", + "CANCELLING": "PUBLIC_BETA", + "COMPLETED": "PUBLIC_BETA", + "FAILED": "PUBLIC_BETA", + "FINALIZING": "PUBLIC_BETA", + "IN_PROGRESS": "PUBLIC_BETA", + "PENDING": "PUBLIC_BETA" } }, "aifunctions.CancelBatchRequest": {}, @@ -1809,7 +1807,7 @@ "batch": { "description": "The batch to create.", "ref": "aifunctions.Batch", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" } } }, @@ -1818,14 +1816,14 @@ "fields": { "page_size": { "description": "Maximum number of batches to return in one page.", - "launch_stage": "PRIVATE_PREVIEW", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "Page token from an earlier response. Omit it to read the first page.", - "launch_stage": "PRIVATE_PREVIEW", + "description": "A page token from a previous call to list batches. Omit it to get the first page.", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" ] @@ -1836,11 +1834,11 @@ "fields": { "batches": { "description": "The batches in this page.", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "next_page_token": { - "description": "Token that reads the next page. It is empty on the last page.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "A token to get the next page. It is empty on the last page.", + "launch_stage": "PUBLIC_BETA" } } }, @@ -3081,6 +3079,13 @@ "OUTPUT_ONLY" ] }, + "effective_resources": { + "description": "Resources added to the app, plus the resources it inherits from its space.\nEmpty for apps that are not in a space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "effective_usage_policy_id": { "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -30109,6 +30114,19 @@ } } }, + "iam.CreateRestrictedSharingGroupRequest": { + "fields": { + "restricted_sharing_group": { + "description": "The restricted sharing group to create. It has no client-set fields; the\ngroup is identified by restricted_sharing_group_id.", + "ref": "iam.RestrictedSharingGroup", + "launch_stage": "PRIVATE_PREVIEW" + }, + "restricted_sharing_group_id": { + "description": "The id of the workspace group to restrict: the numeric id of an existing and\nnon-system workspace group.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "iam.CreateServicePrincipalRequest": { "fields": { "active": { @@ -30198,6 +30216,7 @@ "iam.DeleteAccountServicePrincipalRequest": {}, "iam.DeleteAccountUserRequest": {}, "iam.DeleteGroupRequest": {}, + "iam.DeleteRestrictedSharingGroupRequest": {}, "iam.DeleteServicePrincipalRequest": {}, "iam.DeleteUserRequest": {}, "iam.DeleteWorkspaceAssignmentRequest": {}, @@ -30273,6 +30292,7 @@ } }, "iam.GetPermissionRequest": {}, + "iam.GetRestrictedSharingGroupRequest": {}, "iam.GetRuleSetRequest": { "fields": { "etag": { @@ -30613,6 +30633,37 @@ "urn:ietf:params:scim:api:messages:2.0:ListResponse": "PUBLIC_PREVIEW" } }, + "iam.ListRestrictedSharingGroupsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of groups to return. The service may return fewer.\nIf unspecified or 0, at most 100 groups are returned. Values above 100 are\ncoerced to 100. Negative values are rejected.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token from a previous ListRestrictedSharingGroups call. Provide\nthis to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "iam.ListRestrictedSharingGroupsResponse": { + "description": "A page of restricted sharing groups in the caller's workspace.", + "fields": { + "next_page_token": { + "description": "A token that can be sent as page_token to retrieve the next page. If this\nfield is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "restricted_sharing_groups": { + "description": "The restricted sharing groups in the workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "iam.ListServicePrincipalResponse": { "fields": { "Resources": { @@ -31185,6 +31236,29 @@ } } }, + "iam.RestrictedSharingGroup": { + "description": "A RestrictedSharingGroup is a workspace group whose members cannot grant or\nrevoke permissions on workspace assets while they have assumed the group or\none of its child groups. Users acting as themselves are not affected.", + "fields": { + "group_display_name": { + "description": "The display name of the restricted workspace group.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The resource name of the restricted sharing group.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`\nExample: `restricted-sharing-groups/123`", + "launch_stage": "PRIVATE_PREVIEW" + }, + "restricted_sharing_group_id": { + "description": "The id of the restricted workspace group: the numeric id of an existing and\nnon-system workspace group.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "iam.Role": { "fields": { "name": { @@ -40954,7 +41028,7 @@ ] }, "batch": { - "description": "Batch SQL rule input.", + "description": "Scheduled detection (also known as batch detection) input.", "ref": "lakewatch.RuleInputBatch", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -40976,7 +41050,7 @@ ] }, "compute_workspace_id": { - "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled rule runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", + "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled detection runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -41170,7 +41244,7 @@ ] }, "timerange": { - "description": "Time-range configuration for batch rules. If unset, the execution time range is extended by\na fixed `15m` lookback.", + "description": "Time-range configuration for scheduled detections. If unset, the execution time range is\nextended by a fixed `15m` lookback.", "ref": "lakewatch.RuleTimeRange", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -41308,7 +41382,7 @@ } }, "lakewatch.RuleInputBatch": { - "description": "Batch input for a detection rule.", + "description": "Input for a scheduled detection (also known as batch detection).", "fields": { "custom": { "description": "Custom-notebook user function. The output is used as input data for the\nrule.", @@ -41327,7 +41401,7 @@ ] }, "warehouse_id": { - "description": "SQL warehouse used to run this batch rule.", + "description": "SQL warehouse that runs this scheduled detection.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -41336,7 +41410,7 @@ } }, "lakewatch.RuleInputBatchSql": { - "description": "Batch SQL input for a detection rule.", + "description": "SQL query input for a scheduled detection.", "fields": { "default_catalog_name": { "description": "Default catalog used to resolve unqualified identifiers in `query`. If\nunset, the rule's `catalog_name` is used.", @@ -41359,7 +41433,7 @@ } }, "lakewatch.RuleInputCustomNotebook": { - "description": "Reference to a custom-user-function notebook for stream or batch input.", + "description": "Reference to a custom-user-function notebook for scheduled detection input.", "fields": { "notebook": { "description": "Fully-qualified notebook path, or a path relative to the configured base\nnotebook directory.", @@ -41437,7 +41511,7 @@ } }, "lakewatch.RuleSchedule": { - "description": "Defines when a detection rule executes.\n\nA batch rule sets exactly one of `at_least_every` or `cron_expression`. A streaming rule runs\ncontinuously and sets no timing; it accepts only `enabled`, and an omitted schedule means\nenabled. The server rejects any other combination. `enabled` is orthogonal to the timing.", + "description": "Defines when a detection rule executes.\n\nA scheduled detection sets exactly one of `at_least_every` or `cron_expression`. A streaming\nrule runs continuously and sets no timing; it accepts only `enabled`, and an omitted schedule\nmeans enabled. The server rejects any other combination. `enabled` is orthogonal to the timing.", "fields": { "at_least_every": { "description": "Defines the minimum cadence as a duration string. It may contain components\nfor days, hours, minutes, and seconds (e.g. `5d`, `5d3h`, `3d2h5m12s`,\n`12m16s`).", @@ -41446,13 +41520,6 @@ "OPTIONAL" ] }, - "continuous": { - "description": "Runs the rule continuously. Detection rules do not accept it: batch rules reject it, and\nstreaming rules run continuously without it.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "OPTIONAL" - ] - }, "cron_expression": { "description": "Defines the schedule using a Quartz cron expression.", "launch_stage": "PUBLIC_BETA", @@ -41470,10 +41537,10 @@ } }, "lakewatch.RuleTimeRange": { - "description": "Time-range configuration for a batch detection rule.", + "description": "Time-range configuration for a scheduled detection.", "fields": { "extend_lookback": { - "description": "Extends the start of the execution time range by a compact duration with integer\ndays, hours, minutes, and seconds in that order, such as `1h30m` or `15m`.\nZero duration disables extension. Unset or empty uses a fixed `15m` at execution\ntime. Only the start moves; the end is unchanged. Has no effect on batch SQL\nthat does not use `IN_TIMERANGE`. Values must fit signed 64-bit microseconds.", + "description": "Extends the start of the execution time range by a compact duration with integer\ndays, hours, minutes, and seconds in that order, such as `1h30m` or `15m`.\nZero duration disables extension. Unset or empty uses a fixed `15m` at execution\ntime. Only the start moves; the end is unchanged. Has no effect on a detection\nquery that does not use `IN_TIMERANGE`. Values must fit signed 64-bit microseconds.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -44852,7 +44919,7 @@ ] }, "filter_condition": { - "description": "Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", + "description": "A single WHERE clause to filter the Delta table before applying transformations.\nThe predicate is evaluated for each row.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -44870,7 +44937,7 @@ ] }, "transformation_sql": { - "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", + "description": "A single SQL SELECT expression applied after filter_condition.\nThe expression must contain all required columns (e.g., \"*, col_a + col_b AS col_c\").\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -55973,7 +56040,7 @@ "launch_stage": "GA" }, "database_id": { - "description": "The ID to use for the Database, which will become the final component of\nthe database's resource name.\nThis ID becomes the database name in postgres.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -56052,7 +56119,7 @@ "launch_stage": "GA" }, "role_id": { - "description": "The ID to use for the Role, which will become the final component of\nthe role's resource name.\nThis ID becomes the role in Postgres.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -56372,7 +56439,7 @@ ] }, "role": { - "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nA database always has an owner.", + "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", "launch_stage": "GA" } } @@ -58199,7 +58266,7 @@ ] }, "auth_method": { - "description": "Controls how the Postgres role authenticates when a client opens a database\nconnection. Supported values:\n\n* LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks\nOAuth access token derived from the backing managed identity (the\nDatabricks user, service principal, or group named by the role's\n`postgres_role`). No static password exists for roles using this method.\n* PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres\npassword verified server-side using the SCRAM-SHA-256 mechanism.\nLakebase generates a password for the role.\n* NO_LOGIN: the role cannot open a Postgres session at all. Useful for\nroles that exist only to own objects or to aggregate privileges that\nare then granted to other, loginable roles.\n\nIf auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:\n* For the managed identities, OAUTH is used.\n* For the regular postgres roles, authentication based on postgres passwords is used.\n\nNOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1\nis the default auth method (group can login as well).\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", + "description": "Controls how the Postgres role authenticates when a client opens a database\nconnection. Supported values:\n\n* LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks\nOAuth access token derived from the backing managed identity (the\nDatabricks user, service principal, or group named by the role's\n`postgres_role`). No static password exists for roles using this method.\n* PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres\npassword verified server-side using the SCRAM-SHA-256 mechanism.\nLakebase generates a password for the role.\n\nNO_LOGIN is not currently supported for Role creation.\n\nIf auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:\n* For the managed identities, OAUTH is used.\n* For the regular postgres roles, authentication based on postgres passwords is used.\n\nNOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1\nis the default auth method (group can login as well).\n\nThis value cannot be changed after creation.", "ref": "postgres.RoleAuthMethod", "launch_stage": "GA", "behaviors": [ @@ -58208,7 +58275,7 @@ ] }, "identity_type": { - "description": "The type of role.\nWhen specifying a managed-identity, the chosen role_id must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", + "description": "The type of role.\nWhen specifying a managed-identity, the chosen postgres_role must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis value cannot be changed after creation.", "ref": "postgres.RoleIdentityType", "launch_stage": "GA", "behaviors": [ @@ -58217,14 +58284,14 @@ ] }, "membership_roles": { - "description": "An enum value for a standard role that this role is a member of.", + "description": "An enum value for a standard role that this role is a member of.\nWhen selected in update_mask, this field replaces all existing memberships.\nAn empty or omitted list clears all memberships, including DATABRICKS_SUPERUSER.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "postgres_role": { - "description": "The name of the Postgres role.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\n\nRequired when creating the Role.\n\nIf you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role\nmust be one of the following:\n\n1. user email for IdentityType.USER\n2. app ID for IdentityType.SERVICE_PRINCIPAL\n2. group name for IdentityType.GROUP\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", + "description": "The name of the Postgres role.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\n\nRequired when creating the Role.\n\nIf you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role\nmust be one of the following:\n\n1. user email for IdentityType.USER\n2. app ID for IdentityType.SERVICE_PRINCIPAL\n2. group name for IdentityType.GROUP\n\nThis value cannot be changed after creation.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -61155,6 +61222,7 @@ "launch_stage": "GA" }, "state": { + "description": "The state of the inference table.", "ref": "serving.AutoCaptureState", "launch_stage": "GA" }, @@ -61167,6 +61235,7 @@ "serving.AutoCaptureState": { "fields": { "payload_table": { + "description": "The payload table that stores the logged requests and responses.", "ref": "serving.PayloadTable", "launch_stage": "GA" } @@ -61312,6 +61381,7 @@ "launch_stage": "GA" }, "description": { + "description": "The description of the serving endpoint.", "launch_stage": "GA" }, "email_notifications": { @@ -61532,7 +61602,7 @@ "launch_stage": "GA" }, "start_time": { - "description": "The timestamp when the update to the pending config started.", + "description": "The timestamp when the update to the pending config started, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "traffic_config": { @@ -61595,6 +61665,7 @@ "serving.EndpointTags": { "fields": { "tags": { + "description": "The tags attached to the serving endpoint after the update.", "launch_stage": "GA" } } @@ -61771,15 +61842,19 @@ "description": "All fields are not sensitive as they are hard-coded in the system and made available to customers.", "fields": { "description": { + "description": "A description of the foundation model.", "launch_stage": "PUBLIC_PREVIEW" }, "display_name": { + "description": "The human-readable display name of the foundation model.", "launch_stage": "PUBLIC_PREVIEW" }, "docs": { + "description": "The URL of the Databricks documentation page for the foundation model.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { + "description": "The name of the foundation model.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -61948,12 +62023,15 @@ "serving.PayloadTable": { "fields": { "name": { + "description": "The name of the payload table within the configured catalog and schema.", "launch_stage": "GA" }, "status": { + "description": "The status of the payload table. One of PENDING, READY, FAILED or DISABLED.", "launch_stage": "GA" }, "status_message": { + "description": "More information about the status of the payload table, if available.", "launch_stage": "GA" } } @@ -61965,6 +62043,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "traffic_config": { + "description": "The traffic configuration associated with the serving endpoint config.", "ref": "serving.TrafficConfig", "launch_stage": "PUBLIC_PREVIEW" } @@ -61981,6 +62060,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "entity_version": { + "description": "The version of the model in Unity Catalog to be served.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { @@ -62229,6 +62309,7 @@ "serving.Route": { "fields": { "served_entity_name": { + "description": "The name of the served entity this route configures traffic for.", "launch_stage": "GA" }, "served_model_name": { @@ -62255,6 +62336,7 @@ "launch_stage": "GA" }, "entity_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function.", "launch_stage": "GA" }, "environment_vars": { @@ -62319,9 +62401,11 @@ ] }, "creation_timestamp": { + "description": "The timestamp when the served entity was created, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "creator": { + "description": "The email of the user who created the served entity.", "launch_stage": "GA" }, "entity_name": { @@ -62329,6 +62413,7 @@ "launch_stage": "GA" }, "entity_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function.", "launch_stage": "GA" }, "environment_vars": { @@ -62341,6 +62426,7 @@ "launch_stage": "GA" }, "foundation_model": { + "description": "The foundation model that is served. Present for served entities that serve a Databricks-hosted foundation model.", "ref": "serving.FoundationModel", "launch_stage": "PUBLIC_PREVIEW" }, @@ -62377,6 +62463,7 @@ "launch_stage": "GA" }, "state": { + "description": "Information corresponding to the state of the served entity.", "ref": "serving.ServedModelState", "launch_stage": "GA" }, @@ -62394,20 +62481,25 @@ "serving.ServedEntitySpec": { "fields": { "entity_name": { + "description": "The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object is given in the form of **catalog_name.schema_name.model_name**.", "launch_stage": "GA" }, "entity_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function.", "launch_stage": "GA" }, "external_model": { + "description": "The external model that is served. NOTE: Only one of external_model, foundation_model, and (entity_name, entity_version) is returned based on the endpoint type.", "ref": "serving.ExternalModel", "launch_stage": "GA" }, "foundation_model": { + "description": "The foundation model that is served. NOTE: Only one of foundation_model, external_model, and (entity_name, entity_version) is returned based on the endpoint type.", "ref": "serving.FoundationModel", "launch_stage": "PUBLIC_PREVIEW" }, "name": { + "description": "The name of the served entity.", "launch_stage": "GA" } } @@ -62446,9 +62538,11 @@ "launch_stage": "GA" }, "model_name": { + "description": "The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**.", "launch_stage": "GA" }, "model_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served.", "launch_stage": "GA" }, "name": { @@ -62509,9 +62603,11 @@ ] }, "creation_timestamp": { + "description": "The timestamp when the served entity was created, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "creator": { + "description": "The email of the user who created the served entity.", "launch_stage": "GA" }, "environment_vars": { @@ -62531,9 +62627,11 @@ "launch_stage": "GA" }, "model_name": { + "description": "The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**.", "launch_stage": "GA" }, "model_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served.", "launch_stage": "GA" }, "name": { @@ -62549,6 +62647,7 @@ "launch_stage": "GA" }, "state": { + "description": "Information corresponding to the state of the served entity.", "ref": "serving.ServedModelState", "launch_stage": "GA" }, @@ -62566,14 +62665,15 @@ "serving.ServedModelSpec": { "fields": { "model_name": { - "description": "Only one of model_name and entity_name should be populated", + "description": "The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**.", "launch_stage": "GA" }, "model_version": { - "description": "Only one of model_version and entity_version should be populated", + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served.", "launch_stage": "GA" }, "name": { + "description": "The name of the served entity.", "launch_stage": "GA" } } @@ -62581,10 +62681,12 @@ "serving.ServedModelState": { "fields": { "deployment": { + "description": "The state of the deployment of the served entity. DEPLOYMENT_CREATING indicates that the served entity is not ready yet because the deployment is still being created (for example, the container image is building or the model server is starting for the first time). DEPLOYMENT_RECOVERING indicates that the served entity was previously ready but no longer is and is attempting to recover. DEPLOYMENT_READY indicates that the served entity is ready to receive traffic. DEPLOYMENT_FAILED indicates that there was an error bringing up the served entity (for example, the container image build failed or the model server failed to start due to a model loading error). DEPLOYMENT_ABORTED indicates that the deployment was terminated, likely due to a failure in bringing up another served entity under the same endpoint and config version.", "ref": "serving.ServedModelStateDeployment", "launch_stage": "GA" }, "deployment_state_message": { + "description": "More information about the state of the served entity, if available.", "launch_stage": "GA" } } @@ -62630,7 +62732,7 @@ "launch_stage": "GA" }, "creation_timestamp": { - "description": "The timestamp when the endpoint was created in Unix time.", + "description": "The timestamp when the endpoint was created, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "creator": { @@ -62646,7 +62748,7 @@ "launch_stage": "GA" }, "last_updated_timestamp": { - "description": "The timestamp when the endpoint was last updated by a user in Unix time.", + "description": "The timestamp when the endpoint was last updated by a user, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "name": { @@ -62738,7 +62840,7 @@ "launch_stage": "GA" }, "creation_timestamp": { - "description": "The timestamp when the endpoint was created in Unix time.", + "description": "The timestamp when the endpoint was created, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "creator": { @@ -62751,7 +62853,7 @@ "launch_stage": "GA" }, "description": { - "description": "Description of the serving model", + "description": "Description of the serving endpoint.", "launch_stage": "GA" }, "email_notifications": { @@ -62768,7 +62870,7 @@ "launch_stage": "GA" }, "last_updated_timestamp": { - "description": "The timestamp when the endpoint was last updated by a user in Unix time.", + "description": "The timestamp when the endpoint was last updated by a user, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "name": { @@ -62992,10 +63094,12 @@ "serving.UpdateInferenceEndpointNotificationsResponse": { "fields": { "email_notifications": { + "description": "The email notification settings now in effect for the serving endpoint.", "ref": "serving.EmailNotifications", "launch_stage": "GA" }, "name": { + "description": "The name of the serving endpoint whose notification settings were updated.", "launch_stage": "GA" } } @@ -63003,6 +63107,7 @@ "serving.UpdateProvisionedThroughputEndpointConfigRequest": { "fields": { "config": { + "description": "The core config of the serving endpoint.", "ref": "serving.PtEndpointCoreConfig", "launch_stage": "PUBLIC_PREVIEW" } @@ -70391,6 +70496,7 @@ } }, "sql.AlertV2": { + "description": "A SQL alert. An alert runs a query on a schedule, evaluates the result against a condition,\nand notifies users or notification destinations when the condition is met.", "fields": { "create_time": { "description": "The timestamp indicating when the alert was created.", @@ -70400,14 +70506,14 @@ ] }, "custom_description": { - "description": "Custom description for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`.\nThe available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "custom_summary": { - "description": "Custom summary for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -70434,6 +70540,7 @@ ] }, "evaluation": { + "description": "Condition evaluated against the query result, and who is notified when it is met.", "ref": "sql.AlertV2Evaluation", "launch_stage": "GA" }, @@ -70445,7 +70552,7 @@ ] }, "lifecycle_state": { - "description": "Indicates whether the query is trashed.", + "description": "Indicates whether the alert is active (`ACTIVE`) or has been moved to the trash (`DELETED`).", "ref": "sql.AlertLifecycleState", "launch_stage": "GA", "behaviors": [ @@ -70487,7 +70594,7 @@ ] }, "run_as_user_name": { - "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "description": "Deprecated: Use `run_as` field instead. This field will be removed in a future release.\nThe run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.", "deprecated": true, "launch_stage": "GA", "behaviors": [ @@ -70495,6 +70602,7 @@ ] }, "schedule": { + "description": "Schedule on which the alert runs its query and evaluates the condition.", "ref": "sql.CronSchedule", "launch_stage": "GA" }, @@ -70514,12 +70622,12 @@ "sql.AlertV2Evaluation": { "fields": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", + "description": "Operator used for comparison in alert evaluation. The alert is triggered when the comparison of the source value with the threshold is true. `IS_NULL` and `IS_NOT_NULL` take no threshold.", "ref": "sql.ComparisonOperator", "launch_stage": "GA" }, "empty_result_state": { - "description": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", + "description": "Alert state if result is empty. If not set, an empty result sets the state to `ERROR`. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", "ref": "sql.AlertEvaluationState", "launch_stage": "GA", "behaviors": [ @@ -70547,7 +70655,7 @@ "launch_stage": "GA" }, "state": { - "description": "Latest state of alert evaluation.", + "description": "Latest state of alert evaluation: `TRIGGERED` when the condition was met, `OK` when it was not, and `ERROR` when the evaluation failed.", "ref": "sql.AlertEvaluationState", "launch_stage": "GA", "behaviors": [ @@ -70555,7 +70663,7 @@ ] }, "threshold": { - "description": "Threshold to user for alert evaluation, can be a column or a value.", + "description": "Threshold to compare the source column against, either another column or a fixed value. Not needed when `comparison_operator` is `IS_NULL` or `IS_NOT_NULL`.", "ref": "sql.AlertV2Operand", "launch_stage": "GA", "behaviors": [ @@ -70581,6 +70689,7 @@ ] }, "subscriptions": { + "description": "Users and notification destinations that receive notifications.", "launch_stage": "GA", "behaviors": [ "OPTIONAL", @@ -70592,6 +70701,7 @@ "sql.AlertV2Operand": { "fields": { "column": { + "description": "Compare the source against another column of the query result.", "ref": "sql.AlertV2OperandColumn", "launch_stage": "GA", "behaviors": [ @@ -70599,6 +70709,7 @@ ] }, "value": { + "description": "Compare the source against a fixed value.", "ref": "sql.AlertV2OperandValue", "launch_stage": "GA", "behaviors": [ @@ -70610,7 +70721,7 @@ "sql.AlertV2OperandColumn": { "fields": { "aggregation": { - "description": "If not set, the behavior is equivalent to using `First row` in the UI.", + "description": "Aggregation applied to the column across all rows of the query result: `SUM`, `COUNT`, `COUNT_DISTINCT`, `AVG`, `MEDIAN`, `MIN`, `MAX` or `STDDEV`.\nIf not set, the value in the first row is used, which is equivalent to using `First row` in the UI.", "ref": "sql.Aggregation", "launch_stage": "GA", "behaviors": [ @@ -70618,12 +70729,14 @@ ] }, "display": { + "description": "Label for the column in notifications. Defaults to `name`.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "name": { + "description": "Name of the column in the query result.", "launch_stage": "GA" } } @@ -70631,18 +70744,21 @@ "sql.AlertV2OperandValue": { "fields": { "bool_value": { + "description": "Boolean threshold, for boolean columns.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "double_value": { + "description": "Numeric threshold, for numeric columns.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "string_value": { + "description": "String threshold, for string or timestamp columns.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -70671,9 +70787,11 @@ "sql.AlertV2Subscription": { "fields": { "destination_id": { + "description": "ID of the notification destination to notify, as returned by the Notification Destinations API.", "launch_stage": "GA" }, "user_email": { + "description": "Email address of the workspace user to notify.", "launch_stage": "GA" } } @@ -71217,7 +71335,7 @@ "sql.CronSchedule": { "fields": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "description": "Indicates whether this schedule is paused. While paused, the alert is not evaluated.", "ref": "sql.SchedulePauseStatus", "launch_stage": "GA", "behaviors": [ @@ -71225,7 +71343,7 @@ ] }, "quartz_cron_schedule": { - "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", + "description": "A cron expression using quartz syntax that specifies the schedule for this alert.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", "launch_stage": "GA" }, "timezone_id": { @@ -72575,12 +72693,14 @@ "sql.ListAlertsV2Request": { "fields": { "page_size": { + "description": "Maximum number of alerts to return per page. Values above 100 are coerced to 100.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { + "description": "Page token returned as `next_page_token` by a previous call. Omit it to retrieve the first page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -74581,7 +74701,7 @@ "launch_stage": "GA" }, "update_mask": { - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the alert fields to update, for example `display_name,query_text` or `schedule.pause_status`.\nOnly the listed fields are changed; all other fields keep their current values. `parent_path` cannot be updated.", "launch_stage": "GA" } } @@ -84539,20 +84659,21 @@ }, { "name": "CancelBatch", - "description": "Cancel a batch. Cancellation is asynchronous: requests in flight drain first, so read the batch to observe the `CANCELLING` and `CANCELLED` statuses.", + "description": "Starts the asynchronous cancellation of a batch. Requests in progress are drained first. Cancellation is best effort, so the batch can still complete.", "summary": "Cancel a batch.", "path": "/api/2.0/ai-functions/batches/{name}/cancel", - "is_hidden_cli": true, "has_required_positional_arguments": true, - "launch_stage": "PRIVATE_PREVIEW", - "cli_launch_stage_display": "Private Preview", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", "request": { "pascal_name": "CancelBatchRequest", "is_object": true, "required_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84563,7 +84684,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84579,7 +84700,7 @@ "all_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84590,7 +84711,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84601,15 +84722,16 @@ }, { "name": "CreateBatch", - "description": "Run an AI function over every request in a file on a Unity Catalog volume. The batch runs asynchronously; read it to follow its progress.", + "description": "Creates a batch that runs an AI function on every request in a JSONL file on a Unity Catalog volume. The batch runs asynchronously. To follow its progress, get the batch.", "summary": "Create a batch.", "path": "/api/2.0/ai-functions/batches", "can_use_json": true, "is_crud_create": true, - "is_hidden_cli": true, "has_required_positional_arguments": true, - "launch_stage": "PRIVATE_PREVIEW", - "cli_launch_stage_display": "Private Preview", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", "request": { "pascal_name": "CreateBatchRequest", "is_object": true, @@ -84651,7 +84773,7 @@ "required_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84660,7 +84782,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84671,7 +84802,7 @@ "required_request_body_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84680,7 +84811,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84697,7 +84837,7 @@ "required_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84706,7 +84846,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84717,7 +84866,7 @@ "required_request_body_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84726,7 +84875,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84748,7 +84906,7 @@ "required_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84757,7 +84915,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84768,7 +84935,7 @@ "required_request_body_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84777,7 +84944,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84789,7 +84965,7 @@ }, { "name": "create_time", - "description": "Output only. Time the batch was created.", + "description": "Output only. The time when the batch was created.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -84799,7 +84975,7 @@ }, { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84808,7 +84984,7 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", "required": true, "is_request_body_field": true, "entity": { @@ -84817,7 +84993,8 @@ }, { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`. The service assigns it.", + "description": "Output only. Identifier. Resource name of the batch, returned by create. Format: `batch_\u003cid\u003e`.", + "is_output_only": true, "is_request_body_field": true, "entity": { "is_string": true @@ -84825,7 +85002,8 @@ }, { "name": "output_ref", - "description": "Path on a Unity Catalog volume to write the JSONL output to. When it is omitted, the output\nstays on Databricks-managed storage and a finished batch returns a short-lived download URL\nin this field instead.", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", + "required": true, "is_request_body_field": true, "entity": { "is_string": true @@ -84833,7 +85011,7 @@ }, { "name": "params", - "description": "Function options applied to every request in the batch, for example the extraction schema.", + "description": "Parameters of the function other than its input, applied to every request in the batch, for example\n`schema` for `ai_extract`. Put function options, such as `version`, in a nested `options` object. For\nthe parameters of each function, see [AI Functions](/large-language-models/ai-functions).", "is_request_body_field": true, "entity": { "map_value": {} @@ -84841,7 +85019,7 @@ }, { "name": "percent_complete", - "description": "Output only. Percentage of the requests that finished, from 0 to 100. Returned when one batch\nis read, not when batches are listed.", + "description": "Output only. The percentage of requests that are processed, from 0 to 100. Returned when you get a batch, not when you\nlist batches.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -84850,7 +85028,7 @@ }, { "name": "request_counts", - "description": "Output only. Request counts. Returned when one batch is read, not when batches are listed.", + "description": "Output only. The number of requests in the batch, by result. Returned when you get a batch, not when you list\nbatches.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -84861,7 +85039,7 @@ }, { "name": "status", - "description": "Output only. Status of the batch.", + "description": "Output only. The status of the batch.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -84876,9 +85054,6 @@ { "content": "COMPLETED" }, - { - "content": "EXPIRED" - }, { "content": "FAILED" }, @@ -84898,7 +85073,7 @@ "required_positional_arguments": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84907,7 +85082,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84918,21 +85102,22 @@ }, { "name": "GetBatch", - "description": "Read one batch, with its status and progress.", + "description": "Gets the latest status and progress of a batch.", "summary": "Get a batch.", "path": "/api/2.0/ai-functions/batches/{name}", "is_crud_read": true, - "is_hidden_cli": true, "has_required_positional_arguments": true, - "launch_stage": "PRIVATE_PREVIEW", - "cli_launch_stage_display": "Private Preview", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", "request": { "pascal_name": "GetBatchRequest", "is_object": true, "required_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84943,7 +85128,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -84959,7 +85144,7 @@ "required_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84968,7 +85153,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -84979,7 +85173,7 @@ "required_request_body_fields": [ { "name": "endpoint", - "description": "The AI function to run for every request, for example `ai_extract`.", + "description": "The AI function, for example `ai_parse_document`.", "required": true, "is_request_body_field": true, "entity": { @@ -84988,7 +85182,16 @@ }, { "name": "input_ref", - "description": "Path of the JSONL input file on a Unity Catalog volume. Each line is one request.", + "description": "Unity Catalog volume path of the JSONL input file. Each line is one request, in the form `{\"custom_id\": ..., \"body\": ...}`. The file can hold up to 50,000 requests and be up to 200 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_ref", + "description": "Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the file is `\u003cpath\u003e/\u003cname\u003e_output.jsonl`.", "required": true, "is_request_body_field": true, "entity": { @@ -85000,7 +85203,7 @@ "all_fields": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -85011,7 +85214,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "ID of the batch, in the form `batch_\u003cid\u003e`.", + "description": "Resource name of the batch. Format: `batch_\u003cid\u003e`.", "required": true, "is_path": true, "entity": { @@ -85022,13 +85225,14 @@ }, { "name": "ListBatches", - "description": "List the batches the caller created in this workspace.", + "description": "Lists the batches that the caller created in this workspace.", "summary": "List batches.", "path": "/api/2.0/ai-functions/batches", - "is_hidden_cli": true, "has_required_positional_arguments": true, - "launch_stage": "PRIVATE_PREVIEW", - "cli_launch_stage_display": "Private Preview", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", "request": { "pascal_name": "ListBatchesRequest", "is_object": true @@ -85048,7 +85252,7 @@ }, { "name": "page_token", - "description": "Page token from an earlier response. Omit it to read the first page.", + "description": "A page token from a previous call to list batches. Omit it to get the first page.", "is_query": true, "entity": { "is_string": true @@ -85059,7 +85263,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "Page token from an earlier response. Omit it to read the first page.", + "description": "A page token from a previous call to list batches. Omit it to get the first page.", "is_query": true, "entity": { "is_string": true @@ -91866,7 +92070,7 @@ "methods": [ { "name": "CreateAlert", - "description": "Create Alert", + "description": "Creates an alert that runs `query_text` on the given schedule and evaluates the result against the configured condition.", "summary": "Create an alert.", "path": "/api/2.0/alerts", "can_use_json": true, @@ -91939,6 +92143,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -91948,6 +92153,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -91986,6 +92192,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -91995,6 +92202,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92039,6 +92247,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92048,6 +92257,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92086,6 +92296,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92095,6 +92306,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92143,6 +92355,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92152,6 +92365,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92190,6 +92404,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92199,6 +92414,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92220,7 +92436,7 @@ }, { "name": "custom_description", - "description": "Custom description for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`.\nThe available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates.", "is_request_body_field": true, "entity": { "is_string": true @@ -92228,7 +92444,7 @@ }, { "name": "custom_summary", - "description": "Custom summary for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`.", "is_request_body_field": true, "entity": { "is_string": true @@ -92272,6 +92488,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92290,7 +92507,7 @@ }, { "name": "lifecycle_state", - "description": "Indicates whether the query is trashed.", + "description": "Indicates whether the alert is active (`ACTIVE`) or has been moved to the trash (`DELETED`).", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -92355,7 +92572,7 @@ }, { "name": "run_as_user_name", - "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "description": "Deprecated: Use `run_as` field instead. This field will be removed in a future release.\nThe run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.", "is_request_body_field": true, "entity": { "is_string": true @@ -92363,6 +92580,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92419,6 +92637,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92428,6 +92647,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92452,6 +92672,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the alert to retrieve, as returned in the alert's `id` field.", "required": true, "is_path": true, "entity": { @@ -92462,6 +92683,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the alert to retrieve, as returned in the alert's `id` field.", "required": true, "is_path": true, "entity": { @@ -92504,6 +92726,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92513,6 +92736,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92551,6 +92775,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92560,6 +92785,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92572,6 +92798,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the alert to retrieve, as returned in the alert's `id` field.", "required": true, "is_path": true, "entity": { @@ -92582,6 +92809,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the alert to retrieve, as returned in the alert's `id` field.", "required": true, "is_path": true, "entity": { @@ -92609,6 +92837,7 @@ "all_fields": [ { "name": "page_size", + "description": "Maximum number of alerts to return per page. Values above 100 are coerced to 100.", "is_query": true, "entity": { "is_int": true @@ -92616,6 +92845,7 @@ }, { "name": "page_token", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to retrieve the first page.", "is_query": true, "entity": { "is_string": true @@ -92626,6 +92856,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to retrieve the first page.", "is_query": true, "entity": { "is_string": true @@ -92648,6 +92879,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the alert to move to the trash.", "required": true, "is_path": true, "entity": { @@ -92658,6 +92890,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the alert to move to the trash.", "required": true, "is_path": true, "entity": { @@ -92674,6 +92907,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the alert to move to the trash.", "required": true, "is_path": true, "entity": { @@ -92692,6 +92926,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the alert to move to the trash.", "required": true, "is_path": true, "entity": { @@ -92702,7 +92937,7 @@ }, { "name": "UpdateAlert", - "description": "Update alert", + "description": "Updates an alert. Only the fields listed in `update_mask` are changed; all other fields keep their current values.", "summary": "Update an alert.", "path": "/api/2.0/alerts/{id}", "can_use_json": true, @@ -92735,7 +92970,7 @@ }, { "name": "update_mask", - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the alert fields to update, for example `display_name,query_text` or `schedule.pause_status`.\nOnly the listed fields are changed; all other fields keep their current values. `parent_path` cannot be updated.", "required": true, "is_query": true, "entity": { @@ -92756,7 +92991,7 @@ }, { "name": "update_mask", - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the alert fields to update, for example `display_name,query_text` or `schedule.pause_status`.\nOnly the listed fields are changed; all other fields keep their current values. `parent_path` cannot be updated.", "required": true, "is_query": true, "entity": { @@ -92814,6 +93049,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92823,6 +93059,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92861,6 +93098,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92870,6 +93108,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92914,6 +93153,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92923,6 +93163,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -92961,6 +93202,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -92970,6 +93212,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -93018,6 +93261,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -93027,6 +93271,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -93065,6 +93310,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -93074,6 +93320,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -93096,7 +93343,7 @@ }, { "name": "update_mask", - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the alert fields to update, for example `display_name,query_text` or `schedule.pause_status`.\nOnly the listed fields are changed; all other fields keep their current values. `parent_path` cannot be updated.", "required": true, "is_query": true, "entity": { @@ -93114,7 +93361,7 @@ }, { "name": "custom_description", - "description": "Custom description for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`.\nThe available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates.", "is_request_body_field": true, "entity": { "is_string": true @@ -93122,7 +93369,7 @@ }, { "name": "custom_summary", - "description": "Custom summary for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`.", "is_request_body_field": true, "entity": { "is_string": true @@ -93166,6 +93413,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -93184,7 +93432,7 @@ }, { "name": "lifecycle_state", - "description": "Indicates whether the query is trashed.", + "description": "Indicates whether the alert is active (`ACTIVE`) or has been moved to the trash (`DELETED`).", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -93249,7 +93497,7 @@ }, { "name": "run_as_user_name", - "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "description": "Deprecated: Use `run_as` field instead. This field will be removed in a future release.\nThe run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.", "is_request_body_field": true, "entity": { "is_string": true @@ -93257,6 +93505,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -93296,7 +93545,7 @@ }, { "name": "update_mask", - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the alert fields to update, for example `display_name,query_text` or `schedule.pause_status`.\nOnly the listed fields are changed; all other fields keep their current values. `parent_path` cannot be updated.", "required": true, "is_query": true, "entity": { @@ -93332,6 +93581,7 @@ }, { "name": "evaluation", + "description": "Condition evaluated against the query result, and who is notified when it is met.", "required": true, "is_request_body_field": true, "entity": { @@ -93341,6 +93591,7 @@ }, { "name": "schedule", + "description": "Schedule on which the alert runs its query and evaluates the condition.", "required": true, "is_request_body_field": true, "entity": { @@ -93637,6 +93888,20 @@ "is_string": true } }, + { + "name": "effective_resources", + "description": "Resources added to the app, plus the resources it inherits from its space.\nEmpty for apps that are not in a space.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, { "name": "effective_usage_policy_id", "is_computed": true, @@ -96130,6 +96395,20 @@ "is_string": true } }, + { + "name": "effective_resources", + "description": "Resources added to the app, plus the resources it inherits from its space.\nEmpty for apps that are not in a space.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, { "name": "effective_usage_policy_id", "is_computed": true, @@ -98508,6 +98787,323 @@ } ] }, + { + "id": "iam.AssumeGroup", + "name": "AssumeGroup", + "description": "Manage the workspace's restricted sharing groups.", + "package": { + "name": "iam" + }, + "is_hidden_cli": true, + "docs_group": "iam", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "CreateRestrictedSharingGroup", + "description": "Adds a group to the workspace's restricted list. The workspace allows at\nmost 100 restricted sharing groups. Requires workspace admin.", + "summary": "Create a restricted sharing group.", + "path": "/api/2.0/access-control/restricted-sharing-groups", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateRestrictedSharingGroupRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "restricted_sharing_group", + "description": "The restricted sharing group to create. It has no client-set fields; the\ngroup is identified by restricted_sharing_group_id.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + } + }, + { + "name": "restricted_sharing_group_id", + "description": "The id of the workspace group to restrict: the numeric id of an existing and\nnon-system workspace group.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "restricted_sharing_group_id", + "description": "The id of the workspace group to restrict: the numeric id of an existing and\nnon-system workspace group.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "restricted_sharing_group", + "description": "The restricted sharing group to create. It has no client-set fields; the\ngroup is identified by restricted_sharing_group_id.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "restricted_sharing_group", + "description": "The restricted sharing group to create. It has no client-set fields; the\ngroup is identified by restricted_sharing_group_id.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + } + }, + "response": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + }, + "all_fields": [ + { + "name": "restricted_sharing_group", + "description": "The restricted sharing group to create. It has no client-set fields; the\ngroup is identified by restricted_sharing_group_id.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + } + }, + { + "name": "restricted_sharing_group_id", + "description": "The id of the workspace group to restrict: the numeric id of an existing and\nnon-system workspace group.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "group_display_name", + "description": "The display name of the restricted workspace group.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the restricted sharing group.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`\nExample: `restricted-sharing-groups/123`", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "restricted_sharing_group_id", + "description": "The id of the restricted workspace group: the numeric id of an existing and\nnon-system workspace group.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "restricted_sharing_group_id", + "description": "The id of the workspace group to restrict: the numeric id of an existing and\nnon-system workspace group.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteRestrictedSharingGroup", + "description": "Removes a group from the workspace's restricted list. Requires workspace\nadmin.", + "summary": "Delete a restricted sharing group.", + "path": "/api/2.0/access-control/{name=restricted-sharing-groups/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteRestrictedSharingGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to delete.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to delete.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to delete.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the restricted sharing group to delete.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRestrictedSharingGroup", + "description": "Gets a restricted sharing group in the workspace. Use it to check whether\na group is on the workspace's restricted list. Requires workspace admin.", + "summary": "Get a restricted sharing group.", + "path": "/api/2.0/access-control/{name=restricted-sharing-groups/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetRestrictedSharingGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to get.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to get.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestrictedSharingGroup", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the restricted sharing group to get.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the restricted sharing group to get.\nFormat: `restricted-sharing-groups/{restricted_sharing_group_id}`", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListRestrictedSharingGroups", + "description": "Lists the restricted sharing groups in the workspace. Requires workspace\nadmin.", + "summary": "List restricted sharing groups.", + "path": "/api/2.0/access-control/restricted-sharing-groups", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListRestrictedSharingGroupsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListRestrictedSharingGroupsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of groups to return. The service may return fewer.\nIf unspecified or 0, at most 100 groups are returned. Values above 100 are\ncoerced to 100. Negative values are rejected.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token from a previous ListRestrictedSharingGroups call. Provide\nthis to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token from a previous ListRestrictedSharingGroups call. Provide\nthis to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, { "id": "settings.AutomaticClusterUpdate", "name": "AutomaticClusterUpdate", @@ -178334,7 +178930,7 @@ }, { "name": "batch", - "description": "Batch SQL rule input.", + "description": "Scheduled detection (also known as batch detection) input.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -178361,7 +178957,7 @@ }, { "name": "compute_workspace_id", - "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled rule runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", + "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled detection runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -178655,7 +179251,7 @@ }, { "name": "timerange", - "description": "Time-range configuration for batch rules. If unset, the execution time range is extended by\na fixed `15m` lookback.", + "description": "Time-range configuration for scheduled detections. If unset, the execution time range is\nextended by a fixed `15m` lookback.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -181724,7 +182320,7 @@ }, { "name": "batch", - "description": "Batch SQL rule input.", + "description": "Scheduled detection (also known as batch detection) input.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -181751,7 +182347,7 @@ }, { "name": "compute_workspace_id", - "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled rule runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", + "description": "ID of the workspace whose compute runs this rule's jobs and owns its\nassociated resources, such as the SQL warehouse a scheduled detection runs on.\nServer-assigned; a rule's warehouse can only be changed from this workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -182045,7 +182641,7 @@ }, { "name": "timerange", - "description": "Time-range configuration for batch rules. If unset, the execution time range is extended by\na fixed `15m` lookback.", + "description": "Time-range configuration for scheduled detections. If unset, the execution time range is\nextended by a fixed `15m` lookback.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -201559,7 +202155,7 @@ }, { "name": "database_id", - "description": "The ID to use for the Database, which will become the final component of\nthe database's resource name.\nThis ID becomes the database name in postgres.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", "is_query": true, "entity": { "is_string": true @@ -202697,7 +203293,7 @@ }, { "name": "role_id", - "description": "The ID to use for the Role, which will become the final component of\nthe role's resource name.\nThis ID becomes the role in Postgres.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", "is_query": true, "entity": { "is_string": true @@ -203566,7 +204162,7 @@ "required_fields": [ { "name": "name", - "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}\n\nRead-write endpoints currently cannot be deleted directly. Their deletion is managed by the\nparent branch. To avoid compute costs, set `disabled` to `true` on the endpoint.", "required": true, "is_path": true, "entity": { @@ -203577,7 +204173,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}\n\nRead-write endpoints currently cannot be deleted directly. Their deletion is managed by the\nparent branch. To avoid compute costs, set `disabled` to `true` on the endpoint.", "required": true, "is_path": true, "entity": { @@ -203593,7 +204189,7 @@ "all_fields": [ { "name": "name", - "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}\n\nRead-write endpoints currently cannot be deleted directly. Their deletion is managed by the\nparent branch. To avoid compute costs, set `disabled` to `true` on the endpoint.", "required": true, "is_path": true, "entity": { @@ -203604,7 +204200,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}\n\nRead-write endpoints currently cannot be deleted directly. Their deletion is managed by the\nparent branch. To avoid compute costs, set `disabled` to `true` on the endpoint.", "required": true, "is_path": true, "entity": { @@ -228433,6 +229029,7 @@ }, { "name": "description", + "description": "The description of the serving endpoint.", "is_request_body_field": true, "entity": { "is_string": true @@ -228693,6 +229290,7 @@ "required_fields": [ { "name": "name", + "description": "The name of the serving endpoint to delete.", "required": true, "is_path": true, "entity": { @@ -228703,6 +229301,7 @@ "required_in_url_fields": [ { "name": "name", + "description": "The name of the serving endpoint to delete.", "required": true, "is_path": true, "entity": { @@ -228717,6 +229316,7 @@ "all_fields": [ { "name": "name", + "description": "The name of the serving endpoint to delete.", "required": true, "is_path": true, "entity": { @@ -228727,6 +229327,7 @@ "required_positional_arguments": [ { "name": "name", + "description": "The name of the serving endpoint to delete.", "required": true, "is_path": true, "entity": { @@ -230353,6 +230954,7 @@ }, { "name": "config", + "description": "The core config of the serving endpoint.", "required": true, "is_request_body_field": true, "entity": { @@ -230375,6 +230977,7 @@ "required_request_body_fields": [ { "name": "config", + "description": "The core config of the serving endpoint.", "required": true, "is_request_body_field": true, "entity": { @@ -230391,6 +230994,7 @@ "all_fields": [ { "name": "config", + "description": "The core config of the serving endpoint.", "required": true, "is_request_body_field": true, "entity": { diff --git a/.gitattributes b/.gitattributes index 0c7524ce9b5..ac5f2161603 100644 --- a/.gitattributes +++ b/.gitattributes @@ -58,6 +58,7 @@ cmd/workspace/alerts/alerts.go linguist-generated=true cmd/workspace/apps-settings/apps-settings.go linguist-generated=true cmd/workspace/apps/apps.go linguist-generated=true cmd/workspace/artifact-allowlists/artifact-allowlists.go linguist-generated=true +cmd/workspace/assume-group/assume-group.go linguist-generated=true cmd/workspace/automatic-cluster-update/automatic-cluster-update.go linguist-generated=true cmd/workspace/bundle-deployments/bundle-deployments.go linguist-generated=true cmd/workspace/catalogs/catalogs.go linguist-generated=true diff --git a/.nextchanges/dependency-updates/go-sdk-v0.199.0.md b/.nextchanges/dependency-updates/go-sdk-v0.199.0.md new file mode 100644 index 00000000000..4c0eb3cf32b --- /dev/null +++ b/.nextchanges/dependency-updates/go-sdk-v0.199.0.md @@ -0,0 +1 @@ +* Update the Go SDK to [v0.199.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.199.0). ([#7584](https://github.com/databricks/cli/pull/7584)) diff --git a/acceptance/bundle/refschema/output/apps.txt b/acceptance/bundle/refschema/output/apps.txt index 3e1f91151f1..706f2231c3a 100644 --- a/acceptance/bundle/refschema/output/apps.txt +++ b/acceptance/bundle/refschema/output/apps.txt @@ -67,6 +67,46 @@ resources.apps.*.default_git_source.tag string ALL resources.apps.*.default_source_code_path string ALL resources.apps.*.description string ALL resources.apps.*.effective_budget_policy_id string ALL +resources.apps.*.effective_resources []apps.AppResource ALL +resources.apps.*.effective_resources[*] apps.AppResource ALL +resources.apps.*.effective_resources[*].app *apps.AppResourceApp ALL +resources.apps.*.effective_resources[*].app.name string ALL +resources.apps.*.effective_resources[*].app.permission apps.AppResourceAppAppPermission ALL +resources.apps.*.effective_resources[*].database *apps.AppResourceDatabase ALL +resources.apps.*.effective_resources[*].database.database_name string ALL +resources.apps.*.effective_resources[*].database.instance_name string ALL +resources.apps.*.effective_resources[*].database.permission apps.AppResourceDatabaseDatabasePermission ALL +resources.apps.*.effective_resources[*].description string ALL +resources.apps.*.effective_resources[*].experiment *apps.AppResourceExperiment ALL +resources.apps.*.effective_resources[*].experiment.experiment_id string ALL +resources.apps.*.effective_resources[*].experiment.permission apps.AppResourceExperimentExperimentPermission ALL +resources.apps.*.effective_resources[*].genie_space *apps.AppResourceGenieSpace ALL +resources.apps.*.effective_resources[*].genie_space.name string ALL +resources.apps.*.effective_resources[*].genie_space.permission apps.AppResourceGenieSpaceGenieSpacePermission ALL +resources.apps.*.effective_resources[*].genie_space.space_id string ALL +resources.apps.*.effective_resources[*].job *apps.AppResourceJob ALL +resources.apps.*.effective_resources[*].job.id string ALL +resources.apps.*.effective_resources[*].job.permission apps.AppResourceJobJobPermission ALL +resources.apps.*.effective_resources[*].name string ALL +resources.apps.*.effective_resources[*].postgres *apps.AppResourcePostgres ALL +resources.apps.*.effective_resources[*].postgres.branch string ALL +resources.apps.*.effective_resources[*].postgres.database string ALL +resources.apps.*.effective_resources[*].postgres.permission apps.AppResourcePostgresPostgresPermission ALL +resources.apps.*.effective_resources[*].secret *apps.AppResourceSecret ALL +resources.apps.*.effective_resources[*].secret.key string ALL +resources.apps.*.effective_resources[*].secret.permission apps.AppResourceSecretSecretPermission ALL +resources.apps.*.effective_resources[*].secret.scope string ALL +resources.apps.*.effective_resources[*].serving_endpoint *apps.AppResourceServingEndpoint ALL +resources.apps.*.effective_resources[*].serving_endpoint.name string ALL +resources.apps.*.effective_resources[*].serving_endpoint.permission apps.AppResourceServingEndpointServingEndpointPermission ALL +resources.apps.*.effective_resources[*].sql_warehouse *apps.AppResourceSqlWarehouse ALL +resources.apps.*.effective_resources[*].sql_warehouse.id string ALL +resources.apps.*.effective_resources[*].sql_warehouse.permission apps.AppResourceSqlWarehouseSqlWarehousePermission ALL +resources.apps.*.effective_resources[*].uc_securable *apps.AppResourceUcSecurable ALL +resources.apps.*.effective_resources[*].uc_securable.permission apps.AppResourceUcSecurableUcSecurablePermission ALL +resources.apps.*.effective_resources[*].uc_securable.securable_full_name string ALL +resources.apps.*.effective_resources[*].uc_securable.securable_kind string ALL +resources.apps.*.effective_resources[*].uc_securable.securable_type apps.AppResourceUcSecurableUcSecurableType ALL resources.apps.*.effective_usage_policy_id string ALL resources.apps.*.effective_user_api_scopes []string ALL resources.apps.*.effective_user_api_scopes[*] string ALL diff --git a/bundle/config/mutator/load_dbalert_files.go b/bundle/config/mutator/load_dbalert_files.go index 437095aa218..2f2c42edffc 100644 --- a/bundle/config/mutator/load_dbalert_files.go +++ b/bundle/config/mutator/load_dbalert_files.go @@ -178,7 +178,7 @@ func (m *loadDBAlertFiles) Apply(ctx context.Context, b *bundle.Bundle) diag.Dia Evaluation: dbalertFromFile.Evaluation, EffectiveRunAs: dbalertFromFile.EffectiveRunAs, RunAs: dbalertFromFile.RunAs, - RunAsUserName: dbalertFromFile.RunAsUserName, + RunAsUserName: dbalertFromFile.RunAsUserName, //nolint:staticcheck // SA1019: run_as_user_name is still accepted in alert files; run_as is the replacement ParentPath: dbalertFromFile.ParentPath, Parameters: dbalertFromFile.Parameters, CustomTemplateFormat: dbalertFromFile.CustomTemplateFormat, diff --git a/bundle/direct/dresources/configs/apps.generated.yml b/bundle/direct/dresources/configs/apps.generated.yml index 5e204b2a15f..3564a41a1d1 100644 --- a/bundle/direct/dresources/configs/apps.generated.yml +++ b/bundle/direct/dresources/configs/apps.generated.yml @@ -24,6 +24,32 @@ ignore_remote_changes: reason: spec:output_only - field: effective_budget_policy_id reason: spec:output_only + - field: effective_resources + reason: spec:output_only + - field: effective_resources[*].app + reason: spec:output_only + - field: effective_resources[*].database + reason: spec:output_only + - field: effective_resources[*].description + reason: spec:output_only + - field: effective_resources[*].experiment + reason: spec:output_only + - field: effective_resources[*].genie_space + reason: spec:output_only + - field: effective_resources[*].job + reason: spec:output_only + - field: effective_resources[*].name + reason: spec:output_only + - field: effective_resources[*].postgres + reason: spec:output_only + - field: effective_resources[*].secret + reason: spec:output_only + - field: effective_resources[*].serving_endpoint + reason: spec:output_only + - field: effective_resources[*].sql_warehouse + reason: spec:output_only + - field: effective_resources[*].uc_securable + reason: spec:output_only - field: effective_usage_policy_id reason: spec:output_only - field: effective_user_api_scopes diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 230a7459dd7..db3cc5585e3 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -260,48 +260,6 @@ resources: "description": |- PLACEHOLDER "$fields": - "evaluation": - "description": |- - PLACEHOLDER - "$fields": - "notification": - "$fields": - "subscriptions": - "description": |- - PLACEHOLDER - "$fields": - "destination_id": - "description": |- - PLACEHOLDER - "user_email": - "description": |- - PLACEHOLDER - "source": - "$fields": - "display": - "description": |- - PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "threshold": - "$fields": - "column": - "description": |- - PLACEHOLDER - "value": - "description": |- - PLACEHOLDER - "$fields": - "bool_value": - "description": |- - PLACEHOLDER - "double_value": - "description": |- - PLACEHOLDER - "string_value": - "description": |- - PLACEHOLDER "file_path": "description": |- PLACEHOLDER @@ -325,9 +283,6 @@ resources: - level: CAN_RUN service_principal_name: 123456-abcdef ``` - "schedule": - "description": |- - PLACEHOLDER "apps": "description": |- The app resource defines a Databricks app. @@ -369,54 +324,7 @@ resources: "effective_budget_policy_id": "description": |- PLACEHOLDER - "effective_usage_policy_id": - "description": |- - PLACEHOLDER - "git_source": - "description": |- - Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) - to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. - The source_code_path within git_source specifies the relative path to the app code within the repository. - "lifecycle": - "description": |- - Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed. - "oauth2_app_client_id": - "description": |- - PLACEHOLDER - "oauth2_app_integration_id": - "description": |- - PLACEHOLDER - "permissions": - "description": |- - The permissions to apply to this resource. - "markdown_description": |- - A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping. - - See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). - "markdown_examples": |- - ```yaml - permissions: - - level: CAN_VIEW - group_name: test-group - - level: CAN_MANAGE - user_name: someone@example.com - - level: CAN_RUN - service_principal_name: 123456-abcdef - ``` - "$fields": - "group_name": - "description": |- - The name of the group granted the permission level. - "level": - "description": |- - The permission level to apply. The allowed levels depend on the resource type. - "service_principal_name": - "description": |- - The name of the service principal granted the permission level. - "user_name": - "description": |- - The name of the user granted the permission level. - "resources": + "effective_resources": "$fields": "app": "description": |- @@ -502,6 +410,53 @@ resources: "securable_type": "description": |- PLACEHOLDER + "effective_usage_policy_id": + "description": |- + PLACEHOLDER + "git_source": + "description": |- + Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) + to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. + The source_code_path within git_source specifies the relative path to the app code within the repository. + "lifecycle": + "description": |- + Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed. + "oauth2_app_client_id": + "description": |- + PLACEHOLDER + "oauth2_app_integration_id": + "description": |- + PLACEHOLDER + "permissions": + "description": |- + The permissions to apply to this resource. + "markdown_description": |- + A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` + "$fields": + "group_name": + "description": |- + The name of the group granted the permission level. + "level": + "description": |- + The permission level to apply. The allowed levels depend on the resource type. + "service_principal_name": + "description": |- + The name of the service principal granted the permission level. + "user_name": + "description": |- + The name of the user granted the permission level. "service_principal_client_id": "description": |- PLACEHOLDER @@ -1435,31 +1390,6 @@ resources: value: "data science" ``` "$fields": - "config": - "$fields": - "served_entities": - "$fields": - "entity_version": - "description": |- - PLACEHOLDER - "served_models": - "$fields": - "model_name": - "description": |- - PLACEHOLDER - "model_version": - "description": |- - PLACEHOLDER - "traffic_config": - "$fields": - "routes": - "$fields": - "served_entity_name": - "description": |- - PLACEHOLDER - "description": - "description": |- - PLACEHOLDER "lifecycle": "description": |- Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed. diff --git a/bundle/internal/validation/generated/enum_fields.go b/bundle/internal/validation/generated/enum_fields.go index c2b7a092791..879c5f475d7 100644 --- a/bundle/internal/validation/generated/enum_fields.go +++ b/bundle/internal/validation/generated/enum_fields.go @@ -20,25 +20,36 @@ var EnumFields = map[string][]string{ "resources.alerts.*.permissions[*].level": {"CAN_ATTACH_TO", "CAN_BIND", "CAN_CREATE", "CAN_CREATE_APP", "CAN_EDIT", "CAN_EDIT_METADATA", "CAN_MANAGE", "CAN_MANAGE_PRODUCTION_VERSIONS", "CAN_MANAGE_RUN", "CAN_MANAGE_STAGING_VERSIONS", "CAN_MONITOR", "CAN_MONITOR_ONLY", "CAN_QUERY", "CAN_READ", "CAN_RESTART", "CAN_RUN", "CAN_USE", "CAN_VIEW", "CAN_VIEW_METADATA", "IS_OWNER"}, "resources.alerts.*.schedule.pause_status": {"PAUSED", "UNPAUSED"}, - "resources.apps.*.active_deployment.mode": {"AUTO_SYNC", "SNAPSHOT"}, - "resources.apps.*.active_deployment.status.state": {"CANCELLED", "FAILED", "IN_PROGRESS", "SUCCEEDED"}, - "resources.apps.*.app_status.state": {"CRASHED", "DEPLOYING", "RUNNING", "UNAVAILABLE"}, - "resources.apps.*.compute_size": {"LARGE", "MEDIUM", "XLARGE"}, - "resources.apps.*.compute_status.state": {"ACTIVE", "DELETING", "ERROR", "STARTING", "STOPPED", "STOPPING", "UPDATING"}, - "resources.apps.*.pending_deployment.mode": {"AUTO_SYNC", "SNAPSHOT"}, - "resources.apps.*.pending_deployment.status.state": {"CANCELLED", "FAILED", "IN_PROGRESS", "SUCCEEDED"}, - "resources.apps.*.permissions[*].level": {"CAN_MANAGE", "CAN_USE"}, - "resources.apps.*.resources[*].app.permission": {"CAN_USE"}, - "resources.apps.*.resources[*].database.permission": {"CAN_CONNECT_AND_CREATE"}, - "resources.apps.*.resources[*].experiment.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_READ"}, - "resources.apps.*.resources[*].genie_space.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_RUN", "CAN_VIEW"}, - "resources.apps.*.resources[*].job.permission": {"CAN_MANAGE", "CAN_MANAGE_RUN", "CAN_VIEW", "IS_OWNER"}, - "resources.apps.*.resources[*].postgres.permission": {"CAN_CONNECT_AND_CREATE"}, - "resources.apps.*.resources[*].secret.permission": {"MANAGE", "READ", "WRITE"}, - "resources.apps.*.resources[*].serving_endpoint.permission": {"CAN_MANAGE", "CAN_QUERY", "CAN_VIEW"}, - "resources.apps.*.resources[*].sql_warehouse.permission": {"CAN_MANAGE", "CAN_USE", "IS_OWNER"}, - "resources.apps.*.resources[*].uc_securable.permission": {"EXECUTE", "MODIFY", "READ_VOLUME", "SELECT", "USE_CONNECTION", "WRITE_VOLUME"}, - "resources.apps.*.resources[*].uc_securable.securable_type": {"CONNECTION", "FUNCTION", "MODEL_SERVICE", "TABLE", "VOLUME"}, + "resources.apps.*.active_deployment.mode": {"AUTO_SYNC", "SNAPSHOT"}, + "resources.apps.*.active_deployment.status.state": {"CANCELLED", "FAILED", "IN_PROGRESS", "SUCCEEDED"}, + "resources.apps.*.app_status.state": {"CRASHED", "DEPLOYING", "RUNNING", "UNAVAILABLE"}, + "resources.apps.*.compute_size": {"LARGE", "MEDIUM", "XLARGE"}, + "resources.apps.*.compute_status.state": {"ACTIVE", "DELETING", "ERROR", "STARTING", "STOPPED", "STOPPING", "UPDATING"}, + "resources.apps.*.effective_resources[*].app.permission": {"CAN_USE"}, + "resources.apps.*.effective_resources[*].database.permission": {"CAN_CONNECT_AND_CREATE"}, + "resources.apps.*.effective_resources[*].experiment.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_READ"}, + "resources.apps.*.effective_resources[*].genie_space.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_RUN", "CAN_VIEW"}, + "resources.apps.*.effective_resources[*].job.permission": {"CAN_MANAGE", "CAN_MANAGE_RUN", "CAN_VIEW", "IS_OWNER"}, + "resources.apps.*.effective_resources[*].postgres.permission": {"CAN_CONNECT_AND_CREATE"}, + "resources.apps.*.effective_resources[*].secret.permission": {"MANAGE", "READ", "WRITE"}, + "resources.apps.*.effective_resources[*].serving_endpoint.permission": {"CAN_MANAGE", "CAN_QUERY", "CAN_VIEW"}, + "resources.apps.*.effective_resources[*].sql_warehouse.permission": {"CAN_MANAGE", "CAN_USE", "IS_OWNER"}, + "resources.apps.*.effective_resources[*].uc_securable.permission": {"EXECUTE", "MODIFY", "READ_VOLUME", "SELECT", "USE_CONNECTION", "WRITE_VOLUME"}, + "resources.apps.*.effective_resources[*].uc_securable.securable_type": {"CONNECTION", "FUNCTION", "MODEL_SERVICE", "TABLE", "VOLUME"}, + "resources.apps.*.pending_deployment.mode": {"AUTO_SYNC", "SNAPSHOT"}, + "resources.apps.*.pending_deployment.status.state": {"CANCELLED", "FAILED", "IN_PROGRESS", "SUCCEEDED"}, + "resources.apps.*.permissions[*].level": {"CAN_MANAGE", "CAN_USE"}, + "resources.apps.*.resources[*].app.permission": {"CAN_USE"}, + "resources.apps.*.resources[*].database.permission": {"CAN_CONNECT_AND_CREATE"}, + "resources.apps.*.resources[*].experiment.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_READ"}, + "resources.apps.*.resources[*].genie_space.permission": {"CAN_EDIT", "CAN_MANAGE", "CAN_RUN", "CAN_VIEW"}, + "resources.apps.*.resources[*].job.permission": {"CAN_MANAGE", "CAN_MANAGE_RUN", "CAN_VIEW", "IS_OWNER"}, + "resources.apps.*.resources[*].postgres.permission": {"CAN_CONNECT_AND_CREATE"}, + "resources.apps.*.resources[*].secret.permission": {"MANAGE", "READ", "WRITE"}, + "resources.apps.*.resources[*].serving_endpoint.permission": {"CAN_MANAGE", "CAN_QUERY", "CAN_VIEW"}, + "resources.apps.*.resources[*].sql_warehouse.permission": {"CAN_MANAGE", "CAN_USE", "IS_OWNER"}, + "resources.apps.*.resources[*].uc_securable.permission": {"EXECUTE", "MODIFY", "READ_VOLUME", "SELECT", "USE_CONNECTION", "WRITE_VOLUME"}, + "resources.apps.*.resources[*].uc_securable.securable_type": {"CONNECTION", "FUNCTION", "MODEL_SERVICE", "TABLE", "VOLUME"}, "resources.catalogs.*.isolation_mode": {"ISOLATED", "OPEN"}, diff --git a/bundle/internal/validation/generated/required_fields.go b/bundle/internal/validation/generated/required_fields.go index 760d14d9178..78b761f02d7 100644 --- a/bundle/internal/validation/generated/required_fields.go +++ b/bundle/internal/validation/generated/required_fields.go @@ -24,6 +24,15 @@ var RequiredFields = map[string][]string{ "resources.apps.*.active_deployment.git_source.git_repository": {"provider", "url"}, "resources.apps.*.config.env[*]": {"name"}, "resources.apps.*.default_git_source.git_repository": {"provider", "url"}, + "resources.apps.*.effective_resources[*]": {"name"}, + "resources.apps.*.effective_resources[*].database": {"database_name", "instance_name", "permission"}, + "resources.apps.*.effective_resources[*].experiment": {"experiment_id", "permission"}, + "resources.apps.*.effective_resources[*].genie_space": {"name", "permission", "space_id"}, + "resources.apps.*.effective_resources[*].job": {"id", "permission"}, + "resources.apps.*.effective_resources[*].secret": {"key", "permission", "scope"}, + "resources.apps.*.effective_resources[*].serving_endpoint": {"name", "permission"}, + "resources.apps.*.effective_resources[*].sql_warehouse": {"id", "permission"}, + "resources.apps.*.effective_resources[*].uc_securable": {"permission", "securable_full_name", "securable_type"}, "resources.apps.*.git_repository": {"provider", "url"}, "resources.apps.*.git_source.git_repository": {"provider", "url"}, "resources.apps.*.lifecycle.depends_on[*]": {"resource"}, diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index ecfcd2180a2..14fcb5e83ad 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -80,14 +80,15 @@ "oneOf": [ { "type": "object", + "description": "A SQL alert. An alert runs a query on a schedule, evaluates the result against a condition,\nand notifies users or notification destinations when the condition is met.", "properties": { "custom_description": { - "description": "Custom description for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`.\nThe available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "custom_summary": { - "description": "Custom summary for the alert. Interpreted according to `custom_template_format`.", + "description": "Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -102,6 +103,7 @@ "x-databricks-launch-stage": "GA" }, "evaluation": { + "description": "Condition evaluated against the query result, and who is notified when it is met.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", "x-databricks-launch-stage": "GA" }, @@ -138,13 +140,14 @@ "x-databricks-launch-stage": "GA" }, "run_as_user_name": { - "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "description": "Deprecated: Use `run_as` field instead. This field will be removed in a future release.\nThe run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "deprecated": true }, "schedule": { + "description": "Schedule on which the alert runs its query and evaluates the condition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", "x-databricks-launch-stage": "GA" }, @@ -2143,6 +2146,7 @@ "x-databricks-launch-stage": "GA" }, "description": { + "description": "The description of the serving endpoint.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -2733,7 +2737,7 @@ "$ref": "#/$defs/bool" }, "role": { - "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nA database always has an owner.", + "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" } @@ -14191,7 +14195,7 @@ "deprecated": true }, "filter_condition": { - "description": "Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", + "description": "A single WHERE clause to filter the Delta table before applying transformations.\nThe predicate is evaluated for each row.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -14209,7 +14213,7 @@ "deprecated": true }, "transformation_sql": { - "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", + "description": "A single SQL SELECT expression applied after filter_condition.\nThe expression must contain all required columns (e.g., \"*, col_a + col_b AS col_c\").\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -20658,6 +20662,7 @@ "type": "object", "properties": { "served_entity_name": { + "description": "The name of the served entity this route configures traffic for.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -20699,6 +20704,7 @@ "x-databricks-launch-stage": "GA" }, "entity_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -20812,10 +20818,12 @@ "x-databricks-launch-stage": "GA" }, "model_name": { + "description": "The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "model_version": { + "description": "The version of the model in Databricks Model Registry or Unity Catalog to be served.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -21167,12 +21175,12 @@ "type": "object", "properties": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", + "description": "Operator used for comparison in alert evaluation. The alert is triggered when the comparison of the source value with the threshold is true. `IS_NULL` and `IS_NOT_NULL` take no threshold.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", "x-databricks-launch-stage": "GA" }, "empty_result_state": { - "description": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", + "description": "Alert state if result is empty. If not set, an empty result sets the state to `ERROR`. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState", "x-databricks-launch-stage": "GA" }, @@ -21187,7 +21195,7 @@ "x-databricks-launch-stage": "GA" }, "threshold": { - "description": "Threshold to user for alert evaluation, can be a column or a value.", + "description": "Threshold to compare the source column against, either another column or a fixed value. Not needed when `comparison_operator` is `IS_NULL` or `IS_NOT_NULL`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand", "x-databricks-launch-stage": "GA" } @@ -21220,6 +21228,7 @@ "x-databricks-launch-stage": "GA" }, "subscriptions": { + "description": "Users and notification destinations that receive notifications.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", "x-databricks-launch-stage": "GA" } @@ -21238,10 +21247,12 @@ "type": "object", "properties": { "column": { + "description": "Compare the source against another column of the query result.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", "x-databricks-launch-stage": "GA" }, "value": { + "description": "Compare the source against a fixed value.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", "x-databricks-launch-stage": "GA" } @@ -21260,15 +21271,17 @@ "type": "object", "properties": { "aggregation": { - "description": "If not set, the behavior is equivalent to using `First row` in the UI.", + "description": "Aggregation applied to the column across all rows of the query result: `SUM`, `COUNT`, `COUNT_DISTINCT`, `AVG`, `MEDIAN`, `MIN`, `MAX` or `STDDEV`.\nIf not set, the value in the first row is used, which is equivalent to using `First row` in the UI.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", "x-databricks-launch-stage": "GA" }, "display": { + "description": "Label for the column in notifications. Defaults to `name`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "name": { + "description": "Name of the column in the query result.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21290,14 +21303,17 @@ "type": "object", "properties": { "bool_value": { + "description": "Boolean threshold, for boolean columns.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA" }, "double_value": { + "description": "Numeric threshold, for numeric columns.", "$ref": "#/$defs/float64", "x-databricks-launch-stage": "GA" }, "string_value": { + "description": "String threshold, for string or timestamp columns.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21340,10 +21356,12 @@ "type": "object", "properties": { "destination_id": { + "description": "ID of the notification destination to notify, as returned by the Notification Destinations API.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "user_email": { + "description": "Email address of the workspace user to notify.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21446,12 +21464,12 @@ "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "description": "Indicates whether this schedule is paused. While paused, the alert is not evaluated.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", "x-databricks-launch-stage": "GA" }, "quartz_cron_schedule": { - "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", + "description": "A cron expression using quartz syntax that specifies the schedule for this alert.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, diff --git a/cmd/workspace/ai-functions/ai-functions.go b/cmd/workspace/ai-functions/ai-functions.go index 306dee5c4b1..ff3a45cdf20 100644 --- a/cmd/workspace/ai-functions/ai-functions.go +++ b/cmd/workspace/ai-functions/ai-functions.go @@ -370,21 +370,20 @@ func newCancelBatch() *cobra.Command { var cancelBatchReq aifunctions.CancelBatchRequest cmd.Use = "cancel-batch NAME" - cmd.Short = `Cancel a batch.` - cmd.Long = `Cancel a batch. + cmd.Short = `*Beta* Cancel a batch.` + cmd.Long = `This command is in Beta and may change without notice. - Cancel a batch. Cancellation is asynchronous: requests in flight drain first, - so read the batch to observe the CANCELLING and CANCELLED statuses. +Cancel a batch. - Arguments: - NAME: ID of the batch, in the form batch_.` + Starts the asynchronous cancellation of a batch. Requests in progress are + drained first. Cancellation is best effort, so the batch can still complete. - // This command is being previewed; hide from help output. - cmd.Hidden = true + Arguments: + NAME: Resource name of the batch. Format: batch_.` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Private Preview" + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -436,39 +435,40 @@ func newCreateBatch() *cobra.Command { cmd.Flags().Var(&createBatchJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createBatchReq.Batch.Name, "name", createBatchReq.Batch.Name, `ID of the batch, in the form batch_.`) - cmd.Flags().StringVar(&createBatchReq.Batch.OutputRef, "output-ref", createBatchReq.Batch.OutputRef, `Path on a Unity Catalog volume to write the JSONL output to.`) // TODO: map via StringToStringVar: params // TODO: complex arg: request_counts - cmd.Use = "create-batch ENDPOINT INPUT_REF" - cmd.Short = `Create a batch.` - cmd.Long = `Create a batch. + cmd.Use = "create-batch ENDPOINT INPUT_REF OUTPUT_REF" + cmd.Short = `*Beta* Create a batch.` + cmd.Long = `This command is in Beta and may change without notice. - Run an AI function over every request in a file on a Unity Catalog volume. The - batch runs asynchronously; read it to follow its progress. +Create a batch. - Arguments: - ENDPOINT: The AI function to run for every request, for example ai_extract. - INPUT_REF: Path of the JSONL input file on a Unity Catalog volume. Each line is one - request.` + Creates a batch that runs an AI function on every request in a JSONL file on a + Unity Catalog volume. The batch runs asynchronously. To follow its progress, + get the batch. - // This command is being previewed; hide from help output. - cmd.Hidden = true + Arguments: + ENDPOINT: The AI function, for example ai_parse_document. + INPUT_REF: Unity Catalog volume path of the JSONL input file. Each line is one + request, in the form {"custom_id": ..., "body": ...}. The file can hold + up to 50,000 requests and be up to 200 MiB. + OUTPUT_REF: Unity Catalog volume path to write the JSONL output file to. If the path + is a directory, the file is /_output.jsonl.` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Private Preview" + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" cmd.Args = func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("json") { err := root.ExactArgs(0)(cmd, args) if err != nil { - return errors.New("when --json flag is specified, no positional arguments are allowed. Provide 'endpoint', 'input_ref' in your JSON input") + return errors.New("when --json flag is specified, no positional arguments are allowed. Provide 'endpoint', 'input_ref', 'output_ref' in your JSON input") } return nil } - check := root.ExactArgs(2) + check := root.ExactArgs(3) return check(cmd, args) } @@ -495,6 +495,9 @@ func newCreateBatch() *cobra.Command { if !cmd.Flags().Changed("json") { createBatchReq.Batch.InputRef = args[1] } + if !cmd.Flags().Changed("json") { + createBatchReq.Batch.OutputRef = args[2] + } response, err := w.AiFunctions.CreateBatch(ctx, createBatchReq) if err != nil { @@ -531,20 +534,19 @@ func newGetBatch() *cobra.Command { var getBatchReq aifunctions.GetBatchRequest cmd.Use = "get-batch NAME" - cmd.Short = `Get a batch.` - cmd.Long = `Get a batch. + cmd.Short = `*Beta* Get a batch.` + cmd.Long = `This command is in Beta and may change without notice. - Read one batch, with its status and progress. +Get a batch. - Arguments: - NAME: ID of the batch, in the form batch_.` + Gets the latest status and progress of a batch. - // This command is being previewed; hide from help output. - cmd.Hidden = true + Arguments: + NAME: Resource name of the batch. Format: batch_.` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Private Preview" + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -606,17 +608,16 @@ func newListBatches() *cobra.Command { cmd.Flags().Lookup("page-token").Hidden = true cmd.Use = "list-batches" - cmd.Short = `List batches.` - cmd.Long = `List batches. + cmd.Short = `*Beta* List batches.` + cmd.Long = `This command is in Beta and may change without notice. - List the batches the caller created in this workspace.` +List batches. - // This command is being previewed; hide from help output. - cmd.Hidden = true + Lists the batches that the caller created in this workspace.` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Private Preview" + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(0) diff --git a/cmd/workspace/alerts-v2/alerts-v2.go b/cmd/workspace/alerts-v2/alerts-v2.go index f7a31691341..ea3455beb40 100644 --- a/cmd/workspace/alerts-v2/alerts-v2.go +++ b/cmd/workspace/alerts-v2/alerts-v2.go @@ -64,27 +64,29 @@ func newCreateAlert() *cobra.Command { cmd.Flags().Var(&createAlertJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createAlertReq.Alert.CustomDescription, "custom-description", createAlertReq.Alert.CustomDescription, `Custom description for the alert.`) - cmd.Flags().StringVar(&createAlertReq.Alert.CustomSummary, "custom-summary", createAlertReq.Alert.CustomSummary, `Custom summary for the alert.`) + cmd.Flags().StringVar(&createAlertReq.Alert.CustomDescription, "custom-description", createAlertReq.Alert.CustomDescription, `Custom description for the alert, used as the notification body.`) + cmd.Flags().StringVar(&createAlertReq.Alert.CustomSummary, "custom-summary", createAlertReq.Alert.CustomSummary, `Custom summary for the alert, used as the notification subject.`) cmd.Flags().Var(&createAlertReq.Alert.CustomTemplateFormat, "custom-template-format", `The format used to interpret the custom_summary and custom_description templates. Supported values: [HTML, MARKDOWN]`) // TODO: complex arg: effective_run_as // TODO: array: parameters cmd.Flags().StringVar(&createAlertReq.Alert.ParentPath, "parent-path", createAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert.`) // TODO: complex arg: run_as - cmd.Flags().StringVar(&createAlertReq.Alert.RunAsUserName, "run-as-user-name", createAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal.`) + cmd.Flags().StringVar(&createAlertReq.Alert.RunAsUserName, "run-as-user-name", createAlertReq.Alert.RunAsUserName, `Deprecated: Use run_as field instead.`) cmd.Use = "create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Create an alert.` cmd.Long = `Create an alert. - Create Alert + Creates an alert that runs query_text on the given schedule and evaluates + the result against the configured condition. Arguments: DISPLAY_NAME: The display name of the alert. QUERY_TEXT: Text of the query to be run. WAREHOUSE_ID: ID of the SQL warehouse attached to the alert. - EVALUATION: - SCHEDULE: ` + EVALUATION: Condition evaluated against the query result, and who is notified when it + is met. + SCHEDULE: Schedule on which the alert runs its query and evaluates the condition.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -181,7 +183,10 @@ func newGetAlert() *cobra.Command { cmd.Short = `Get an alert.` cmd.Long = `Get an alert. - Gets an alert.` + Gets an alert. + + Arguments: + ID: ID of the alert to retrieve, as returned in the alert's id field.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -200,14 +205,14 @@ func newGetAlert() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Alerts V2 drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the alert to retrieve, as returned in the alert's `id` field") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the alert to retrieve, as returned in the alert's `id` field") } getAlertReq.Id = args[0] @@ -249,7 +254,7 @@ func newListAlerts() *cobra.Command { // branches, so the method-call path is always reached. var listAlertsLimit int - cmd.Flags().IntVar(&listAlertsReq.PageSize, "page-size", listAlertsReq.PageSize, ``) + cmd.Flags().IntVar(&listAlertsReq.PageSize, "page-size", listAlertsReq.PageSize, `Maximum number of alerts to return per page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listAlertsLimit, "limit", 0, `Maximum number of results to return.`) @@ -323,7 +328,10 @@ func newTrashAlert() *cobra.Command { Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer trigger. You can restore a trashed alert through the - UI. A trashed alert is permanently deleted after 30 days.` + UI. A trashed alert is permanently deleted after 30 days. + + Arguments: + ID: ID of the alert to move to the trash.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -342,14 +350,14 @@ func newTrashAlert() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Alerts V2 drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the alert to move to the trash") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the alert to move to the trash") } trashAlertReq.Id = args[0] @@ -390,39 +398,34 @@ func newUpdateAlert() *cobra.Command { cmd.Flags().Var(&updateAlertJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateAlertReq.Alert.CustomDescription, "custom-description", updateAlertReq.Alert.CustomDescription, `Custom description for the alert.`) - cmd.Flags().StringVar(&updateAlertReq.Alert.CustomSummary, "custom-summary", updateAlertReq.Alert.CustomSummary, `Custom summary for the alert.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.CustomDescription, "custom-description", updateAlertReq.Alert.CustomDescription, `Custom description for the alert, used as the notification body.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.CustomSummary, "custom-summary", updateAlertReq.Alert.CustomSummary, `Custom summary for the alert, used as the notification subject.`) cmd.Flags().Var(&updateAlertReq.Alert.CustomTemplateFormat, "custom-template-format", `The format used to interpret the custom_summary and custom_description templates. Supported values: [HTML, MARKDOWN]`) // TODO: complex arg: effective_run_as // TODO: array: parameters cmd.Flags().StringVar(&updateAlertReq.Alert.ParentPath, "parent-path", updateAlertReq.Alert.ParentPath, `The workspace path of the folder containing the alert.`) // TODO: complex arg: run_as - cmd.Flags().StringVar(&updateAlertReq.Alert.RunAsUserName, "run-as-user-name", updateAlertReq.Alert.RunAsUserName, `The run as username or application ID of service principal.`) + cmd.Flags().StringVar(&updateAlertReq.Alert.RunAsUserName, "run-as-user-name", updateAlertReq.Alert.RunAsUserName, `Deprecated: Use run_as field instead.`) cmd.Use = "update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Update an alert.` cmd.Long = `Update an alert. - Update alert + Updates an alert. Only the fields listed in update_mask are changed; all + other fields keep their current values. Arguments: ID: The canonical identifier of the alert to retrieve information about. - UPDATE_MASK: The field mask must be a single string, with multiple fields separated by - commas (no spaces). The field path is relative to the resource object, - using a dot (.) to navigate sub-fields (e.g., author.given_name). - Specification of elements in sequence or map fields is not allowed, as - only the entire collection field can be specified. Field names must - exactly match the resource field names. - - A field mask of * indicates full replacement. It’s recommended to - always explicitly list the fields being updated and avoid using * - wildcards, as it can lead to unintended results if the API changes in the - future. + UPDATE_MASK: Comma-separated list of the alert fields to update, for example + display_name,query_text or schedule.pause_status. Only the listed + fields are changed; all other fields keep their current values. + parent_path cannot be updated. DISPLAY_NAME: The display name of the alert. QUERY_TEXT: Text of the query to be run. WAREHOUSE_ID: ID of the SQL warehouse attached to the alert. - EVALUATION: - SCHEDULE: ` + EVALUATION: Condition evaluated against the query result, and who is notified when it + is met. + SCHEDULE: Schedule on which the alert runs its query and evaluates the condition.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/apps/apps.go b/cmd/workspace/apps/apps.go index 4b756f47d23..b9f7a6bf463 100644 --- a/cmd/workspace/apps/apps.go +++ b/cmd/workspace/apps/apps.go @@ -105,6 +105,7 @@ func newCreate() *cobra.Command { // TODO: complex arg: compute_status // TODO: complex arg: default_git_source cmd.Flags().StringVar(&createReq.App.Description, "description", createReq.App.Description, `The description of the app.`) + // TODO: array: effective_resources // TODO: array: effective_user_api_scopes cmd.Flags().BoolVar(&createReq.App.ForwardUserAccessToken, "forward-user-access-token", createReq.App.ForwardUserAccessToken, `Forward the user's access token to the app.`) // TODO: complex arg: git_repository @@ -1701,6 +1702,7 @@ func newUpdate() *cobra.Command { // TODO: complex arg: compute_status // TODO: complex arg: default_git_source cmd.Flags().StringVar(&updateReq.App.Description, "description", updateReq.App.Description, `The description of the app.`) + // TODO: array: effective_resources // TODO: array: effective_user_api_scopes cmd.Flags().BoolVar(&updateReq.App.ForwardUserAccessToken, "forward-user-access-token", updateReq.App.ForwardUserAccessToken, `Forward the user's access token to the app.`) // TODO: complex arg: git_repository diff --git a/cmd/workspace/assume-group/assume-group.go b/cmd/workspace/assume-group/assume-group.go new file mode 100644 index 00000000000..3f7337271a4 --- /dev/null +++ b/cmd/workspace/assume-group/assume-group.go @@ -0,0 +1,321 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package assume_group + +import ( + "fmt" + + "github.com/databricks/cli/cmd/root" + "github.com/databricks/cli/libs/cmdctx" + "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/cli/libs/flags" + "github.com/databricks/databricks-sdk-go/service/iam" + "github.com/spf13/cobra" +) + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var cmdOverrides []func(*cobra.Command) + +func New() *cobra.Command { + cmd := &cobra.Command{ + Use: "assume-group", + Short: `Manage the workspace's restricted sharing groups.`, + Long: `Manage the workspace's restricted sharing groups.`, + GroupID: "iam", + + // This service is being previewed; hide from help output. + Hidden: true, + RunE: root.ReportUnknownSubcommand, + } + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + // Add methods + cmd.AddCommand(newCreateRestrictedSharingGroup()) + cmd.AddCommand(newDeleteRestrictedSharingGroup()) + cmd.AddCommand(newGetRestrictedSharingGroup()) + cmd.AddCommand(newListRestrictedSharingGroups()) + + // Apply optional overrides to this command. + for _, fn := range cmdOverrides { + fn(cmd) + } + + return cmd +} + +// start create-restricted-sharing-group command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var createRestrictedSharingGroupOverrides []func( + *cobra.Command, + *iam.CreateRestrictedSharingGroupRequest, +) + +func newCreateRestrictedSharingGroup() *cobra.Command { + cmd := &cobra.Command{} + + var createRestrictedSharingGroupReq iam.CreateRestrictedSharingGroupRequest + createRestrictedSharingGroupReq.RestrictedSharingGroup = iam.RestrictedSharingGroup{} + var createRestrictedSharingGroupJson flags.JsonFlag + + cmd.Flags().Var(&createRestrictedSharingGroupJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + cmd.Flags().StringVar(&createRestrictedSharingGroupReq.RestrictedSharingGroup.Name, "name", createRestrictedSharingGroupReq.RestrictedSharingGroup.Name, `The resource name of the restricted sharing group.`) + + cmd.Use = "create-restricted-sharing-group RESTRICTED_SHARING_GROUP_ID" + cmd.Short = `Create a restricted sharing group.` + cmd.Long = `Create a restricted sharing group. + + Adds a group to the workspace's restricted list. The workspace allows at most + 100 restricted sharing groups. Requires workspace admin. + + Arguments: + RESTRICTED_SHARING_GROUP_ID: The id of the workspace group to restrict: the numeric id of an existing + and non-system workspace group.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := createRestrictedSharingGroupJson.Unmarshal(&createRestrictedSharingGroupReq.RestrictedSharingGroup) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + createRestrictedSharingGroupReq.RestrictedSharingGroupId = args[0] + + response, err := w.AssumeGroup.CreateRestrictedSharingGroup(ctx, createRestrictedSharingGroupReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range createRestrictedSharingGroupOverrides { + fn(cmd, &createRestrictedSharingGroupReq) + } + + return cmd +} + +// start delete-restricted-sharing-group command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var deleteRestrictedSharingGroupOverrides []func( + *cobra.Command, + *iam.DeleteRestrictedSharingGroupRequest, +) + +func newDeleteRestrictedSharingGroup() *cobra.Command { + cmd := &cobra.Command{} + + var deleteRestrictedSharingGroupReq iam.DeleteRestrictedSharingGroupRequest + + cmd.Use = "delete-restricted-sharing-group NAME" + cmd.Short = `Delete a restricted sharing group.` + cmd.Long = `Delete a restricted sharing group. + + Removes a group from the workspace's restricted list. Requires workspace + admin. + + Arguments: + NAME: The name of the restricted sharing group to delete. Format: + restricted-sharing-groups/{restricted_sharing_group_id}` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + deleteRestrictedSharingGroupReq.Name = args[0] + + err = w.AssumeGroup.DeleteRestrictedSharingGroup(ctx, deleteRestrictedSharingGroupReq) + if err != nil { + return err + } + return nil + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range deleteRestrictedSharingGroupOverrides { + fn(cmd, &deleteRestrictedSharingGroupReq) + } + + return cmd +} + +// start get-restricted-sharing-group command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var getRestrictedSharingGroupOverrides []func( + *cobra.Command, + *iam.GetRestrictedSharingGroupRequest, +) + +func newGetRestrictedSharingGroup() *cobra.Command { + cmd := &cobra.Command{} + + var getRestrictedSharingGroupReq iam.GetRestrictedSharingGroupRequest + + cmd.Use = "get-restricted-sharing-group NAME" + cmd.Short = `Get a restricted sharing group.` + cmd.Long = `Get a restricted sharing group. + + Gets a restricted sharing group in the workspace. Use it to check whether a + group is on the workspace's restricted list. Requires workspace admin. + + Arguments: + NAME: The name of the restricted sharing group to get. Format: + restricted-sharing-groups/{restricted_sharing_group_id}` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + getRestrictedSharingGroupReq.Name = args[0] + + response, err := w.AssumeGroup.GetRestrictedSharingGroup(ctx, getRestrictedSharingGroupReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range getRestrictedSharingGroupOverrides { + fn(cmd, &getRestrictedSharingGroupReq) + } + + return cmd +} + +// start list-restricted-sharing-groups command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listRestrictedSharingGroupsOverrides []func( + *cobra.Command, + *iam.ListRestrictedSharingGroupsRequest, +) + +func newListRestrictedSharingGroups() *cobra.Command { + cmd := &cobra.Command{} + + var listRestrictedSharingGroupsReq iam.ListRestrictedSharingGroupsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listRestrictedSharingGroupsLimit int + + cmd.Flags().IntVar(&listRestrictedSharingGroupsReq.PageSize, "page-size", listRestrictedSharingGroupsReq.PageSize, `The maximum number of groups to return.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listRestrictedSharingGroupsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listRestrictedSharingGroupsReq.PageToken, "page-token", listRestrictedSharingGroupsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-restricted-sharing-groups" + cmd.Short = `List restricted sharing groups.` + cmd.Long = `List restricted sharing groups. + + Lists the restricted sharing groups in the workspace. Requires workspace + admin.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(0) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + response := w.AssumeGroup.ListRestrictedSharingGroups(ctx, listRestrictedSharingGroupsReq) + if listRestrictedSharingGroupsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listRestrictedSharingGroupsLimit) + } + if listRestrictedSharingGroupsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listRestrictedSharingGroupsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listRestrictedSharingGroupsOverrides { + fn(cmd, &listRestrictedSharingGroupsReq) + } + + return cmd +} + +// end service AssumeGroup diff --git a/cmd/workspace/cmd.go b/cmd/workspace/cmd.go index 58d58cafcef..8d0f653a4dc 100644 --- a/cmd/workspace/cmd.go +++ b/cmd/workspace/cmd.go @@ -15,6 +15,7 @@ import ( apps "github.com/databricks/cli/cmd/workspace/apps" apps_settings "github.com/databricks/cli/cmd/workspace/apps-settings" artifact_allowlists "github.com/databricks/cli/cmd/workspace/artifact-allowlists" + assume_group "github.com/databricks/cli/cmd/workspace/assume-group" bundle_deployments "github.com/databricks/cli/cmd/workspace/bundle-deployments" catalogs "github.com/databricks/cli/cmd/workspace/catalogs" clean_room_asset_revisions "github.com/databricks/cli/cmd/workspace/clean-room-asset-revisions" @@ -158,6 +159,7 @@ func All() []*cobra.Command { out = append(out, apps.New()) out = append(out, apps_settings.New()) out = append(out, artifact_allowlists.New()) + out = append(out, assume_group.New()) out = append(out, bundle_deployments.New()) out = append(out, catalogs.New()) out = append(out, clean_room_asset_revisions.New()) diff --git a/cmd/workspace/postgres/postgres.go b/cmd/workspace/postgres/postgres.go index 3dc3bc39615..a3ddae108ff 100644 --- a/cmd/workspace/postgres/postgres.go +++ b/cmd/workspace/postgres/postgres.go @@ -874,7 +874,7 @@ func newCreateDatabase() *cobra.Command { cmd.Flags().Var(&createDatabaseJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDatabaseReq.DatabaseId, "database-id", createDatabaseReq.DatabaseId, `The ID to use for the Database, which will become the final component of the database's resource name.`) + cmd.Flags().StringVar(&createDatabaseReq.DatabaseId, "database-id", createDatabaseReq.DatabaseId, `The ID used to identify and manage the Database resource through the API.`) cmd.Flags().BoolVar(&createDatabaseReq.ReplaceExisting, "replace-existing", createDatabaseReq.ReplaceExisting, `If true, update the database if it already exists instead of returning an error.`) cmd.Flags().StringVar(&createDatabaseReq.Database.Name, "name", createDatabaseReq.Database.Name, `The resource name of the database.`) // TODO: complex arg: spec @@ -1412,7 +1412,7 @@ func newCreateRole() *cobra.Command { cmd.Flags().Var(&createRoleJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().BoolVar(&createRoleReq.ReplaceExisting, "replace-existing", createRoleReq.ReplaceExisting, `If true, update the role if it already exists instead of returning an error.`) - cmd.Flags().StringVar(&createRoleReq.RoleId, "role-id", createRoleReq.RoleId, `The ID to use for the Role, which will become the final component of the role's resource name.`) + cmd.Flags().StringVar(&createRoleReq.RoleId, "role-id", createRoleReq.RoleId, `The ID used to identify and manage the Role resource through the API.`) cmd.Flags().StringVar(&createRoleReq.Role.Name, "name", createRoleReq.Role.Name, `Output only.`) // TODO: complex arg: spec // TODO: complex arg: status @@ -2314,7 +2314,11 @@ func newDeleteEndpoint() *cobra.Command { Arguments: NAME: The full resource path of the endpoint to delete. Format: - projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}` + projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + + Read-write endpoints currently cannot be deleted directly. Their deletion + is managed by the parent branch. To avoid compute costs, set disabled to + true on the endpoint.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/serving-endpoints/serving-endpoints.go b/cmd/workspace/serving-endpoints/serving-endpoints.go index 7c837c5d2dd..26bc7833507 100644 --- a/cmd/workspace/serving-endpoints/serving-endpoints.go +++ b/cmd/workspace/serving-endpoints/serving-endpoints.go @@ -165,7 +165,7 @@ func newCreate() *cobra.Command { // TODO: complex arg: ai_gateway cmd.Flags().StringVar(&createReq.BudgetPolicyId, "budget-policy-id", createReq.BudgetPolicyId, `The budget policy to be applied to the serving endpoint.`) // TODO: complex arg: config - cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, ``) + cmd.Flags().StringVar(&createReq.Description, "description", createReq.Description, `The description of the serving endpoint.`) // TODO: complex arg: email_notifications // TODO: array: rate_limits cmd.Flags().BoolVar(&createReq.RouteOptimized, "route-optimized", createReq.RouteOptimized, `Enable route optimization for the serving endpoint.`) @@ -356,7 +356,10 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a serving endpoint.` - cmd.Long = `Delete a serving endpoint.` + cmd.Long = `Delete a serving endpoint. + + Arguments: + NAME: The name of the serving endpoint to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/go.mod b/go.mod index ccf1f4e96be..db7b9e41457 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/charmbracelet/huh v1.0.0 // MIT github.com/charmbracelet/lipgloss v1.1.0 // MIT github.com/charmbracelet/x/ansi v0.11.9 // MIT - github.com/databricks/databricks-sdk-go v0.198.0 // Apache-2.0 + github.com/databricks/databricks-sdk-go v0.199.0 // Apache-2.0 github.com/databricks/sdk-go/auth v0.2.0 // Apache-2.0 github.com/databricks/sdk-go/core v0.1.0 // Apache-2.0 github.com/databricks/sdk-go/files v0.3.0 // Apache-2.0 diff --git a/go.sum b/go.sum index ab021a2a1a8..15d7d260ca9 100644 --- a/go.sum +++ b/go.sum @@ -60,8 +60,8 @@ github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s= github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE= github.com/danieljoos/wincred v1.2.3 h1:v7dZC2x32Ut3nEfRH+vhoZGvN72+dQ/snVXo/vMFLdQ= github.com/danieljoos/wincred v1.2.3/go.mod h1:6qqX0WNrS4RzPZ1tnroDzq9kY3fu1KwE7MRLQK4X0bs= -github.com/databricks/databricks-sdk-go v0.198.0 h1:Ij8sxkRLyUUc6uTeB4rooAnlJm8DOb0vBDC1ZXHqQXA= -github.com/databricks/databricks-sdk-go v0.198.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= +github.com/databricks/databricks-sdk-go v0.199.0 h1:fvcDGaNgUvptUl/wqPMTLoJSLsezStZSEvIZAO98wy4= +github.com/databricks/databricks-sdk-go v0.199.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= github.com/databricks/sdk-go/auth v0.2.0 h1:543fVMvJ6pVxBymfjGGkkmfiHDbUqX7y9lZseEcE4tQ= github.com/databricks/sdk-go/auth v0.2.0/go.mod h1:eNJdFzBAfu1y32a3wPcTnjaUkjhS9VfyCNblKFPIPEo= github.com/databricks/sdk-go/core v0.1.0 h1:ZolzW/KVIJy1xXQ0zTsu/QYsEB4vQAEApbbq4D3RGHc= diff --git a/python/codegen/codegen/jsonschema_patch.py b/python/codegen/codegen/jsonschema_patch.py index 052995c51b5..33764b5b273 100644 --- a/python/codegen/codegen/jsonschema_patch.py +++ b/python/codegen/codegen/jsonschema_patch.py @@ -32,6 +32,9 @@ DROP_FIELD_DESCRIPTIONS: dict[str, list[str]] = { "jobs.DeploymentSpec": ["command_path"], "compute.InstancePoolGcpAttributes": ["gcp_availability"], + # ml.DeltaTableSource.transformation_sql: the example's leading `*` opens an RST + # emphasis span that is never closed, which Sphinx reports as a docs warning. + "ml.DeltaTableSource": ["transformation_sql"], } diff --git a/python/databricks/bundles/alerts/_models/alert.py b/python/databricks/bundles/alerts/_models/alert.py index 931aee97f3d..dd573b69982 100644 --- a/python/databricks/bundles/alerts/_models/alert.py +++ b/python/databricks/bundles/alerts/_models/alert.py @@ -40,7 +40,10 @@ @dataclass(kw_only=True) class Alert(Resource): - """""" + """ + A SQL alert. An alert runs a query on a schedule, evaluates the result against a condition, + and notifies users or notification destinations when the condition is met. + """ display_name: VariableOr[str] """ @@ -48,6 +51,9 @@ class Alert(Resource): """ evaluation: VariableOr[AlertV2Evaluation] + """ + Condition evaluated against the query result, and who is notified when it is met. + """ query_text: VariableOr[str] """ @@ -55,6 +61,9 @@ class Alert(Resource): """ schedule: VariableOr[CronSchedule] + """ + Schedule on which the alert runs its query and evaluates the condition. + """ warehouse_id: VariableOr[str] """ @@ -63,12 +72,13 @@ class Alert(Resource): custom_description: VariableOrOptional[str] = None """ - Custom description for the alert. Interpreted according to `custom_template_format`. + Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`. + The available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates. """ custom_summary: VariableOrOptional[str] = None """ - Custom summary for the alert. Interpreted according to `custom_template_format`. + Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`. """ custom_template_format: VariableOrOptional[CustomTemplateFormat] = None @@ -129,9 +139,9 @@ class Alert(Resource): run_as_user_name: VariableOrOptional[str] = None """ - [DEPRECATED] The run as username or application ID of service principal. + [DEPRECATED] Deprecated: Use `run_as` field instead. This field will be removed in a future release. + The run as username or application ID of service principal. On Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role. - Deprecated: Use `run_as` field instead. This field will be removed in a future release. """ @classmethod @@ -151,6 +161,9 @@ class AlertDict(TypedDict, total=False): """ evaluation: VariableOr[AlertV2EvaluationParam] + """ + Condition evaluated against the query result, and who is notified when it is met. + """ query_text: VariableOr[str] """ @@ -158,6 +171,9 @@ class AlertDict(TypedDict, total=False): """ schedule: VariableOr[CronScheduleParam] + """ + Schedule on which the alert runs its query and evaluates the condition. + """ warehouse_id: VariableOr[str] """ @@ -166,12 +182,13 @@ class AlertDict(TypedDict, total=False): custom_description: VariableOrOptional[str] """ - Custom description for the alert. Interpreted according to `custom_template_format`. + Custom description for the alert, used as the notification body. Interpreted according to `custom_template_format`. + The available template variables are listed at https://docs.databricks.com/aws/en/sql/user/alerts/create#notification-templates. """ custom_summary: VariableOrOptional[str] """ - Custom summary for the alert. Interpreted according to `custom_template_format`. + Custom summary for the alert, used as the notification subject. Interpreted according to `custom_template_format`. """ custom_template_format: VariableOrOptional[CustomTemplateFormatParam] @@ -232,9 +249,9 @@ class AlertDict(TypedDict, total=False): run_as_user_name: VariableOrOptional[str] """ - [DEPRECATED] The run as username or application ID of service principal. + [DEPRECATED] Deprecated: Use `run_as` field instead. This field will be removed in a future release. + The run as username or application ID of service principal. On Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role. - Deprecated: Use `run_as` field instead. This field will be removed in a future release. """ diff --git a/python/databricks/bundles/alerts/_models/alert_v2_evaluation.py b/python/databricks/bundles/alerts/_models/alert_v2_evaluation.py index 4d599872ccb..fd3cb65740c 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_evaluation.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_evaluation.py @@ -37,7 +37,7 @@ class AlertV2Evaluation: comparison_operator: VariableOr[ComparisonOperator] """ - Operator used for comparison in alert evaluation. + Operator used for comparison in alert evaluation. The alert is triggered when the comparison of the source value with the threshold is true. `IS_NULL` and `IS_NOT_NULL` take no threshold. """ source: VariableOr[AlertV2OperandColumn] @@ -47,7 +47,7 @@ class AlertV2Evaluation: empty_result_state: VariableOrOptional[AlertEvaluationState] = None """ - Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. + Alert state if result is empty. If not set, an empty result sets the state to `ERROR`. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. """ notification: VariableOrOptional[AlertV2Notification] = None @@ -57,7 +57,7 @@ class AlertV2Evaluation: threshold: VariableOrOptional[AlertV2Operand] = None """ - Threshold to user for alert evaluation, can be a column or a value. + Threshold to compare the source column against, either another column or a fixed value. Not needed when `comparison_operator` is `IS_NULL` or `IS_NOT_NULL`. """ @classmethod @@ -73,7 +73,7 @@ class AlertV2EvaluationDict(TypedDict, total=False): comparison_operator: VariableOr[ComparisonOperatorParam] """ - Operator used for comparison in alert evaluation. + Operator used for comparison in alert evaluation. The alert is triggered when the comparison of the source value with the threshold is true. `IS_NULL` and `IS_NOT_NULL` take no threshold. """ source: VariableOr[AlertV2OperandColumnParam] @@ -83,7 +83,7 @@ class AlertV2EvaluationDict(TypedDict, total=False): empty_result_state: VariableOrOptional[AlertEvaluationStateParam] """ - Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. + Alert state if result is empty. If not set, an empty result sets the state to `ERROR`. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. """ notification: VariableOrOptional[AlertV2NotificationParam] @@ -93,7 +93,7 @@ class AlertV2EvaluationDict(TypedDict, total=False): threshold: VariableOrOptional[AlertV2OperandParam] """ - Threshold to user for alert evaluation, can be a column or a value. + Threshold to compare the source column against, either another column or a fixed value. Not needed when `comparison_operator` is `IS_NULL` or `IS_NOT_NULL`. """ diff --git a/python/databricks/bundles/alerts/_models/alert_v2_notification.py b/python/databricks/bundles/alerts/_models/alert_v2_notification.py index 81c892f1d90..f57b19f21a7 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_notification.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_notification.py @@ -32,6 +32,9 @@ class AlertV2Notification: """ subscriptions: VariableOrList[AlertV2Subscription] = field(default_factory=list) + """ + Users and notification destinations that receive notifications. + """ @classmethod def from_dict(cls, value: "AlertV2NotificationDict") -> "Self": @@ -57,6 +60,9 @@ class AlertV2NotificationDict(TypedDict, total=False): """ subscriptions: VariableOrList[AlertV2SubscriptionParam] + """ + Users and notification destinations that receive notifications. + """ AlertV2NotificationParam = AlertV2NotificationDict | AlertV2Notification diff --git a/python/databricks/bundles/alerts/_models/alert_v2_operand.py b/python/databricks/bundles/alerts/_models/alert_v2_operand.py index 5e39c938860..5909ec20245 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_operand.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_operand.py @@ -24,8 +24,14 @@ class AlertV2Operand: """""" column: VariableOrOptional[AlertV2OperandColumn] = None + """ + Compare the source against another column of the query result. + """ value: VariableOrOptional[AlertV2OperandValue] = None + """ + Compare the source against a fixed value. + """ @classmethod def from_dict(cls, value: "AlertV2OperandDict") -> "Self": @@ -39,8 +45,14 @@ class AlertV2OperandDict(TypedDict, total=False): """""" column: VariableOrOptional[AlertV2OperandColumnParam] + """ + Compare the source against another column of the query result. + """ value: VariableOrOptional[AlertV2OperandValueParam] + """ + Compare the source against a fixed value. + """ AlertV2OperandParam = AlertV2OperandDict | AlertV2Operand diff --git a/python/databricks/bundles/alerts/_models/alert_v2_operand_column.py b/python/databricks/bundles/alerts/_models/alert_v2_operand_column.py index da2f90107e8..aecd00f529e 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_operand_column.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_operand_column.py @@ -17,13 +17,20 @@ class AlertV2OperandColumn: """""" name: VariableOr[str] + """ + Name of the column in the query result. + """ aggregation: VariableOrOptional[Aggregation] = None """ - If not set, the behavior is equivalent to using `First row` in the UI. + Aggregation applied to the column across all rows of the query result: `SUM`, `COUNT`, `COUNT_DISTINCT`, `AVG`, `MEDIAN`, `MIN`, `MAX` or `STDDEV`. + If not set, the value in the first row is used, which is equivalent to using `First row` in the UI. """ display: VariableOrOptional[str] = None + """ + Label for the column in notifications. Defaults to `name`. + """ @classmethod def from_dict(cls, value: "AlertV2OperandColumnDict") -> "Self": @@ -37,13 +44,20 @@ class AlertV2OperandColumnDict(TypedDict, total=False): """""" name: VariableOr[str] + """ + Name of the column in the query result. + """ aggregation: VariableOrOptional[AggregationParam] """ - If not set, the behavior is equivalent to using `First row` in the UI. + Aggregation applied to the column across all rows of the query result: `SUM`, `COUNT`, `COUNT_DISTINCT`, `AVG`, `MEDIAN`, `MIN`, `MAX` or `STDDEV`. + If not set, the value in the first row is used, which is equivalent to using `First row` in the UI. """ display: VariableOrOptional[str] + """ + Label for the column in notifications. Defaults to `name`. + """ AlertV2OperandColumnParam = AlertV2OperandColumnDict | AlertV2OperandColumn diff --git a/python/databricks/bundles/alerts/_models/alert_v2_operand_value.py b/python/databricks/bundles/alerts/_models/alert_v2_operand_value.py index 5abc7f386ee..56e579824d7 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_operand_value.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_operand_value.py @@ -16,10 +16,19 @@ class AlertV2OperandValue: """""" bool_value: VariableOrOptional[bool] = None + """ + Boolean threshold, for boolean columns. + """ double_value: VariableOrOptional[float] = None + """ + Numeric threshold, for numeric columns. + """ string_value: VariableOrOptional[str] = None + """ + String threshold, for string or timestamp columns. + """ @classmethod def from_dict(cls, value: "AlertV2OperandValueDict") -> "Self": @@ -33,10 +42,19 @@ class AlertV2OperandValueDict(TypedDict, total=False): """""" bool_value: VariableOrOptional[bool] + """ + Boolean threshold, for boolean columns. + """ double_value: VariableOrOptional[float] + """ + Numeric threshold, for numeric columns. + """ string_value: VariableOrOptional[str] + """ + String threshold, for string or timestamp columns. + """ AlertV2OperandValueParam = AlertV2OperandValueDict | AlertV2OperandValue diff --git a/python/databricks/bundles/alerts/_models/alert_v2_subscription.py b/python/databricks/bundles/alerts/_models/alert_v2_subscription.py index 8d379a1ced7..44b1807a50d 100644 --- a/python/databricks/bundles/alerts/_models/alert_v2_subscription.py +++ b/python/databricks/bundles/alerts/_models/alert_v2_subscription.py @@ -16,8 +16,14 @@ class AlertV2Subscription: """""" destination_id: VariableOrOptional[str] = None + """ + ID of the notification destination to notify, as returned by the Notification Destinations API. + """ user_email: VariableOrOptional[str] = None + """ + Email address of the workspace user to notify. + """ @classmethod def from_dict(cls, value: "AlertV2SubscriptionDict") -> "Self": @@ -31,8 +37,14 @@ class AlertV2SubscriptionDict(TypedDict, total=False): """""" destination_id: VariableOrOptional[str] + """ + ID of the notification destination to notify, as returned by the Notification Destinations API. + """ user_email: VariableOrOptional[str] + """ + Email address of the workspace user to notify. + """ AlertV2SubscriptionParam = AlertV2SubscriptionDict | AlertV2Subscription diff --git a/python/databricks/bundles/alerts/_models/cron_schedule.py b/python/databricks/bundles/alerts/_models/cron_schedule.py index 987a9a1056b..629cf00b4d7 100644 --- a/python/databricks/bundles/alerts/_models/cron_schedule.py +++ b/python/databricks/bundles/alerts/_models/cron_schedule.py @@ -21,7 +21,7 @@ class CronSchedule: quartz_cron_schedule: VariableOr[str] """ - A cron expression using quartz syntax that specifies the schedule for this pipeline. + A cron expression using quartz syntax that specifies the schedule for this alert. Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html """ @@ -34,7 +34,7 @@ class CronSchedule: pause_status: VariableOrOptional[SchedulePauseStatus] = None """ - Indicate whether this schedule is paused or not. + Indicates whether this schedule is paused. While paused, the alert is not evaluated. """ @classmethod @@ -50,7 +50,7 @@ class CronScheduleDict(TypedDict, total=False): quartz_cron_schedule: VariableOr[str] """ - A cron expression using quartz syntax that specifies the schedule for this pipeline. + A cron expression using quartz syntax that specifies the schedule for this alert. Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html """ @@ -63,7 +63,7 @@ class CronScheduleDict(TypedDict, total=False): pause_status: VariableOrOptional[SchedulePauseStatusParam] """ - Indicate whether this schedule is paused or not. + Indicates whether this schedule is paused. While paused, the alert is not evaluated. """ diff --git a/python/databricks/bundles/features/_models/delta_table_source.py b/python/databricks/bundles/features/_models/delta_table_source.py index 3caedb40fa6..e02fcd22b88 100644 --- a/python/databricks/bundles/features/_models/delta_table_source.py +++ b/python/databricks/bundles/features/_models/delta_table_source.py @@ -29,15 +29,11 @@ class DeltaTableSource: filter_condition: VariableOrOptional[str] = None """ - Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections. + A single WHERE clause to filter the Delta table before applying transformations. + The predicate is evaluated for each row. """ transformation_sql: VariableOrOptional[str] = None - """ - 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. - """ @classmethod def from_dict(cls, value: "DeltaTableSourceDict") -> "Self": @@ -64,15 +60,11 @@ class DeltaTableSourceDict(TypedDict, total=False): filter_condition: VariableOrOptional[str] """ - Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections. + A single WHERE clause to filter the Delta table before applying transformations. + The predicate is evaluated for each row. """ transformation_sql: VariableOrOptional[str] - """ - 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. - """ DeltaTableSourceParam = DeltaTableSourceDict | DeltaTableSource diff --git a/python/databricks/bundles/model_serving_endpoints/_models/model_serving_endpoint.py b/python/databricks/bundles/model_serving_endpoints/_models/model_serving_endpoint.py index 64ecfbd87d1..6e18317e1cd 100644 --- a/python/databricks/bundles/model_serving_endpoints/_models/model_serving_endpoint.py +++ b/python/databricks/bundles/model_serving_endpoints/_models/model_serving_endpoint.py @@ -74,6 +74,9 @@ class ModelServingEndpoint(Resource): """ description: VariableOrOptional[str] = None + """ + The description of the serving endpoint. + """ email_notifications: VariableOrOptional[EmailNotifications] = None """ @@ -145,6 +148,9 @@ class ModelServingEndpointDict(TypedDict, total=False): """ description: VariableOrOptional[str] + """ + The description of the serving endpoint. + """ email_notifications: VariableOrOptional[EmailNotificationsParam] """ diff --git a/python/databricks/bundles/model_serving_endpoints/_models/route.py b/python/databricks/bundles/model_serving_endpoints/_models/route.py index eba4336b0fc..e609aa81376 100644 --- a/python/databricks/bundles/model_serving_endpoints/_models/route.py +++ b/python/databricks/bundles/model_serving_endpoints/_models/route.py @@ -21,6 +21,9 @@ class Route: """ served_entity_name: VariableOrOptional[str] = None + """ + The name of the served entity this route configures traffic for. + """ served_model_name: VariableOrOptional[str] = None """ @@ -44,6 +47,9 @@ class RouteDict(TypedDict, total=False): """ served_entity_name: VariableOrOptional[str] + """ + The name of the served entity this route configures traffic for. + """ served_model_name: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/model_serving_endpoints/_models/served_entity_input.py b/python/databricks/bundles/model_serving_endpoints/_models/served_entity_input.py index e40050ca3e6..f5d2e78c42a 100644 --- a/python/databricks/bundles/model_serving_endpoints/_models/served_entity_input.py +++ b/python/databricks/bundles/model_serving_endpoints/_models/served_entity_input.py @@ -36,6 +36,9 @@ class ServedEntityInput: """ entity_version: VariableOrOptional[str] = None + """ + The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function. + """ environment_vars: VariableOrDict[str] = field(default_factory=dict) """ @@ -121,6 +124,9 @@ class ServedEntityInputDict(TypedDict, total=False): """ entity_version: VariableOrOptional[str] + """ + The version of the model in Databricks Model Registry or Unity Catalog to be served, or empty if the entity is a FEATURE_SPEC function. + """ environment_vars: VariableOrDict[str] """ diff --git a/python/databricks/bundles/model_serving_endpoints/_models/served_model_input.py b/python/databricks/bundles/model_serving_endpoints/_models/served_model_input.py index 90c98757af5..3e1922f71dd 100644 --- a/python/databricks/bundles/model_serving_endpoints/_models/served_model_input.py +++ b/python/databricks/bundles/model_serving_endpoints/_models/served_model_input.py @@ -24,8 +24,14 @@ class ServedModelInput: """""" model_name: VariableOr[str] + """ + The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**. + """ model_version: VariableOr[str] + """ + The version of the model in Databricks Model Registry or Unity Catalog to be served. + """ scale_to_zero_enabled: VariableOr[bool] """ @@ -101,8 +107,14 @@ class ServedModelInputDict(TypedDict, total=False): """""" model_name: VariableOr[str] + """ + The name of the model in Databricks Model Registry to be served or, if the model resides in Unity Catalog, the full name of the model in the form of **catalog_name.schema_name.model_name**. + """ model_version: VariableOr[str] + """ + The version of the model in Databricks Model Registry or Unity Catalog to be served. + """ scale_to_zero_enabled: VariableOr[bool] """