* Managed services: A key configuration can be used to encrypt a workspace's notebook and - * secret data in the control plane, as well as Databricks SQL queries and query history. * - * Storage: A key configuration can be used to encrypt a workspace's DBFS and EBS data in the data - * plane. + *
In both of these cases, the key configuration's ID is used when creating a new workspace. * This Preview feature is available if your account is on the E2 version of the platform. @@ -274,40 +276,60 @@ public EndpointsAPI endpoints() { * for Databricks OAuth tokens, which can be used to access Databricks APIs. Token federation * eliminates the need to manage Databricks secrets, and allows you to centralize management of * token issuance policies in your IdP. Databricks token federation is typically used in - * combination with [SCIM], so users in your IdP are synchronized into your Databricks account. + * combination with SCIM, so users in + * your IdP are synchronized into your Databricks account. * *
Token federation is configured in your Databricks account using an account federation - * policy. An account federation policy specifies: * which IdP, or issuer, your Databricks account - * should accept tokens from * how to determine which Databricks user, or subject, a token is - * issued for + * policy. An account federation policy specifies: * - *
To configure a federation policy, you provide the following: * The required token - * __issuer__, as specified in the “iss” claim of your tokens. The issuer is an https URL that - * identifies your IdP. * The allowed token __audiences__, as specified in the “aud” claim of your - * tokens. This identifier is intended to represent the recipient of the token. As long as the - * audience in the token matches at least one audience in the policy, the token is considered a - * match. If unspecified, the default value is your Databricks account id. * The __subject - * claim__, which indicates which token claim contains the Databricks username of the user the - * token was issued for. If unspecified, the default value is “sub”. * Optionally, the public keys - * used to validate the signature of your tokens, in JWKS format. If unspecified (recommended), - * Databricks automatically fetches the public keys from your issuer’s well known endpoint. - * Databricks strongly recommends relying on your issuer’s well known endpoint for discovering - * public keys. + *
An example federation policy is: ``` issuer: "https://idp.mycompany.com/oidc" audiences: - * ["databricks"] subject_claim: "sub" ``` + *
To configure a federation policy, you provide the following: + * + *
An example federation policy is: + * + *
{@code
+ * issuer: "https://idp.mycompany.com/oidc"
+ * audiences: ["databricks"]
+ * subject_claim: "sub"
+ * }
*
* An example JWT token body that matches this policy and could be used to authenticate to - * Databricks as user `username@mycompany.com` is: ``` { "iss": "https://idp.mycompany.com/oidc", - * "aud": "databricks", "sub": "username@mycompany.com" } ``` + * Databricks as user {@code username@mycompany.com} is: + * + *
+ * {
+ * "iss": "https://idp.mycompany.com/oidc",
+ * "aud": "databricks",
+ * "sub": "username@mycompany.com"
+ * }
+ * You may also need to configure your IdP to generate tokens for your users to exchange with * Databricks, if your users do not already have the ability to generate tokens that are * compatible with your federation policy. * *
You do not need to configure an OAuth application in Databricks to use token federation. - * - *
[SCIM]: https://docs.databricks.com/admin/users-groups/scim/index.html */ public AccountFederationPolicyAPI federationPolicy() { return federationPolicyAPI; @@ -342,9 +364,14 @@ public AccountIamV2API iamV2() { * console and account APIs. If the feature is disabled for the account, all access is allowed for * this account. There is support for allow lists (inclusion) and block lists (exclusion). * - *
When a connection is attempted: 1. **First, all block lists are checked.** If the connection - * IP address matches any block list, the connection is rejected. 2. **If the connection was not - * rejected by block lists**, the IP address is compared with the allow lists. + *
When a connection is attempted: + * + *
If there is at least one allow list for the account, the connection is allowed only if the * IP address matches an allow list. If there are no allow lists for the account, all IP addresses @@ -362,8 +389,8 @@ public AccountIpAccessListsAPI ipAccessLists() { /** * These APIs manage log delivery configurations for this account. The two supported log types for - * this API are _billable usage logs_ (AWS only) and _audit logs_ (AWS and GCP). This feature is - * in Public Preview. This feature works with all account ID types. + * this API are billable usage logs (AWS only) and audit logs (AWS and GCP). This + * feature is in Public Preview. This feature works with all account ID types. * *
Log delivery works with all account types. However, if your account is on the E2 version of * the platform or on a select custom plan that allows multiple workspaces per account, you can @@ -372,52 +399,68 @@ public AccountIpAccessListsAPI ipAccessLists() { * *
The high-level flow of billable usage delivery (AWS only): * - *
1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy. - * Using Databricks APIs, call the Account API to create a [storage configuration - * object](:method:Storage/Create) that uses the bucket name. - * - *
2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details, - * including the required IAM role policies and trust relationship, see [Billable usage log - * delivery]. Using Databricks APIs, call the Account API to create a [credential configuration - * object](:method:Credentials/Create) that uses the IAM role's ARN. + *
3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to - * [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and - * storage configuration objects from previous steps. You can specify if the logs should include - * all events of that log type in your account (_Account level_ delivery) or only events for a - * specific set of workspaces (_workspace level_ delivery). Account level log delivery applies to - * all current and future workspaces plus account level logs, while workspace level log delivery - * solely delivers logs related to the specified workspaces. You can create multiple types of - * delivery configurations per account. + *
For billable usage delivery (AWS only): * - *
For billable usage delivery (AWS only): * For more information about billable usage logs,
- * see [Billable usage log delivery]. For the CSV schema, see the [Usage page]. * The delivery
- * location is ` For audit log delivery (AWS and GCP): * For more information about about audit log delivery,
- * see Audit log delivery [AWS] or [GCP], which includes information about the used JSON schema. *
- * The delivery location is
- * ` For audit log delivery (AWS and GCP):
*
- * [AWS]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html
- * [Billable usage log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
- * [GCP]: https://docs.databricks.com/gcp/en/admin/account-settings/audit-logs [Usage page]:
- * https://docs.databricks.com/administration-guide/account-settings/usage.html [create a new AWS
- * S3 bucket]: https://docs.databricks.com/administration-guide/account-api/aws-storage.html
+ * [configure serverless secure connectivity]:
- * https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security
+ * serverless compute resources to your Azure resources using Azure Private Link. See configure
+ * serverless secure connectivity.
*/
public NetworkConnectivityAPI networkConnectivity() {
return networkConnectivityAPI;
@@ -510,30 +551,49 @@ public PublishedAppIntegrationAPI publishedAppIntegration() {
* clusters, among others.
*
* Workload identity federation is configured in your Databricks account using a service
- * principal federation policy. A service principal federation policy specifies: * which IdP, or
- * issuer, the service principal is allowed to authenticate from * which workload identity, or
- * subject, is allowed to authenticate as the Databricks service principal
+ * principal federation policy. A service principal federation policy specifies:
+ *
+ * To configure a federation policy, you provide the following:
*
- * To configure a federation policy, you provide the following: * The required token
- * __issuer__, as specified in the “iss” claim of workload identity tokens. The issuer is an https
- * URL that identifies the workload identity provider. * The required token __subject__, as
- * specified in the “sub” claim of workload identity tokens. The subject uniquely identifies the
- * workload in the workload runtime environment. * The allowed token __audiences__, as specified
- * in the “aud” claim of workload identity tokens. The audience is intended to represent the
- * recipient of the token. As long as the audience in the token matches at least one audience in
- * the policy, the token is considered a match. If unspecified, the default value is your
- * Databricks account id. * Optionally, the public keys used to validate the signature of the
- * workload identity tokens, in JWKS format. If unspecified (recommended), Databricks
- * automatically fetches the public keys from the issuer’s well known endpoint. Databricks
- * strongly recommends relying on the issuer’s well known endpoint for discovering public keys.
+ * An example service principal federation policy, for a Github Actions workload, is: ```
- * issuer: "https://token.actions.githubusercontent.com" audiences:
- * ["https://github.com/my-github-org"] subject: "repo:my-github-org/my-repo:environment:prod" ```
+ * An example service principal federation policy, for a Github Actions workload, is:
+ *
+ * An example JWT token body that matches this policy and could be used to authenticate to
- * Databricks is: ``` { "iss": "https://token.actions.githubusercontent.com", "aud":
- * "https://github.com/my-github-org", "sub": "repo:my-github-org/my-repo:environment:prod" } ```
+ * Databricks is:
+ *
+ * You may also need to configure the workload runtime to generate tokens for your workloads.
*
@@ -548,16 +608,13 @@ public ServicePrincipalFederationPolicyAPI servicePrincipalFederationPolicy() {
*
* You can use the generated secrets to obtain OAuth access tokens for a service principal,
* which can then be used to access Databricks Accounts and Workspace APIs. For more information,
- * see [Authentication using OAuth tokens for service principals].
+ * see Authentication
+ * using OAuth tokens for service principals.
*
* In addition, the generated secrets can be used to configure the Databricks Terraform
- * Provider to authenticate with the service principal. For more information, see [Databricks
- * Terraform Provider].
- *
- * [Authentication using OAuth tokens for service principals]:
- * https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform
- * Provider]:
- * https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal
+ * Provider to authenticate with the service principal. For more information, see Databricks
+ * Terraform Provider.
*/
public ServicePrincipalSecretsAPI servicePrincipalSecrets() {
return servicePrincipalSecretsAPI;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java
index d79958ec0..30b5ea252 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java
@@ -588,7 +588,7 @@ public AgentBricksAPI agentBricks() {
}
/**
- * **AI Search Endpoint**: Represents the compute resources to host AI Search indexes.
+ * AI Search Endpoint: Represents the compute resources to host AI Search indexes.
* AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.
*/
public AiSearchAPI aiSearch() {
@@ -599,7 +599,7 @@ public AiSearchAPI aiSearch() {
* The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL
* object that periodically runs a query, evaluates a condition of its result, and notifies one or
* more users and/or notification destinations if the condition was met. Alerts can be scheduled
- * using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.
+ * using the {@code sql_task} type of the Jobs API, e.g. :method:jobs/create.
*/
public AlertsAPI alerts() {
return alertsAPI;
@@ -609,12 +609,10 @@ public AlertsAPI alerts() {
* The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL
* object that periodically runs a query, evaluates a condition of its result, and notifies one or
* more users and/or notification destinations if the condition was met. Alerts can be scheduled
- * using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.
+ * using the {@code sql_task} type of the Jobs API, e.g. :method:jobs/create.
*
- * **Warning**: This API is deprecated. Please see the latest version of the Databricks SQL
- * API. [Learn more]
- *
- * [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
+ * Warning: This API is deprecated. Please see the latest version of the Databricks SQL
+ * API. Learn more
*/
public AlertsLegacyAPI alertsLegacy() {
return alertsLegacyAPI;
@@ -639,8 +637,9 @@ public AppsSettingsAPI appsSettings() {
}
/**
- * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
- * in UC so that users can leverage these artifacts on compute configured with shared access mode.
+ * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the {@code
+ * allowlist} in UC so that users can leverage these artifacts on compute configured with shared
+ * access mode.
*/
public ArtifactAllowlistsAPI artifactAllowlists() {
return artifactAllowlistsAPI;
@@ -707,18 +706,28 @@ public CleanRoomsAPI cleanRooms() {
* rules. These rules specify which attributes or attribute values can be used during cluster
* creation. Cluster policies have ACLs that limit their use to specific users and groups.
*
- * With cluster policies, you can: - Auto-install cluster libraries on the next restart by
- * listing them in the policy's "libraries" field (Public Preview). - Limit users to creating
- * clusters with the prescribed settings. - Simplify the user interface, enabling more users to
- * create clusters, by fixing and hiding some fields. - Manage costs by setting limits on
- * attributes that impact the hourly rate.
+ * With cluster policies, you can:
+ *
+ * Cluster policy permissions limit which policies a user can select in the Policy drop-down
- * when the user creates a cluster: - A user who has unrestricted cluster create permission can
- * select the Unrestricted policy and create fully-configurable clusters. - A user who has both
- * unrestricted cluster create permission and access to cluster policies can select the
- * Unrestricted policy and policies they have access to. - A user that has access to only cluster
- * policies, can select the policies they have access to.
+ * when the user creates a cluster:
+ *
+ * If no policies exist in the workspace, the Policy drop-down doesn't appear. Only admin users
* can create, edit, and delete policies. Admin users also have access to all policies.
@@ -816,9 +825,9 @@ public ConsumerProvidersAPI consumerProviders() {
* your cloud tenant. Each credential is subject to Unity Catalog access-control policies that
* control which users and groups can access the credential.
*
- * To create credentials, you must be a Databricks account admin or have the `CREATE SERVICE
- * CREDENTIAL` privilege. The user who creates the credential can delegate ownership to another
- * user or group to manage permissions on it.
+ * To create credentials, you must be a Databricks account admin or have the {@code CREATE
+ * SERVICE CREDENTIAL} privilege. The user who creates the credential can delegate ownership to
+ * another user or group to manage permissions on it.
*/
public CredentialsAPI credentials() {
return credentialsAPI;
@@ -851,13 +860,11 @@ public DashboardWidgetsAPI dashboardWidgets() {
* In general, there is little need to modify dashboards using the API. However, it can be useful
* to use dashboard objects to look-up a collection of related query IDs. The API can also be used
* to duplicate multiple dashboards at once since you can get a dashboard definition with a GET
- * request and then POST it to create a new one. Dashboards can be scheduled using the `sql_task`
- * type of the Jobs API, e.g. :method:jobs/create.
- *
- * **Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn
- * more]
+ * request and then POST it to create a new one. Dashboards can be scheduled using the {@code
+ * sql_task} type of the Jobs API, e.g. :method:jobs/create.
*
- * [Learn more]: https://docs.databricks.com/en/dashboards/
+ * Warning: This API is deprecated. Please use the AI/BI Dashboards API instead. Learn more
*/
public DashboardsAPI dashboards() {
return dashboardsAPI;
@@ -872,25 +879,26 @@ public DataClassificationAPI dataClassification() {
return dataClassificationAPI;
}
- /** Manage the data quality of Unity Catalog objects (currently support `schema` and `table`) */
+ /**
+ * Manage the data quality of Unity Catalog objects (currently support {@code schema} and {@code
+ * table})
+ */
public DataQualityAPI dataQuality() {
return dataQualityAPI;
}
/**
* This API is provided to assist you in making new query objects. When creating a query object,
- * you may optionally specify a `data_source_id` for the SQL warehouse against which it will run.
- * If you don't already know the `data_source_id` for your desired SQL warehouse, this API will
- * help you find it.
+ * you may optionally specify a {@code data_source_id} for the SQL warehouse against which it will
+ * run. If you don't already know the {@code data_source_id} for your desired SQL warehouse, this
+ * API will help you find it.
*
* This API does not support searches. It returns the full list of SQL warehouses in your
- * workspace. We advise you to use any text editor, REST client, or `grep` to search the response
- * from this API for the name of your SQL warehouse as it appears in Databricks SQL.
- *
- * **Warning**: This API is deprecated. Please see the latest version of the Databricks SQL
- * API. [Learn more]
+ * workspace. We advise you to use any text editor, REST client, or {@code grep} to search the
+ * response from this API for the name of your SQL warehouse as it appears in Databricks SQL.
*
- * [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
+ * Warning: This API is deprecated. Please see the latest version of the Databricks SQL
+ * API. Learn more
*/
public DataSourcesAPI dataSources() {
return dataSourcesAPI;
@@ -916,17 +924,15 @@ public DbfsExt dbfs() {
*
* There are three levels of permission:
*
- * - `CAN_VIEW`: Allows read-only access
+ * - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`)
- *
- * - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify permissions (superset of
- * `CAN_RUN`)
- *
- * **Warning**: This API is deprecated. Please see the latest version of the Databricks SQL
- * API. [Learn more]
- *
- * [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
+ * Warning: This API is deprecated. Please see the latest version of the Databricks SQL
+ * API. Learn more
*/
public DbsqlPermissionsAPI dbsqlPermissions() {
return dbsqlPermissionsAPI;
@@ -989,7 +995,7 @@ public ExternalLineageAPI externalLineage() {
* directly.
*
* To create external locations, you must be a metastore admin or a user with the
- * **CREATE_EXTERNAL_LOCATION** privilege.
+ * CREATE_EXTERNAL_LOCATION privilege.
*/
public ExternalLocationsAPI externalLocations() {
return externalLocationsAPI;
@@ -1029,18 +1035,18 @@ public FeatureStoreAPI featureStore() {
* directories by referring to their URI. The API makes working with file content as raw bytes
* easier and more efficient.
*
- * The API supports [Unity Catalog volumes], where files and directories to operate on are
- * specified using their volume URI path, which follows the format
- * /Volumes/<catalog_name>/<schema_name>/<volume_name>/<path_to_file>.
+ * The API supports Unity Catalog
+ * volumes, where files and directories to operate on are specified using their volume URI
+ * path, which follows the format
+ * /Volumes/<catalog_name>/<schema_name>/<volume_name>/<path_to_file>.
*
- * The Files API has two distinct endpoints, one for working with files (`/fs/files`) and
- * another one for working with directories (`/fs/directories`). Both endpoints use the standard
- * HTTP methods GET, HEAD, PUT, and DELETE to manage files and directories specified using their
- * URI path. The path is always absolute.
+ * The Files API has two distinct endpoints, one for working with files ({@code /fs/files}) and
+ * another one for working with directories ({@code /fs/directories}). Both endpoints use the
+ * standard HTTP methods GET, HEAD, PUT, and DELETE to manage files and directories specified
+ * using their URI path. The path is always absolute.
*
* Use of Files API may incur Databricks data transfer charges.
- *
- * [Unity Catalog volumes]: https://docs.databricks.com/en/connect/unity-catalog/volumes.html
*/
public FilesAPI files() {
return filesAPI;
@@ -1057,7 +1063,7 @@ public ForecastingAPI forecasting() {
* The function implementation can be any SQL expression or Query, and it can be invoked
* wherever a table reference is allowed in a query. In Unity Catalog, a function resides at the
* same level as a table, so it can be referenced with the form
- * __catalog_name__.__schema_name__.__function_name__.
+ * catalog_name.schema_name.function_name.
*/
public FunctionsAPI functions() {
return functionsAPI;
@@ -1076,9 +1082,9 @@ public GenieAPI genie() {
/**
* Registers personal access token for Databricks to do operations on behalf of the user.
*
- * See [more info].
- *
- * [more info]: https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html
+ * See more
+ * info.
*/
public GitCredentialsAPI gitCredentials() {
return gitCredentialsAPI;
@@ -1088,11 +1094,11 @@ public GitCredentialsAPI gitCredentials() {
* The Global Init Scripts API enables Workspace administrators to configure global initialization
* scripts for their workspace. These scripts run on every node in every cluster in the workspace.
*
- * **Important:** Existing clusters must be restarted to pick up any changes made to global
+ * Important: Existing clusters must be restarted to pick up any changes made to global
* init scripts. Global init scripts are run in order. If the init script returns with a bad exit
* code, the Apache Spark container fails to launch and init scripts with later position are
- * skipped. If enough containers fail, the entire cluster fails with a
- * `GLOBAL_INIT_SCRIPT_FAILURE` error code.
+ * skipped. If enough containers fail, the entire cluster fails with a {@code
+ * GLOBAL_INIT_SCRIPT_FAILURE} error code.
*/
public GlobalInitScriptsAPI globalInitScripts() {
return globalInitScriptsAPI;
@@ -1150,10 +1156,9 @@ public InstancePoolsAPI instancePools() {
/**
* The Instance Profiles API allows admins to add, list, and remove instance profiles that users
* can launch clusters with. Regular users can list the instance profiles available to them. See
- * [Secure access to S3 buckets] using instance profiles for more information.
- *
- * [Secure access to S3 buckets]:
- * https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html
+ * Secure
+ * access to S3 buckets using instance profiles for more information.
*/
public InstanceProfilesAPI instanceProfiles() {
return instanceProfilesAPI;
@@ -1166,9 +1171,14 @@ public InstanceProfilesAPI instanceProfiles() {
* the feature is disabled for a workspace, all access is allowed for this workspace. There is
* support for allow lists (inclusion) and block lists (exclusion).
*
- * When a connection is attempted: 1. **First, all block lists are checked.** If the connection
- * IP address matches any block list, the connection is rejected. 2. **If the connection was not
- * rejected by block lists**, the IP address is compared with the allow lists.
+ * When a connection is attempted:
+ *
+ * If there is at least one allow list for the workspace, the connection is allowed only if the
* IP address matches an allow list. If there are no allow lists for the workspace, all IP
@@ -1195,13 +1205,12 @@ public IpAccessListsAPI ipAccessLists() {
* tasks using notebooks, JARS, Spark Declarative Pipelines, or Python, Scala, Spark submit, and
* Java applications.
*
- * You should never hard code secrets or store them in plain text. Use the [Secrets CLI] to
- * manage secrets in the [Databricks CLI]. Use the [Secrets utility] to reference secrets in
- * notebooks and jobs.
- *
- * [Databricks CLI]: https://docs.databricks.com/dev-tools/cli/index.html [Secrets CLI]:
- * https://docs.databricks.com/dev-tools/cli/secrets-cli.html [Secrets utility]:
- * https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-secrets
+ * You should never hard code secrets or store them in plain text. Use the Secrets CLI to manage
+ * secrets in the Databricks
+ * CLI. Use the Secrets
+ * utility to reference secrets in notebooks and jobs.
*/
public JobsAPI jobs() {
return jobsAPI;
@@ -1274,9 +1283,9 @@ public MetastoresAPI metastores() {
/**
* Note: This API reference documents APIs for the Workspace Model Registry. Databricks recommends
- * using [Models in Unity Catalog](/api/workspace/registeredmodels) instead. Models in Unity
- * Catalog provides centralized model governance, cross-workspace access, lineage, and deployment.
- * Workspace Model Registry will be deprecated in the future.
+ * using Models in Unity Catalog instead. Models in
+ * Unity Catalog provides centralized model governance, cross-workspace access, lineage, and
+ * deployment. Workspace Model Registry will be deprecated in the future.
*
* The Workspace Model Registry is a centralized model repository and a UI and set of APIs that
* enable you to manage the full lifecycle of MLflow Models.
@@ -1291,8 +1300,8 @@ public ModelRegistryAPI modelRegistry() {
* across Databricks workspaces.
*
* This API reference documents the REST endpoints for managing model versions in Unity
- * Catalog. For more details, see the [registered models API
- * docs](/api/workspace/registeredmodels).
+ * Catalog. For more details, see the registered models
+ * API docs.
*/
public ModelVersionsAPI modelVersions() {
return modelVersionsAPI;
@@ -1323,30 +1332,41 @@ public PermissionMigrationAPI permissionMigration() {
/**
* Permissions API are used to create read, write, edit, update and manage access for various
- * users on different objects and endpoints. * **[Apps permissions](:service:apps)** — Manage
- * which users can manage or use apps. * **[Cluster permissions](:service:clusters)** — Manage
- * which users can manage, restart, or attach to clusters. * **[Cluster policy
- * permissions](:service:clusterpolicies)** — Manage which users can use cluster policies. *
- * **[Spark Declarative Pipelines permissions](:service:pipelines)** — Manage which users can
- * view, manage, run, cancel, or own a Spark Declarative Pipeline. * **[Job
- * permissions](:service:jobs)** — Manage which users can view, manage, trigger, cancel, or own a
- * job. * **[MLflow experiment permissions](:service:experiments)** — Manage which users can read,
- * edit, or manage MLflow experiments. * **[MLflow registered model
- * permissions](:service:modelregistry)** — Manage which users can read, edit, or manage MLflow
- * registered models. * **[Instance Pool permissions](:service:instancepools)** — Manage which
- * users can manage or attach to pools. * **[Repo permissions](repos)** — Manage which users can
- * read, run, edit, or manage a repo. * **[Serving endpoint
- * permissions](:service:servingendpoints)** — Manage which users can view, query, or manage a
- * serving endpoint. * **[SQL warehouse permissions](:service:warehouses)** — Manage which users
- * can use or manage SQL warehouses. * **[Token permissions](:service:tokenmanagement)** — Manage
- * which users can create or use tokens. * **[Workspace object permissions](:service:workspace)**
- * — Manage which users can read, run, edit, or manage alerts, dbsql-dashboards, directories,
- * files, notebooks and queries. For the mapping of the required permissions for specific actions
- * or abilities and other important information, see [Access Control]. Note that to manage access
- * control on service principals, use **[Account Access Control
- * Proxy](:service:accountaccesscontrolproxy)**.
- *
- * [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html
+ * users on different objects and endpoints.
+ *
+ * This API manages database infrastructure only. To query or modify data, use the Data API or
* direct SQL connections.
*
- * **About resource IDs and names**
+ * About resource IDs and names
*
- * Resources are identified by hierarchical resource names like
- * `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`. The `name` field on each
- * resource contains this full path and is output-only. Note that `name` refers to this resource
- * path, not the user-visible `display_name`.
+ * Resources are identified by hierarchical resource names like {@code
+ * projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}}. The {@code name} field on
+ * each resource contains this full path and is output-only. Note that {@code name} refers to this
+ * resource path, not the user-visible {@code display_name}.
*/
public PostgresAPI postgres() {
return postgresAPI;
@@ -1505,7 +1526,8 @@ public ProvidersAPI providers() {
/**
* Deprecated: Please use the Data Quality Monitoring API instead (REST:
- * /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support `schema`).
+ * /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support {@code
+ * schema}).
*/
public QualityMonitorV2API qualityMonitorV2() {
return qualityMonitorV2API;
@@ -1519,8 +1541,8 @@ public QualityMonitorV2API qualityMonitorV2() {
* generates metrics tables and a dashboard that you can use to monitor table health and set
* alerts. Most write operations require the user to be the owner of the table (or its parent
* schema or parent catalog). Viewing the dashboard, computed metrics, or monitor configuration
- * only requires the user to have **SELECT** privileges on the table (along with **USE_SCHEMA**
- * and **USE_CATALOG**).
+ * only requires the user to have SELECT privileges on the table (along with
+ * USE_SCHEMA and USE_CATALOG).
*/
public QualityMonitorsAPI qualityMonitors() {
return qualityMonitorsAPI;
@@ -1529,7 +1551,7 @@ public QualityMonitorsAPI qualityMonitors() {
/**
* The queries API can be used to perform CRUD operations on queries. A query is a Databricks SQL
* object that includes the target SQL warehouse, query text, name, description, tags, and
- * parameters. Queries can be scheduled using the `sql_task` type of the Jobs API, e.g.
+ * parameters. Queries can be scheduled using the {@code sql_task} type of the Jobs API, e.g.
* :method:jobs/create.
*/
public QueriesAPI queries() {
@@ -1539,12 +1561,11 @@ public QueriesAPI queries() {
/**
* These endpoints are used for CRUD operations on query definitions. Query definitions include
* the target SQL warehouse, query text, name, description, tags, parameters, and visualizations.
- * Queries can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.
- *
- * **Warning**: This API is deprecated. Please see the latest version of the Databricks SQL
- * API. [Learn more]
+ * Queries can be scheduled using the {@code sql_task} type of the Jobs API, e.g.
+ * :method:jobs/create.
*
- * [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
+ * Warning: This API is deprecated. Please see the latest version of the Databricks SQL
+ * API. Learn more
*/
public QueriesLegacyAPI queriesLegacy() {
return queriesLegacyAPI;
@@ -1570,10 +1591,8 @@ public QueryVisualizationsAPI queryVisualizations() {
* This is an evolving API that facilitates the addition and removal of vizualisations from
* existing queries within the Databricks Workspace. Data structures may change over time.
*
- * **Warning**: This API is deprecated. Please see the latest version of the Databricks SQL
- * API. [Learn more]
- *
- * [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
+ * Warning: This API is deprecated. Please see the latest version of the Databricks SQL
+ * API. Learn more
*/
public QueryVisualizationsLegacyAPI queryVisualizationsLegacy() {
return queryVisualizationsLegacyAPI;
@@ -1581,10 +1600,10 @@ public QueryVisualizationsLegacyAPI queryVisualizationsLegacy() {
/**
* The Recipient Activation API is only applicable in the open sharing model where the recipient
- * object has the authentication type of `TOKEN`. The data recipient follows the activation link
- * shared by the data provider to download the credential file that includes the access token. The
- * recipient will then use the credential file to establish a secure connection with the provider
- * to receive the shared data.
+ * object has the authentication type of {@code TOKEN}. The data recipient follows the activation
+ * link shared by the data provider to download the credential file that includes the access
+ * token. The recipient will then use the credential file to establish a secure connection with
+ * the provider to receive the shared data.
*
* Note that you can download the credential file only once. Recipients should treat the
* downloaded credential as a secret and must not share it outside of their organization.
@@ -1595,22 +1614,27 @@ public RecipientActivationAPI recipientActivation() {
/**
* The Recipient Federation Policies APIs are only applicable in the open sharing model where the
- * recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from
- * Databricks to non-Databricks recipients. OIDC Token Federation enables secure, secret-less
+ * recipient object has the authentication type of {@code OIDC_RECIPIENT}, enabling data sharing
+ * from Databricks to non-Databricks recipients. OIDC Token Federation enables secure, secret-less
* authentication for accessing Delta Sharing servers. Users and applications authenticate using
* short-lived OIDC tokens issued by their own Identity Provider (IdP), such as Azure Entra ID or
* Okta, without the need for managing static credentials or client secrets. A federation policy
* defines how non-Databricks recipients authenticate using OIDC tokens. It validates the OIDC
* claims in federated tokens and is set at the recipient level. The caller must be the owner of
* the recipient to create or manage a federation policy. Federation policies support the
- * following scenarios: - User-to-Machine (U2M) flow: A user accesses Delta Shares using their own
- * identity, such as connecting through PowerBI Delta Sharing Client. - Machine-to-Machine (M2M)
- * flow: An application accesses Delta Shares using its own identity, typically for automation
- * tasks like nightly jobs through Python Delta Sharing Client. OIDC Token Federation enables
- * fine-grained access control, supports Multi-Factor Authentication (MFA), and enhances security
- * by minimizing the risk of credential leakage through the use of short-lived, expiring tokens.
- * It is designed for strong identity governance, secure cross-platform data sharing, and reduced
- * operational overhead for credential management.
+ * following scenarios:
+ *
+ * For more information, see
* https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security
@@ -1626,16 +1650,17 @@ public RecipientFederationPoliciesAPI recipientFederationPolicies() {
* on whether or not your recipient has access to a Databricks workspace that is enabled for Unity
* Catalog:
*
- * - For recipients with access to a Databricks workspace that is enabled for Unity Catalog,
- * you can create a recipient object along with a unique sharing identifier you get from the
- * recipient. The sharing identifier is the key identifier that enables the secure connection.
- * This sharing mode is called **Databricks-to-Databricks sharing**.
- *
- * - For recipients without access to a Databricks workspace that is enabled for Unity Catalog,
- * when you create a recipient object, Databricks generates an activation link you can send to the
- * recipient. The recipient follows the activation link to download the credential file, and then
- * uses the credential file to establish a secure connection to receive the shared data. This
- * sharing mode is called **open sharing**.
+ * * To create a registered model, users must additionally have the CREATE_MODEL permission on
- * the target schema. * To view registered model or model version metadata, model version data
- * files, or invoke a model version, users must additionally have the EXECUTE permission on the
- * registered model * To update registered model or model version tags, users must additionally
- * have APPLY TAG permissions on the registered model * To update other registered model or model
- * version metadata (comments, aliases) create a new model version, or update permissions on the
- * registered model, users must be owners of the registered model.
+ * Note: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants)
* that specify a securable type, use FUNCTION as the securable type.
@@ -1696,11 +1726,9 @@ public ReposAPI repos() {
* Unity Catalog enforces resource quotas on all securable objects, which limits the number of
* resources that can be created. Quotas are expressed in terms of a resource type and a parent
* (for example, tables per metastore or schemas per catalog). The resource quota APIs enable you
- * to monitor your current usage and limits. For more information on resource quotas see the
- * [Unity Catalog documentation].
- *
- * [Unity Catalog documentation]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#resource-quotas
+ * to monitor your current usage and limits. For more information on resource quotas see the Unity
+ * Catalog documentation.
*/
public ResourceQuotasAPI resourceQuotas() {
return resourceQuotasAPI;
@@ -1744,7 +1772,7 @@ public SecretsExt secrets() {
/**
* A secret is a Unity Catalog securable object that stores sensitive credential data (such as
* passwords, tokens, and keys) within a three-level namespace
- * (**catalog_name.schema_name.secret_name**).
+ * (catalog_name.schema_name.secret_name).
*
* Secrets can be managed using standard Unity Catalog permissions and are scoped to a schema
* within a catalog.
@@ -1759,16 +1787,13 @@ public SecretsUcAPI secretsUc() {
*
* You can use the generated secrets to obtain OAuth access tokens for a service principal,
* which can then be used to access Databricks Accounts and Workspace APIs. For more information,
- * see [Authentication using OAuth tokens for service principals].
+ * see Authentication
+ * using OAuth tokens for service principals.
*
* In addition, the generated secrets can be used to configure the Databricks Terraform
- * Providerto authenticate with the service principal. For more information, see [Databricks
- * Terraform Provider].
- *
- * [Authentication using OAuth tokens for service principals]:
- * https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform
- * Provider]:
- * https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal
+ * Providerto authenticate with the service principal. For more information, see Databricks
+ * Terraform Provider.
*/
public ServicePrincipalSecretsProxyAPI servicePrincipalSecretsProxy() {
return servicePrincipalSecretsProxyAPI;
@@ -1828,11 +1853,13 @@ public SharesAPI shares() {
* The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
* warehouse and fetch the result.
*
- * **Getting started**
+ * Getting started
*
- * We suggest beginning with the [Databricks SQL Statement Execution API tutorial].
+ * We suggest beginning with the Databricks SQL Statement
+ * Execution API tutorial.
*
- * **Overview of statement execution and result fetching**
+ * Overview of statement execution and result fetching
*
* Statement execution begins by issuing a :method:statementexecution/executeStatement request
* with a valid SQL statement and warehouse ID, along with optional parameters such as the data
@@ -1843,78 +1870,91 @@ public SharesAPI shares() {
* used to poll for results by using a :method:statementexecution/getStatement request.
*
* You can specify whether the call should behave synchronously, asynchronously or start
- * synchronously with a fallback to asynchronous execution. This is controlled with the
- * `wait_timeout` and `on_wait_timeout` settings. If `wait_timeout` is set between 5-50 seconds
- * (default: 10s), the call waits for results up to the specified timeout; when set to `0s`, the
- * call is asynchronous and responds immediately with a statement ID. The `on_wait_timeout`
- * setting specifies what should happen when the timeout is reached while the statement execution
- * has not yet finished. This can be set to either `CONTINUE`, to fallback to asynchronous mode,
- * or it can be set to `CANCEL`, which cancels the statement.
- *
- * In summary: - **Synchronous mode** (`wait_timeout=30s` and `on_wait_timeout=CANCEL`): The
- * call waits up to 30 seconds; if the statement execution finishes within this time, the result
- * data is returned directly in the response. If the execution takes longer than 30 seconds, the
- * execution is canceled and the call returns with a `CANCELED` state. - **Asynchronous mode**
- * (`wait_timeout=0s` and `on_wait_timeout` is ignored): The call doesn't wait for the statement
- * to finish but returns directly with a statement ID. The status of the statement execution can
- * be polled by issuing :method:statementexecution/getStatement with the statement ID. Once the
- * execution has succeeded, this call also returns the result and metadata in the response. -
- * **[Default] Hybrid mode** (`wait_timeout=10s` and `on_wait_timeout=CONTINUE`): The call waits
- * for up to 10 seconds; if the statement execution finishes within this time, the result data is
- * returned directly in the response. If the execution takes longer than 10 seconds, a statement
- * ID is returned. The statement ID can be used to fetch status and results in the same way as in
- * the asynchronous mode.
+ * synchronously with a fallback to asynchronous execution. This is controlled with the {@code
+ * wait_timeout} and {@code on_wait_timeout} settings. If {@code wait_timeout} is set between 5-50
+ * seconds (default: 10s), the call waits for results up to the specified timeout; when set to
+ * {@code 0s}, the call is asynchronous and responds immediately with a statement ID. The {@code
+ * on_wait_timeout} setting specifies what should happen when the timeout is reached while the
+ * statement execution has not yet finished. This can be set to either {@code CONTINUE}, to
+ * fallback to asynchronous mode, or it can be set to {@code CANCEL}, which cancels the statement.
+ *
+ * In summary:
+ *
+ * Depending on the size, the result can be split into multiple chunks. If the statement
* execution is successful, the statement response contains a manifest and the first chunk of the
* result. The manifest contains schema information and provides metadata for each chunk in the
* result. Result chunks can be retrieved by index with
* :method:statementexecution/getStatementResultChunkN which may be called in any order and in
- * parallel. For sequential fetching, each chunk, apart from the last, also contains a
- * `next_chunk_index` and `next_chunk_internal_link` that point to the next chunk.
+ * parallel. For sequential fetching, each chunk, apart from the last, also contains a {@code
+ * next_chunk_index} and {@code next_chunk_internal_link} that point to the next chunk.
*
* A statement can be canceled with :method:statementexecution/cancelExecution.
*
- * **Fetching result data: format and disposition**
- *
- * To specify the format of the result data, use the `format` field, which can be set to one of
- * the following options: `JSON_ARRAY` (JSON), `ARROW_STREAM` ([Apache Arrow Columnar]), or `CSV`.
+ * Fetching result data: format and disposition
*
- * There are two ways to receive statement results, controlled by the `disposition` setting,
- * which can be either `INLINE` or `EXTERNAL_LINKS`:
+ * To specify the format of the result data, use the {@code format} field, which can be set to
+ * one of the following options: {@code JSON_ARRAY} (JSON), {@code ARROW_STREAM} (Apache Arrow Columnar), or {@code CSV}.
*
- * - `INLINE`: In this mode, the result data is directly included in the response. It's best
- * suited for smaller results. This mode can only be used with the `JSON_ARRAY` format.
+ * There are two ways to receive statement results, controlled by the {@code disposition}
+ * setting, which can be either {@code INLINE} or {@code EXTERNAL_LINKS}:
*
- * - `EXTERNAL_LINKS`: In this mode, the response provides links that can be used to download
- * the result data in chunks separately. This approach is ideal for larger results and offers
- * higher throughput. This mode can be used with all the formats: `JSON_ARRAY`, `ARROW_STREAM`,
- * and `CSV`.
+ * By default, the API uses `format=JSON_ARRAY` and `disposition=INLINE`.
+ * By default, the API uses {@code format=JSON_ARRAY} and {@code disposition=INLINE}.
*
- * **Limits and limitations**
+ * Limits and limitations
*
* Note: The byte limit for INLINE disposition is based on internal storage metrics and will
* not exactly match the byte count of the actual payload.
*
- * - Statements with `disposition=INLINE` are limited to 25 MiB and will fail when this limit
- * is exceeded. - Statements with `disposition=EXTERNAL_LINKS` are limited to 100 GiB. Result sets
- * larger than this limit will be truncated. Truncation is indicated by the `truncated` field in
- * the result manifest. - The maximum query text size is 16 MiB. - Cancelation might silently
- * fail. A successful response from a cancel request indicates that the cancel request was
- * successfully received and sent to the processing engine. However, an outstanding statement
- * might have already completed execution when the cancel request arrives. Polling for status
- * until a terminal state is reached is a reliable way to determine the final state. - Wait
- * timeouts are approximate, occur server-side, and cannot account for things such as caller
- * delays and network latency from caller to service. - To guarantee that the statement is kept
- * alive, you must poll at least once every 15 minutes. - The results are only available for one
- * hour after success; polling does not extend this. - The SQL Execution API must be used for the
- * entire lifecycle of the statement. For example, you cannot use the Jobs API to execute the
- * command, and then the SQL Execution API to cancel it.
- *
- * [Apache Arrow Columnar]: https://arrow.apache.org/overview/ [Databricks SQL Statement
- * Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html
+ * A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind
- * of table (rather than a managed or external table).
+ * A table can be managed or external. From an API perspective, a VIEW is a particular
+ * kind of table (rather than a managed or external table).
*/
public TablesAPI tables() {
return tablesAPI;
@@ -1984,13 +2024,11 @@ public TablesAPI tables() {
/**
* The Tag Policy API allows you to manage policies for governed tags in Databricks. For Terraform
- * usage, see the [Tag Policy Terraform documentation]. Permissions for tag policies can be
- * managed using the [Account Access Control Proxy API].
- *
- * [Account Access Control Proxy API]:
- * https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform
- * documentation]:
- * https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy
+ * usage, see the Tag
+ * Policy Terraform documentation. Permissions for tag policies can be managed using the Account Access
+ * Control Proxy API.
*/
public TagPoliciesAPI tagPolicies() {
return tagPoliciesAPI;
@@ -2092,20 +2130,25 @@ public UsersV2API usersV2() {
return usersV2API;
}
- /** **Endpoint**: Represents the compute resources to host AI Search indexes. */
+ /** Endpoint: Represents the compute resources to host AI Search indexes. */
public VectorSearchEndpointsAPI vectorSearchEndpoints() {
return vectorSearchEndpointsAPI;
}
/**
- * **Index**: An efficient representation of your embedding vectors that supports real-time and
+ * Index: An efficient representation of your embedding vectors that supports real-time and
* efficient approximate nearest neighbor (ANN) search queries.
*
- * There are 2 types of AI Search indexes: - **Delta Sync Index**: An index that automatically
- * syncs with a source Delta Table, automatically and incrementally updating the index as the
- * underlying data in the Delta Table changes. - **Direct Vector Access Index**: An index that
- * supports direct read and write of vectors and metadata through our REST and SDK APIs. With this
- * model, the user manages index updates.
+ * There are 2 types of AI Search indexes:
+ *
+ * NOTE: The __isolation_mode__ is configured for the securable itself (using its Update
- * method) and the workspace bindings are only consulted when the securable's __isolation_mode__
- * is set to __ISOLATED__.
+ * NOTE: The isolation_mode is configured for the securable itself (using its Update
+ * method) and the workspace bindings are only consulted when the securable's
+ * isolation_mode is set to ISOLATED.
*
* A securable's workspace bindings can be configured by a metastore admin or the owner of the
* securable.
@@ -2162,8 +2205,14 @@ public WorkspaceAPI workspace() {
* Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name})
* which introduces the ability to bind a securable in READ_ONLY mode (catalogs only).
*
- * Securable types that support binding: - catalog - storage_credential - credential -
- * external_location
+ * Securable types that support binding:
+ *
+ * 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.
+ * spaces). The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonProperty("update_mask")
private String updateMask;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java
index 472cfafe3..1f80fa740 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java
@@ -8,7 +8,7 @@
import com.databricks.sdk.support.Paginator;
/**
- * **AI Search Endpoint**: Represents the compute resources to host AI Search indexes.
+ * AI Search Endpoint: Represents the compute resources to host AI Search indexes.
* AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.
*/
@Generated
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java
index b58328f7b..cf2fe5b02 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java
@@ -4,7 +4,7 @@
import com.databricks.sdk.support.Generated;
/**
- * **AI Search Endpoint**: Represents the compute resources to host AI Search indexes.
+ * AI Search Endpoint: Represents the compute resources to host AI Search indexes.
* AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.
*
* This is the high-level interface, that contains generated methods.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ColumnInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ColumnInfo.java
index 5664ac1c5..5a5fa42ed 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ColumnInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ColumnInfo.java
@@ -7,7 +7,10 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
-/** Column information (name and data type) for an index column. Surfaced on `Index.column_info`. */
+/**
+ * Column information (name and data type) for an index column. Surfaced on {@code
+ * Index.column_info}.
+ */
@Generated
public class ColumnInfo {
/** Name of the column. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateEndpointRequest.java
index c6ebbbe76..8c7695331 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateEndpointRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateEndpointRequest.java
@@ -12,23 +12,26 @@
@Generated
public class CreateEndpointRequest {
/**
- * The Endpoint resource to create. Fields other than `endpoint.name` carry the desired
- * configuration; `endpoint.name` is server-assigned from `parent` and `endpoint_id`.
+ * The Endpoint resource to create. Fields other than {@code endpoint.name} carry the desired
+ * configuration; {@code endpoint.name} is server-assigned from {@code parent} and {@code
+ * endpoint_id}.
*/
@JsonProperty("endpoint")
private Endpoint endpoint;
/**
- * The user-supplied short name for the Endpoint, per AIP-133. The server composes the full
- * `Endpoint.name` as `{parent}/endpoints/{endpoint_id}`. AIP-133 does not list `endpoint_id` as a
- * fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects
- * empty values with INVALID_PARAMETER_VALUE.
+ * The user-supplied short name for the Endpoint, per AIP-133. The server composes the full {@code
+ * Endpoint.name} as {@code {parent}/endpoints/{endpoint_id}}. AIP-133 does not list {@code
+ * endpoint_id} as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the
+ * server still rejects empty values with INVALID_PARAMETER_VALUE.
*/
@JsonIgnore
@QueryParam("endpoint_id")
private String endpointId;
- /** The Workspace where this Endpoint will be created. Format: `workspaces/{workspace_id}` */
+ /**
+ * The Workspace where this Endpoint will be created. Format: {@code workspaces/{workspace_id}}
+ */
@JsonIgnore private String parent;
public CreateEndpointRequest setEndpoint(Endpoint endpoint) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java
index cdd2273ad..a134fc722 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java
@@ -12,25 +12,25 @@
@Generated
public class CreateIndexRequest {
/**
- * The Index resource to create. Fields other than `index.name` carry the desired configuration;
- * `index.name` is server-assigned from `parent` and `index_id`.
+ * The Index resource to create. Fields other than {@code index.name} carry the desired
+ * configuration; {@code index.name} is server-assigned from {@code parent} and {@code index_id}.
*/
@JsonProperty("index")
private Index index;
/**
* The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the
- * full `Index.name` as `{parent}/indexes/{index_id}`. AIP-133 does not list `index_id` as a
- * fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects
- * empty values with INVALID_PARAMETER_VALUE.
+ * full {@code Index.name} as {@code {parent}/indexes/{index_id}}. AIP-133 does not list {@code
+ * index_id} as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server
+ * still rejects empty values with INVALID_PARAMETER_VALUE.
*/
@JsonIgnore
@QueryParam("index_id")
private String indexId;
/**
- * The Endpoint where this Index will be created. Format:
- * `workspaces/{workspace_id}/endpoints/{endpoint_id}`
+ * The Endpoint where this Index will be created. Format: {@code
+ * workspaces/{workspace_id}/endpoints/{endpoint_id}}
*/
@JsonIgnore private String parent;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DataModificationStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DataModificationStatus.java
index 3c3f05590..61c45eefc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DataModificationStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DataModificationStatus.java
@@ -5,8 +5,8 @@
import com.databricks.sdk.support.Generated;
/**
- * Overall outcome of a data-plane upsert or delete. Mirrors the legacy
- * `databricks.brickindexscheduler.UpsertDeleteDataStatus` value-for-value.
+ * Overall outcome of a data-plane upsert or delete. Mirrors the legacy {@code
+ * databricks.brickindexscheduler.UpsertDeleteDataStatus} value-for-value.
*/
@Generated
public enum DataModificationStatus {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteEndpointRequest.java
index 58f4ba466..8bdffd93d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteEndpointRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteEndpointRequest.java
@@ -10,8 +10,8 @@
@Generated
public class DeleteEndpointRequest {
/**
- * Full resource name of the endpoint to delete. Format:
- * `workspaces/{workspace_id}/endpoints/{endpoint_id}`
+ * Full resource name of the endpoint to delete. Format: {@code
+ * workspaces/{workspace_id}/endpoints/{endpoint_id}}
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteIndexRequest.java
index f29084661..db6b7bc41 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeleteIndexRequest.java
@@ -10,8 +10,8 @@
@Generated
public class DeleteIndexRequest {
/**
- * Full resource name of the index to delete. Format:
- * `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
+ * Full resource name of the index to delete. Format: {@code
+ * workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}}
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java
index 37a4b9ed7..2263868b1 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java
@@ -37,10 +37,10 @@ public class DeltaSyncIndexSpec {
/**
* Pipeline execution mode. Required on create — the backend rejects an unset value. Storage
- * Optimized endpoints accept only `TRIGGERED`; Standard endpoints accept both. No explicit
- * `stage` — a REQUIRED field staged below its service would be dropped from combined specs while
- * remaining in `required`, tripping the OpenAPI required-vs-properties consistency check. The
- * field inherits the service's launch stage.
+ * Optimized endpoints accept only {@code TRIGGERED}; Standard endpoints accept both. No explicit
+ * {@code stage} — a REQUIRED field staged below its service would be dropped from combined specs
+ * while remaining in {@code required}, tripping the OpenAPI required-vs-properties consistency
+ * check. The field inherits the service's launch stage.
*/
@JsonProperty("pipeline_type")
private PipelineType pipelineType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java
index 6905223ea..d2918ea35 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java
@@ -20,9 +20,9 @@ public class DirectAccessIndexSpec {
private Collection 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonProperty("update_mask")
private String updateMask;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/Operation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/Operation.java
index 610ba8296..fd4fe521c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/Operation.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/Operation.java
@@ -11,8 +11,8 @@
@Generated
public class Operation {
/**
- * If the value is `false`, it means the operation is still in progress. If `true`, the operation
- * is completed, and either `error` or `response` is available.
+ * If the value is {@code false}, it means the operation is still in progress. If {@code true},
+ * the operation is completed, and either {@code error} or {@code response} is available.
*/
@JsonProperty("done")
private Boolean done;
@@ -31,8 +31,8 @@ public class Operation {
/**
* The server-assigned name, which is only unique within the same service that originally returns
- * it. If you use the default HTTP mapping, the `name` should be a resource name ending with
- * `operations/{unique_id}`.
+ * it. If you use the default HTTP mapping, the {@code name} should be a resource name ending with
+ * {@code operations/{unique_id}}.
*/
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateSpaceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateSpaceRequest.java
index 7b4af79be..fe1dcebe9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateSpaceRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateSpaceRequest.java
@@ -24,14 +24,14 @@ public class UpdateSpaceRequest {
/**
* 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.
+ * The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfiguration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfiguration.java
index 918ec6d08..0125215c5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfiguration.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfiguration.java
@@ -23,14 +23,14 @@ public class AlertConfiguration {
/**
* The threshold for the budget alert to determine if it is in a triggered state. The number is
- * evaluated based on `quantity_type`.
+ * evaluated based on {@code quantity_type}.
*/
@JsonProperty("quantity_threshold")
private String quantityThreshold;
/**
- * The way to calculate cost for this budget alert. This is what `quantity_threshold` is measured
- * in.
+ * The way to calculate cost for this budget alert. This is what {@code quantity_threshold} is
+ * measured in.
*/
@JsonProperty("quantity_type")
private AlertConfigurationQuantityType quantityType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageAPI.java
index 079ca2947..920c432eb 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageAPI.java
@@ -34,17 +34,21 @@ public DownloadResponse download(String startMonth, String endMonth) {
* Returns billable usage logs in CSV format for the specified account and date range. For the
* data schema, see:
*
- * - AWS: [CSV file schema]. - GCP: [CSV file schema].
+ * Note that this method might take multiple minutes to complete.
*
- * **Warning**: Depending on the queried date range, the number of workspaces in the account,
- * the size of the response and the internet speed of the caller, this API may hit a timeout after
- * a few minutes. If you experience this, try to mitigate by calling the API with narrower date
- * ranges.
- *
- * [CSV file schema]:
- * https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema
+ * Warning: Depending on the queried date range, the number of workspaces in the
+ * account, the size of the response and the internet speed of the caller, this API may hit a
+ * timeout after a few minutes. If you experience this, try to mitigate by calling the API with
+ * narrower date ranges.
*/
public DownloadResponse download(DownloadRequest request) {
return impl.download(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageService.java
index 44b15f427..3c2a1e77f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BillableUsageService.java
@@ -17,17 +17,21 @@ public interface BillableUsageService {
* Returns billable usage logs in CSV format for the specified account and date range. For the
* data schema, see:
*
- * - AWS: [CSV file schema]. - GCP: [CSV file schema].
+ * Note that this method might take multiple minutes to complete.
*
- * **Warning**: Depending on the queried date range, the number of workspaces in the account,
- * the size of the response and the internet speed of the caller, this API may hit a timeout after
- * a few minutes. If you experience this, try to mitigate by calling the API with narrower date
- * ranges.
- *
- * [CSV file schema]:
- * https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema
+ * Warning: Depending on the queried date range, the number of workspaces in the
+ * account, the size of the response and the internet speed of the caller, this API may hit a
+ * timeout after a few minutes. If you experience this, try to mitigate by calling the API with
+ * narrower date ranges.
*/
DownloadResponse download(DownloadRequest downloadRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicy.java
index 66355b115..438baf99b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicy.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicy.java
@@ -27,9 +27,13 @@ public class BudgetPolicy {
private String policyId;
/**
- * The name of the policy. - Must be unique among active policies. - Can contain only characters
- * from the ISO 8859-1 (latin1) set. - Can't start with reserved keywords such as
- * `databricks:default-policy`.
+ * The name of the policy.
+ *
+ * [Configure billable usage delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * relationship as described in the main billable usage documentation page. See Configure
+ * billable usage delivery.
*/
@JsonProperty("credentials_id")
private String credentialsId;
@@ -43,51 +41,56 @@ public class CreateLogDeliveryConfigurationParams {
private String deliveryStartTime;
/**
- * Log delivery type. Supported values are: * `BILLABLE_USAGE` — Configure [billable usage log
- * delivery]. For the CSV schema, see the [View billable usage]. * `AUDIT_LOGS` — Configure [audit
- * log delivery]. For the JSON schema, see [Configure audit logging]
+ * Log delivery type. Supported values are:
*
- * [Configure audit logging]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [View
- * billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html
- * [audit log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [billable
- * usage log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * [Configuring audit logs]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [View
- * billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html
+ * [Configure billable usage delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * described in the main billable usage documentation page. See Configure
+ * billable usage delivery.
*/
@JsonProperty("storage_configuration_id")
private String storageConfigurationId;
@@ -96,9 +99,9 @@ public class CreateLogDeliveryConfigurationParams {
* Optional filter that specifies workspace IDs to deliver logs for. By default the workspace
* filter is empty and log delivery applies at the account level, delivering workspace-level logs
* for all workspaces in your account, plus account level logs. You can optionally set this field
- * to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in
- * which case only workspace-level logs relating to the specified workspaces are delivered. If you
- * plan to use different log delivery configurations for different workspaces, set this field
+ * to an array of workspace IDs (each one is an {@code int64}) to which log delivery should apply,
+ * in which case only workspace-level logs relating to the specified workspaces are delivered. If
+ * you plan to use different log delivery configurations for different workspaces, set this field
* explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to
* new workspaces created in the future, and delivery won't include account level logs. For some
* types of Databricks deployments there is only one workspace per account ID, so this field is
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DeliveryStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DeliveryStatus.java
index f4fae5ddc..551151da8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DeliveryStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DeliveryStatus.java
@@ -5,13 +5,14 @@
import com.databricks.sdk.support.Generated;
/**
- * * The status string for log delivery. Possible values are: `CREATED`: There were no log delivery
- * attempts since the config was created. `SUCCEEDED`: The latest attempt of log delivery has
- * succeeded completely. `USER_FAILURE`: The latest attempt of log delivery failed because of
- * misconfiguration of customer provided permissions on role or storage. `SYSTEM_FAILURE`: The
- * latest attempt of log delivery failed because of an Databricks internal error. Contact support if
- * it doesn't go away soon. `NOT_FOUND`: The log delivery status as the configuration has been
- * disabled since the release of this feature or there are no workspaces in the account.
+ * The status string for log delivery. Possible values are: {@code CREATED}: There were no log
+ * delivery attempts since the config was created. {@code SUCCEEDED}: The latest attempt of log
+ * delivery has succeeded completely. {@code USER_FAILURE}: The latest attempt of log delivery
+ * failed because of misconfiguration of customer provided permissions on role or storage. {@code
+ * SYSTEM_FAILURE}: The latest attempt of log delivery failed because of an Databricks internal
+ * error. Contact support if it doesn't go away soon. {@code NOT_FOUND}: The log delivery status as
+ * the configuration has been disabled since the release of this feature or there are no workspaces
+ * in the account.
*/
@Generated
public enum DeliveryStatus {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DownloadRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DownloadRequest.java
index e9f3ccabb..1abc2bbd5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DownloadRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/DownloadRequest.java
@@ -10,7 +10,9 @@
@Generated
public class DownloadRequest {
- /** Format: `YYYY-MM`. Last month to return billable usage logs for. This field is required. */
+ /**
+ * Format: {@code YYYY-MM}. Last month to return billable usage logs for. This field is required.
+ */
@JsonIgnore
@QueryParam("end_month")
private String endMonth;
@@ -25,9 +27,9 @@ public class DownloadRequest {
private Boolean personalData;
/**
- * Format specification for month in the format `YYYY-MM`. This is used to specify billable usage
- * `start_month` and `end_month` properties. **Note**: Billable usage logs are unavailable before
- * March 2019 (`2019-03`).
+ * Format specification for month in the format {@code YYYY-MM}. This is used to specify billable
+ * usage {@code start_month} and {@code end_month} properties. Note: Billable usage logs
+ * are unavailable before March 2019 ({@code 2019-03}).
*/
@JsonIgnore
@QueryParam("start_month")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetConfigurationsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetConfigurationsResponse.java
index c6c385543..ff4db1a3e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetConfigurationsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetConfigurationsResponse.java
@@ -15,8 +15,8 @@ public class ListBudgetConfigurationsResponse {
private Collection When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match
- * the call that provided the page token.
+ * When paginating, all other parameters provided to {@code ListServerlessPoliciesRequest} must
+ * match the call that provided the page token.
*/
@JsonIgnore
@QueryParam("page_token")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesResponse.java
index 6ab49dbca..e42016e33 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesResponse.java
@@ -12,8 +12,8 @@
@Generated
public class ListBudgetPoliciesResponse {
/**
- * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted,
- * there are no subsequent pages.
+ * A token that can be sent as {@code page_token} to retrieve the next page. If this field is
+ * omitted, there are no subsequent pages.
*/
@JsonProperty("next_page_token")
private String nextPageToken;
@@ -23,7 +23,7 @@ public class ListBudgetPoliciesResponse {
private Collection Log delivery works with all account types. However, if your account is on the E2 version of
* the platform or on a select custom plan that allows multiple workspaces per account, you can
@@ -19,52 +19,66 @@
*
* The high-level flow of billable usage delivery (AWS only):
*
- * 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy.
- * Using Databricks APIs, call the Account API to create a [storage configuration
- * object](:method:Storage/Create) that uses the bucket name.
+ * 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details,
- * including the required IAM role policies and trust relationship, see [Billable usage log
- * delivery]. Using Databricks APIs, call the Account API to create a [credential configuration
- * object](:method:Credentials/Create) that uses the IAM role's ARN.
+ * For billable usage delivery (AWS only):
*
- * 3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to
- * [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and
- * storage configuration objects from previous steps. You can specify if the logs should include all
- * events of that log type in your account (_Account level_ delivery) or only events for a specific
- * set of workspaces (_workspace level_ delivery). Account level log delivery applies to all current
- * and future workspaces plus account level logs, while workspace level log delivery solely delivers
- * logs related to the specified workspaces. You can create multiple types of delivery
- * configurations per account.
+ * For billable usage delivery (AWS only): * For more information about billable usage logs, see
- * [Billable usage log delivery]. For the CSV schema, see the [Usage page]. * The delivery location
- * is ` For audit log delivery (AWS and GCP):
*
- * For audit log delivery (AWS and GCP): * For more information about about audit log delivery,
- * see Audit log delivery [AWS] or [GCP], which includes information about the used JSON schema. *
- * The delivery location is
- * ` [AWS]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html
- * [Billable usage log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
- * [GCP]: https://docs.databricks.com/gcp/en/admin/account-settings/audit-logs [Usage page]:
- * https://docs.databricks.com/administration-guide/account-settings/usage.html [create a new AWS S3
- * bucket]: https://docs.databricks.com/administration-guide/account-api/aws-storage.html
+ * For full details, including the required IAM role policies and bucket policies, see [Deliver
- * and access billable usage logs] or [Configure audit logging].
+ * For full details, including the required IAM role policies and bucket policies, see Deliver
+ * and access billable usage logs or Configure
+ * audit logging.
*
- * **Note**: There is a limit on the number of log delivery configurations available per
+ * Note: There is a limit on the number of log delivery configurations available per
* account (each limit applies separately to each log type including billable usage and audit
* logs). You can create a maximum of two enabled account-level delivery configurations
* (configurations without a workspace filter) per type. Additionally, you can create two enabled
@@ -99,13 +117,8 @@ public LogDeliveryAPI(LogDeliveryService mock) {
* same workspace ID can occur in the workspace filter for no more than two delivery
* configurations per log type.
*
- * You cannot delete a log delivery configuration, but you can disable it (see [Enable or
- * disable log delivery configuration](:method:LogDelivery/PatchStatus)).
- *
- * [Configure audit logging]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Deliver and
- * access billable usage logs]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * You cannot delete a log delivery configuration, but you can disable it (see Enable or disable log delivery configuration).
*/
public WrappedLogDeliveryConfiguration create(WrappedCreateLogDeliveryConfiguration request) {
return impl.create(request);
@@ -140,7 +153,7 @@ public Iterable `ENABLED`: All dependencies have executed and succeeded `DISABLED`: At least one dependency
- * has succeeded
+ * {@code ENABLED}: All dependencies have executed and succeeded {@code DISABLED}: At least one
+ * dependency has succeeded
*/
@Generated
public enum LogDeliveryConfigStatus {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryConfiguration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryConfiguration.java
index 1a078c1c9..d736414e5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryConfiguration.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryConfiguration.java
@@ -8,7 +8,7 @@
import java.util.Collection;
import java.util.Objects;
-/** * Log Delivery Configuration */
+/** Log Delivery Configuration */
@Generated
public class LogDeliveryConfiguration {
/** Databricks account ID. */
@@ -29,11 +29,9 @@ public class LogDeliveryConfiguration {
/**
* The ID for a method:credentials/create that represents the AWS IAM role with policy and trust
- * relationship as described in the main billable usage documentation page. See [Configure
- * billable usage delivery].
- *
- * [Configure billable usage delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * relationship as described in the main billable usage documentation page. See Configure
+ * billable usage delivery.
*/
@JsonProperty("credentials_id")
private String credentialsId;
@@ -59,51 +57,56 @@ public class LogDeliveryConfiguration {
private LogDeliveryStatus logDeliveryStatus;
/**
- * Log delivery type. Supported values are: * `BILLABLE_USAGE` — Configure [billable usage log
- * delivery]. For the CSV schema, see the [View billable usage]. * `AUDIT_LOGS` — Configure [audit
- * log delivery]. For the JSON schema, see [Configure audit logging]
+ * Log delivery type. Supported values are:
*
- * [Configure audit logging]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [View
- * billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html
- * [audit log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [billable
- * usage log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * [Configuring audit logs]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [View
- * billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html
+ * [Configure billable usage delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * described in the main billable usage documentation page. See Configure
+ * billable usage delivery.
*/
@JsonProperty("storage_configuration_id")
private String storageConfigurationId;
@@ -116,9 +119,9 @@ public class LogDeliveryConfiguration {
* Optional filter that specifies workspace IDs to deliver logs for. By default the workspace
* filter is empty and log delivery applies at the account level, delivering workspace-level logs
* for all workspaces in your account, plus account level logs. You can optionally set this field
- * to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in
- * which case only workspace-level logs relating to the specified workspaces are delivered. If you
- * plan to use different log delivery configurations for different workspaces, set this field
+ * to an array of workspace IDs (each one is an {@code int64}) to which log delivery should apply,
+ * in which case only workspace-level logs relating to the specified workspaces are delivered. If
+ * you plan to use different log delivery configurations for different workspaces, set this field
* explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to
* new workspaces created in the future, and delivery won't include account level logs. For some
* types of Databricks deployments there is only one workspace per account ID, so this field is
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryService.java
index 1470c7ad2..82a618a8e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryService.java
@@ -5,8 +5,8 @@
/**
* These APIs manage log delivery configurations for this account. The two supported log types for
- * this API are _billable usage logs_ (AWS only) and _audit logs_ (AWS and GCP). This feature is in
- * Public Preview. This feature works with all account ID types.
+ * this API are billable usage logs (AWS only) and audit logs (AWS and GCP). This
+ * feature is in Public Preview. This feature works with all account ID types.
*
* Log delivery works with all account types. However, if your account is on the E2 version of
* the platform or on a select custom plan that allows multiple workspaces per account, you can
@@ -15,54 +15,68 @@
*
* The high-level flow of billable usage delivery (AWS only):
*
- * 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy.
- * Using Databricks APIs, call the Account API to create a [storage configuration
- * object](:method:Storage/Create) that uses the bucket name.
+ * 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details,
- * including the required IAM role policies and trust relationship, see [Billable usage log
- * delivery]. Using Databricks APIs, call the Account API to create a [credential configuration
- * object](:method:Credentials/Create) that uses the IAM role's ARN.
+ * For billable usage delivery (AWS only):
*
- * 3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to
- * [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and
- * storage configuration objects from previous steps. You can specify if the logs should include all
- * events of that log type in your account (_Account level_ delivery) or only events for a specific
- * set of workspaces (_workspace level_ delivery). Account level log delivery applies to all current
- * and future workspaces plus account level logs, while workspace level log delivery solely delivers
- * logs related to the specified workspaces. You can create multiple types of delivery
- * configurations per account.
+ * For billable usage delivery (AWS only): * For more information about billable usage logs, see
- * [Billable usage log delivery]. For the CSV schema, see the [Usage page]. * The delivery location
- * is ` For audit log delivery (AWS and GCP):
*
- * For audit log delivery (AWS and GCP): * For more information about about audit log delivery,
- * see Audit log delivery [AWS] or [GCP], which includes information about the used JSON schema. *
- * The delivery location is
- * ` [AWS]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html
- * [Billable usage log delivery]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
- * [GCP]: https://docs.databricks.com/gcp/en/admin/account-settings/audit-logs [Usage page]:
- * https://docs.databricks.com/administration-guide/account-settings/usage.html [create a new AWS S3
- * bucket]: https://docs.databricks.com/administration-guide/account-api/aws-storage.html
- *
- * This is the high-level interface, that contains generated methods.
+ * This is the high-level interface, that contains generated methods.
*
* Evolving: this interface is under development. Method signatures may change.
*/
@@ -70,14 +84,18 @@
public interface LogDeliveryService {
/**
* Creates a new Databricks log delivery configuration to enable delivery of the specified type of
- * logs to your storage location. This requires that you already created a [credential
- * object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a
- * [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket).
+ * logs to your storage location. This requires that you already created a credential object (which encapsulates a cross-account
+ * service IAM role) and a storage configuration object
+ * (which encapsulates an S3 bucket).
*
- * For full details, including the required IAM role policies and bucket policies, see [Deliver
- * and access billable usage logs] or [Configure audit logging].
+ * For full details, including the required IAM role policies and bucket policies, see Deliver
+ * and access billable usage logs or Configure
+ * audit logging.
*
- * **Note**: There is a limit on the number of log delivery configurations available per
+ * Note: There is a limit on the number of log delivery configurations available per
* account (each limit applies separately to each log type including billable usage and audit
* logs). You can create a maximum of two enabled account-level delivery configurations
* (configurations without a workspace filter) per type. Additionally, you can create two enabled
@@ -85,13 +103,8 @@ public interface LogDeliveryService {
* same workspace ID can occur in the workspace filter for no more than two delivery
* configurations per log type.
*
- * You cannot delete a log delivery configuration, but you can disable it (see [Enable or
- * disable log delivery configuration](:method:LogDelivery/PatchStatus)).
- *
- * [Configure audit logging]:
- * https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Deliver and
- * access billable usage logs]:
- * https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+ * You cannot delete a log delivery configuration, but you can disable it (see Enable or disable log delivery configuration).
*/
WrappedLogDeliveryConfiguration create(
WrappedCreateLogDeliveryConfiguration wrappedCreateLogDeliveryConfiguration);
@@ -106,7 +119,7 @@ WrappedLogDeliveryConfiguration create(
* Enables or disables a log delivery configuration. Deletion of delivery configurations is not
* supported, so disable log delivery configurations that are no longer needed. Note that you
* can't re-enable a delivery configuration if this would violate the delivery configuration
- * limits described under [Create log delivery](:method:LogDelivery/Create).
+ * limits described under Create log delivery.
*/
void patchStatus(
UpdateLogDeliveryConfigurationStatusRequest updateLogDeliveryConfigurationStatusRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryStatus.java
index e5d5a7ede..cd5742fd8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogDeliveryStatus.java
@@ -25,13 +25,18 @@ public class LogDeliveryStatus {
private String message;
/**
- * Enum that describes the status. Possible values are: * `CREATED`: There were no log delivery
- * attempts since the config was created. * `SUCCEEDED`: The latest attempt of log delivery has
- * succeeded completely. * `USER_FAILURE`: The latest attempt of log delivery failed because of
- * misconfiguration of customer provided permissions on role or storage. * `SYSTEM_FAILURE`: The
- * latest attempt of log delivery failed because of an Databricks internal error. Contact support
- * if it doesn't go away soon. * `NOT_FOUND`: The log delivery status as the configuration has
- * been disabled since the release of this feature or there are no workspaces in the account.
+ * Enum that describes the status. Possible values are:
+ *
+ * The server atomically: 1. Sets the version status to the provided terminal status. 2. Sets
- * `complete_time` to the current server timestamp. 3. Releases the lock on the parent deployment.
- * 4. Updates the parent deployment's `status` and `last_version_id`.
+ * The server atomically:
+ *
+ * The caller must provide a `deployment_id` which becomes the final component of the
+ * The caller must provide a {@code deployment_id} which becomes the final component of the
* deployment's resource name. If a deployment with the same ID already exists, the server returns
- * `ALREADY_EXISTS`.
+ * {@code ALREADY_EXISTS}.
*/
public Deployment createDeployment(CreateDeploymentRequest request) {
return impl.createDeployment(request);
@@ -49,9 +54,9 @@ public Deployment createDeployment(CreateDeploymentRequest request) {
/**
* Creates a resource operation under a version.
*
- * The caller must provide a `resource_key` which becomes the final component of the
+ * The caller must provide a {@code resource_key} which becomes the final component of the
* operation's name. If an operation with the same key already exists under the version, the
- * server returns `ALREADY_EXISTS`.
+ * server returns {@code ALREADY_EXISTS}.
*
* On success the server also updates the corresponding deployment-level Resource (creating it
* if this is the first operation for that resource_key, or removing it if action_type is DELETE).
@@ -64,8 +69,8 @@ public Operation createOperation(CreateOperationRequest request) {
* Creates a new version under a deployment.
*
* Creating a version acquires an exclusive lock on the deployment, preventing concurrent
- * deploys. The caller provides a `version_id` which the server validates equals `last_version_id
- * + 1` on the deployment.
+ * deploys. The caller provides a {@code version_id} which the server validates equals {@code
+ * last_version_id + 1} on the deployment.
*/
public Version createVersion(CreateVersionRequest request) {
return impl.createVersion(request);
@@ -80,7 +85,7 @@ public void deleteDeployment(String name) {
*
* The deployment is marked as deleted. It and all its children (versions and their operations)
* will be permanently deleted after the retention policy expires. If the deployment has an
- * in-progress version, the server returns `RESOURCE_CONFLICT`.
+ * in-progress version, the server returns {@code RESOURCE_CONFLICT}.
*/
public void deleteDeployment(DeleteDeploymentRequest request) {
impl.deleteDeployment(request);
@@ -127,7 +132,7 @@ public Version getVersion(GetVersionRequest request) {
*
* The server validates that the version is the active (non-terminal) version on the parent
* deployment and resets the lock expiry. If the lock has already expired or the version is no
- * longer active, the server returns `ABORTED`.
+ * longer active, the server returns {@code ABORTED}.
*/
public HeartbeatResponse heartbeat(HeartbeatRequest request) {
return impl.heartbeat(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java
index 9ac15e87a..4677b3551 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java
@@ -15,27 +15,32 @@ public interface BundleDeploymentsService {
/**
* Marks a version as complete and releases the deployment lock.
*
- * The server atomically: 1. Sets the version status to the provided terminal status. 2. Sets
- * `complete_time` to the current server timestamp. 3. Releases the lock on the parent deployment.
- * 4. Updates the parent deployment's `status` and `last_version_id`.
+ * The server atomically:
+ *
+ * The caller must provide a `deployment_id` which becomes the final component of the
+ * The caller must provide a {@code deployment_id} which becomes the final component of the
* deployment's resource name. If a deployment with the same ID already exists, the server returns
- * `ALREADY_EXISTS`.
+ * {@code ALREADY_EXISTS}.
*/
Deployment createDeployment(CreateDeploymentRequest createDeploymentRequest);
/**
* Creates a resource operation under a version.
*
- * The caller must provide a `resource_key` which becomes the final component of the
+ * The caller must provide a {@code resource_key} which becomes the final component of the
* operation's name. If an operation with the same key already exists under the version, the
- * server returns `ALREADY_EXISTS`.
+ * server returns {@code ALREADY_EXISTS}.
*
* On success the server also updates the corresponding deployment-level Resource (creating it
* if this is the first operation for that resource_key, or removing it if action_type is DELETE).
@@ -46,8 +51,8 @@ public interface BundleDeploymentsService {
* Creates a new version under a deployment.
*
* Creating a version acquires an exclusive lock on the deployment, preventing concurrent
- * deploys. The caller provides a `version_id` which the server validates equals `last_version_id
- * + 1` on the deployment.
+ * deploys. The caller provides a {@code version_id} which the server validates equals {@code
+ * last_version_id + 1} on the deployment.
*/
Version createVersion(CreateVersionRequest createVersionRequest);
@@ -56,7 +61,7 @@ public interface BundleDeploymentsService {
*
* The deployment is marked as deleted. It and all its children (versions and their operations)
* will be permanently deleted after the retention policy expires. If the deployment has an
- * in-progress version, the server returns `RESOURCE_CONFLICT`.
+ * in-progress version, the server returns {@code RESOURCE_CONFLICT}.
*/
void deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest);
@@ -77,7 +82,7 @@ public interface BundleDeploymentsService {
*
* The server validates that the version is the active (non-terminal) version on the parent
* deployment and resets the lock expiry. If the lock has already expired or the version is no
- * longer active, the server returns `ABORTED`.
+ * longer active, the server returns {@code ABORTED}.
*/
HeartbeatResponse heartbeat(HeartbeatRequest heartbeatRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateDeploymentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateDeploymentRequest.java
index 5b912d11a..42c3bad59 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateDeploymentRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateDeploymentRequest.java
@@ -17,7 +17,7 @@ public class CreateDeploymentRequest {
/**
* The ID to use for the deployment, which will become the final component of the deployment's
- * resource name (i.e. `deployments/{deployment_id}`).
+ * resource name (i.e. {@code deployments/{deployment_id}}).
*/
@JsonIgnore
@QueryParam("deployment_id")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java
index 64a4a00bc..763f579fe 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java
@@ -21,8 +21,9 @@ public class CreateVersionRequest {
private Version version;
/**
- * The version ID the caller expects to create. The server validates this equals `last_version_id
- * + 1` on the deployment. If it doesn't match, the server returns `ABORTED`.
+ * The version ID the caller expects to create. The server validates this equals {@code
+ * last_version_id + 1} on the deployment. If it doesn't match, the server returns {@code
+ * ABORTED}.
*/
@JsonIgnore
@QueryParam("version_id")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Deployment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Deployment.java
index 1e4a112fe..9669f51be 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Deployment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Deployment.java
@@ -27,9 +27,9 @@ public class Deployment {
private DeploymentMode deploymentMode;
/**
- * When the deployment was destroyed (i.e. `bundle destroy` completed). Unset if the deployment
- * has not been destroyed. Named destroy_time (not delete_time) because this tracks the
- * `databricks bundle destroy` command, not the API-level deletion.
+ * When the deployment was destroyed (i.e. {@code bundle destroy} completed). Unset if the
+ * deployment has not been destroyed. Named destroy_time (not delete_time) because this tracks the
+ * {@code databricks bundle destroy} command, not the API-level deletion.
*/
@JsonProperty("destroy_time")
private Timestamp destroyTime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/DeploymentMode.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/DeploymentMode.java
index 0766b5d40..d2f6e897c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/DeploymentMode.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/DeploymentMode.java
@@ -5,8 +5,8 @@
import com.databricks.sdk.support.Generated;
/**
- * Bundle target deployment mode. Mirrors the `mode` field on a bundle target in `databricks.yml`
- * (see https://docs.databricks.com/dev-tools/bundles/deployment-modes).
+ * Bundle target deployment mode. Mirrors the {@code mode} field on a bundle target in {@code
+ * databricks.yml} (see https://docs.databricks.com/dev-tools/bundles/deployment-modes).
*/
@Generated
public enum DeploymentMode {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsRequest.java
index 0e81e71e3..399d3d452 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsRequest.java
@@ -20,8 +20,8 @@ public class ListDeploymentsRequest {
private Long pageSize;
/**
- * A page token, received from a previous `ListDeployments` call. Provide this to retrieve the
- * subsequent page.
+ * A page token, received from a previous {@code ListDeployments} call. Provide this to retrieve
+ * the subsequent page.
*/
@JsonIgnore
@QueryParam("page_token")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsResponse.java
index 96379eaa6..18dc65e29 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/ListDeploymentsResponse.java
@@ -16,8 +16,8 @@ public class ListDeploymentsResponse {
private Collection The caller must be a metastore admin and have the `CREATE_STORAGE_CREDENTIAL` privilege on
- * the metastore.
+ * The caller must be a metastore admin and have the {@code CREATE_STORAGE_CREDENTIAL}
+ * privilege on the metastore.
*/
public AccountsCreateStorageCredentialInfo create(AccountsCreateStorageCredential request) {
return impl.create(request);
@@ -83,7 +87,8 @@ public Iterable The caller must be a metastore admin and have the `CREATE_STORAGE_CREDENTIAL` privilege on
- * the metastore.
+ * The caller must be a metastore admin and have the {@code CREATE_STORAGE_CREDENTIAL}
+ * privilege on the metastore.
*/
AccountsCreateStorageCredentialInfo create(
AccountsCreateStorageCredential accountsCreateStorageCredential);
@@ -43,7 +47,8 @@ ListAccountStorageCredentialsResponse list(
/**
* Updates a storage credential on the metastore. The caller must be the owner of the storage
- * credential. If the caller is a metastore admin, only the **owner** credential can be changed.
+ * credential. If the caller is a metastore admin, only the owner credential can be
+ * changed.
*/
AccountsUpdateStorageCredentialResponse update(
AccountsUpdateStorageCredential accountsUpdateStorageCredential);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsAPI.java
index 91058a327..f55fd1139 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsAPI.java
@@ -7,8 +7,9 @@
import com.databricks.sdk.support.Generated;
/**
- * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
- * in UC so that users can leverage these artifacts on compute configured with shared access mode.
+ * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the {@code
+ * allowlist} in UC so that users can leverage these artifacts on compute configured with shared
+ * access mode.
*/
@Generated
public class ArtifactAllowlistsAPI {
@@ -32,7 +33,7 @@ public ArtifactAllowlistInfo get(ArtifactType artifactType) {
/**
* Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or
- * have the **MANAGE ALLOWLIST** privilege on the metastore.
+ * have the MANAGE ALLOWLIST privilege on the metastore.
*/
public ArtifactAllowlistInfo get(GetArtifactAllowlistRequest request) {
return impl.get(request);
@@ -40,8 +41,8 @@ public ArtifactAllowlistInfo get(GetArtifactAllowlistRequest request) {
/**
* Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced
- * with the new allowlist. The caller must be a metastore admin or have the **MANAGE ALLOWLIST**
- * privilege on the metastore.
+ * with the new allowlist. The caller must be a metastore admin or have the MANAGE
+ * ALLOWLIST privilege on the metastore.
*/
public ArtifactAllowlistInfo update(SetArtifactAllowlist request) {
return impl.update(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsService.java
index fc6d248df..849cf0a36 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ArtifactAllowlistsService.java
@@ -4,8 +4,9 @@
import com.databricks.sdk.support.Generated;
/**
- * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
- * in UC so that users can leverage these artifacts on compute configured with shared access mode.
+ * In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the {@code
+ * allowlist} in UC so that users can leverage these artifacts on compute configured with shared
+ * access mode.
*
* This is the high-level interface, that contains generated methods.
*
@@ -15,14 +16,14 @@
public interface ArtifactAllowlistsService {
/**
* Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or
- * have the **MANAGE ALLOWLIST** privilege on the metastore.
+ * have the MANAGE ALLOWLIST privilege on the metastore.
*/
ArtifactAllowlistInfo get(GetArtifactAllowlistRequest getArtifactAllowlistRequest);
/**
* Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced
- * with the new allowlist. The caller must be a metastore admin or have the **MANAGE ALLOWLIST**
- * privilege on the metastore.
+ * with the new allowlist. The caller must be a metastore admin or have the MANAGE
+ * ALLOWLIST privilege on the metastore.
*/
ArtifactAllowlistInfo update(SetArtifactAllowlist setArtifactAllowlist);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentity.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentity.java
index 4cfcd3853..080124eb9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentity.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentity.java
@@ -11,8 +11,8 @@
@Generated
public class AzureManagedIdentity {
/**
- * The Azure resource ID of the Azure Databricks Access Connector. Use the format
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.
+ * The Azure resource ID of the Azure Databricks Access Connector. Use the format {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}}.
*/
@JsonProperty("access_connector_id")
private String accessConnectorId;
@@ -22,8 +22,8 @@ public class AzureManagedIdentity {
private String credentialId;
/**
- * The Azure resource ID of the managed identity. Use the format,
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`
+ * The Azure resource ID of the managed identity. Use the format, {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}}
* This is only available for user-assgined identities. For system-assigned identities, the
* access_connector_id is used to identify the identity. If this field is not provided, then we
* assume the AzureManagedIdentity is using the system-assigned identity.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityRequest.java
index ea5519ae0..4e0bc184f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityRequest.java
@@ -11,15 +11,15 @@
@Generated
public class AzureManagedIdentityRequest {
/**
- * The Azure resource ID of the Azure Databricks Access Connector. Use the format
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.
+ * The Azure resource ID of the Azure Databricks Access Connector. Use the format {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}}.
*/
@JsonProperty("access_connector_id")
private String accessConnectorId;
/**
- * The Azure resource ID of the managed identity. Use the format,
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`
+ * The Azure resource ID of the managed identity. Use the format, {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}}
* This is only available for user-assgined identities. For system-assigned identities, the
* access_connector_id is used to identify the identity. If this field is not provided, then we
* assume the AzureManagedIdentity is using the system-assigned identity.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityResponse.java
index 21a8c5c51..aa9f671d2 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureManagedIdentityResponse.java
@@ -11,8 +11,8 @@
@Generated
public class AzureManagedIdentityResponse {
/**
- * The Azure resource ID of the Azure Databricks Access Connector. Use the format
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.
+ * The Azure resource ID of the Azure Databricks Access Connector. Use the format {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}}.
*/
@JsonProperty("access_connector_id")
private String accessConnectorId;
@@ -22,8 +22,8 @@ public class AzureManagedIdentityResponse {
private String credentialId;
/**
- * The Azure resource ID of the managed identity. Use the format,
- * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`
+ * The Azure resource ID of the managed identity. Use the format, {@code
+ * /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}}
* This is only available for user-assgined identities. For system-assigned identities, the
* access_connector_id is used to identify the identity. If this field is not provided, then we
* assume the AzureManagedIdentity is using the system-assigned identity.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureServicePrincipal.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureServicePrincipal.java
index e9d410aad..ac560a7fe 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureServicePrincipal.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureServicePrincipal.java
@@ -7,7 +7,7 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
-/** The Azure service principal configuration. Only applicable when purpose is **STORAGE**. */
+/** The Azure service principal configuration. Only applicable when purpose is STORAGE. */
@Generated
public class AzureServicePrincipal {
/** The application ID of the application registration within the referenced AAD tenant. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CancelRefreshRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CancelRefreshRequest.java
index 7b5262eb8..cf462e983 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CancelRefreshRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CancelRefreshRequest.java
@@ -13,8 +13,8 @@ public class CancelRefreshRequest {
@JsonIgnore private Long refreshId;
/**
- * UC table name in format `catalog.schema.table_name`. table_name is case insensitive and spaces
- * are disallowed.
+ * UC table name in format {@code catalog.schema.table_name}. table_name is case insensitive and
+ * spaces are disallowed.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsAPI.java
index ad279aa1d..b0a2f7922 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsAPI.java
@@ -34,7 +34,7 @@ public CatalogsAPI(CatalogsService mock) {
/**
* Creates a new catalog instance in the parent metastore if the caller is a metastore admin or
- * has the **CREATE_CATALOG** privilege.
+ * has the CREATE_CATALOG privilege.
*/
public CatalogInfo create(CreateCatalog request) {
return impl.create(request);
@@ -58,7 +58,7 @@ public CatalogInfo get(String name) {
/**
* Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of
- * the catalog, or a user that has the **USE_CATALOG** privilege set for their account.
+ * the catalog, or a user that has the USE_CATALOG privilege set for their account.
*/
public CatalogInfo get(GetCatalogRequest request) {
return impl.get(request);
@@ -67,13 +67,13 @@ public CatalogInfo get(GetCatalogRequest request) {
/**
* Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs
* will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has
- * the **USE_CATALOG** privilege) will be retrieved. There is no guarantee of a specific ordering
- * of the elements in the array.
+ * the USE_CATALOG privilege) will be retrieved. There is no guarantee of a specific
+ * ordering of the elements in the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsService.java
index 2e28df9d7..e0591b375 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogsService.java
@@ -20,7 +20,7 @@
public interface CatalogsService {
/**
* Creates a new catalog instance in the parent metastore if the caller is a metastore admin or
- * has the **CREATE_CATALOG** privilege.
+ * has the CREATE_CATALOG privilege.
*/
CatalogInfo create(CreateCatalog createCatalog);
@@ -32,20 +32,20 @@ public interface CatalogsService {
/**
* Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of
- * the catalog, or a user that has the **USE_CATALOG** privilege set for their account.
+ * the catalog, or a user that has the USE_CATALOG privilege set for their account.
*/
CatalogInfo get(GetCatalogRequest getCatalogRequest);
/**
* Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs
* will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has
- * the **USE_CATALOG** privilege) will be retrieved. There is no guarantee of a specific ordering
- * of the elements in the array.
+ * the USE_CATALOG privilege) will be retrieved. There is no guarantee of a specific
+ * ordering of the elements in the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionDependency.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionDependency.java
index 39a045978..6fdf141a5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionDependency.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionDependency.java
@@ -10,7 +10,7 @@
/** A connection that is dependent on a SQL object. */
@Generated
public class ConnectionDependency {
- /** Full name of the dependent connection, in the form of __connection_name__. */
+ /** Full name of the dependent connection, in the form of connection_name. */
@JsonProperty("connection_name")
private String connectionName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsAPI.java
index 95d7b10c7..9d89ec0cc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsAPI.java
@@ -68,7 +68,7 @@ public ConnectionInfo get(GetConnectionRequest request) {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsService.java
index f86a73b2f..7f767746a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionsService.java
@@ -40,7 +40,7 @@ public interface ConnectionsService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccessRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccessRequest.java
index ad2e25601..5412e4a06 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccessRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccessRequest.java
@@ -11,8 +11,8 @@
@Generated
public class CreateAccessRequest {
/**
- * Optional. The principal this request is for. Empty `behalf_of` defaults to the requester's
- * identity.
+ * Optional. The principal this request is for. Empty {@code behalf_of} defaults to the
+ * requester's identity.
*
* Principals must be unique across the API call.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsMetastore.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsMetastore.java
index 02658871b..3ce015689 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsMetastore.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsMetastore.java
@@ -17,7 +17,7 @@ public class CreateAccountsMetastore {
@JsonProperty("name")
private String name;
- /** Cloud region which the metastore serves (e.g., `us-west-2`, `westus`). */
+ /** Cloud region which the metastore serves (e.g., {@code us-west-2}, {@code westus}). */
@JsonProperty("region")
private String region;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java
index 8e636a900..37d87b28c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java
@@ -42,7 +42,7 @@ public class CreateAccountsStorageCredential {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCredentialRequest.java
index 10ea0adeb..d30c54003 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCredentialRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCredentialRequest.java
@@ -42,7 +42,7 @@ public class CreateCredentialRequest {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java
index f37810b3b..5b8423d91 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java
@@ -17,23 +17,23 @@ public class CreateExternalLocation {
@JsonProperty("credential_name")
private String credentialName;
- /** The effective value of `enable_file_events` after applying server-side defaults. */
+ /** The effective value of {@code enable_file_events} after applying server-side defaults. */
@JsonProperty("effective_enable_file_events")
private Boolean effectiveEnableFileEvents;
/**
* The effective file event queue configuration after applying server-side defaults. Always
- * populated when a queue is provisioned, regardless of whether the user explicitly set
- * `enable_file_events`. Use this field instead of `file_event_queue` for reading the actual queue
- * state.
+ * populated when a queue is provisioned, regardless of whether the user explicitly set {@code
+ * enable_file_events}. Use this field instead of {@code file_event_queue} for reading the actual
+ * queue state.
*/
@JsonProperty("effective_file_event_queue")
private FileEventQueue effectiveFileEventQueue;
/**
- * Whether to enable file events on this external location. Default to `true`. Set to `false` to
- * disable file events. The actual applied value may differ due to server-side defaults; check
- * `effective_enable_file_events` for the effective state.
+ * Whether to enable file events on this external location. Default to {@code true}. Set to {@code
+ * false} to disable file events. The actual applied value may differ due to server-side defaults;
+ * check {@code effective_enable_file_events} for the effective state.
*/
@JsonProperty("enable_file_events")
private Boolean enableFileEvents;
@@ -51,8 +51,8 @@ public class CreateExternalLocation {
private Boolean fallback;
/**
- * File event queue settings. If `enable_file_events` is not `false`, must be defined and have
- * exactly one of the documented properties.
+ * File event queue settings. If {@code enable_file_events} is not {@code false}, must be defined
+ * and have exactly one of the documented properties.
*/
@JsonProperty("file_event_queue")
private FileEventQueue fileEventQueue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunction.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunction.java
index 56a9b59e3..342a70768 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunction.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunction.java
@@ -49,7 +49,7 @@ public class CreateFunction {
@JsonProperty("name")
private String name;
- /** Function parameter style. **S** is the value for SQL. */
+ /** Function parameter style. S is the value for SQL. */
@JsonProperty("parameter_style")
private CreateFunctionParameterStyle parameterStyle;
@@ -62,10 +62,10 @@ public class CreateFunction {
private FunctionParameterInfos returnParams;
/**
- * Function language. When **EXTERNAL** is used, the language of the routine function should be
- * specified in the **external_language** field, and the **return_params** of the function cannot
- * be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be
- * **NO_SQL**.
+ * Function language. When EXTERNAL is used, the language of the routine function should be
+ * specified in the external_language field, and the return_params of the function
+ * cannot be used (as TABLE return type is not supported), and the sql_data_access
+ * field must be NO_SQL.
*/
@JsonProperty("routine_body")
private CreateFunctionRoutineBody routineBody;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunctionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunctionRequest.java
index 16a8227e7..a54c3e25c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunctionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateFunctionRequest.java
@@ -9,7 +9,7 @@
@Generated
public class CreateFunctionRequest {
- /** Partial __FunctionInfo__ specifying the function to be created. */
+ /** Partial FunctionInfo specifying the function to be created. */
@JsonProperty("function_info")
private CreateFunction functionInfo;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMetastore.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMetastore.java
index 091a5fc23..a2ce4c407 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMetastore.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMetastore.java
@@ -17,7 +17,7 @@ public class CreateMetastore {
@JsonProperty("name")
private String name;
- /** Cloud region which the metastore serves (e.g., `us-west-2`, `westus`). */
+ /** Cloud region which the metastore serves (e.g., {@code us-west-2}, {@code westus}). */
@JsonProperty("region")
private String region;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMonitor.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMonitor.java
index 64cafe5da..bfda298b9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMonitor.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMonitor.java
@@ -21,8 +21,8 @@ public class CreateMonitor {
/**
* [Create:OPT Update:OPT] Baseline table name. Baseline data is used to compute drift from the
- * data in the monitored `table_name`. The baseline table and the monitored table shall have the
- * same schema.
+ * data in the monitored {@code table_name}. The baseline table and the monitored table shall have
+ * the same schema.
*/
@JsonProperty("baseline_table_name")
private String baselineTableName;
@@ -65,10 +65,10 @@ public class CreateMonitor {
/**
* [Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis.
* The data is grouped by each expression independently, resulting in a separate slice for each
- * predicate and its complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will
- * generate the following slices: two slices for `col_2 > 10` (True and False), and one slice per
- * unique value in `col1`. For high-cardinality columns, only the top 100 unique values by
- * frequency will generate slices.
+ * predicate and its complements. For example {@code slicing_exprs=[“col_1”, “col_2 > 10”]} will
+ * generate the following slices: two slices for {@code col_2 > 10} (True and False), and one
+ * slice per unique value in {@code col1}. For high-cardinality columns, only the top 100 unique
+ * values by frequency will generate slices.
*/
@JsonProperty("slicing_exprs")
private Collection [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external
+ * the parent catalog, or the Metastore. Learn more
*/
@JsonProperty("volume_type")
private VolumeType volumeType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialDependency.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialDependency.java
index dffd56f22..9e6f3e794 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialDependency.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialDependency.java
@@ -10,7 +10,7 @@
/** A credential that is dependent on a SQL object. */
@Generated
public class CredentialDependency {
- /** Full name of the dependent credential, in the form of __credential_name__. */
+ /** Full name of the dependent credential, in the form of credential_name. */
@JsonProperty("credential_name")
private String credentialName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java
index 002c7de8e..e3a2c1553 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java
@@ -73,7 +73,7 @@ public class CredentialInfo {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
@@ -88,7 +88,7 @@ public class CredentialInfo {
/**
* Whether this credential is the current metastore's root storage credential. Only applicable
- * when purpose is **STORAGE**.
+ * when purpose is STORAGE.
*/
@JsonProperty("used_for_managed_storage")
private Boolean usedForManagedStorage;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialValidationResult.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialValidationResult.java
index a823a5348..5382b818b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialValidationResult.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialValidationResult.java
@@ -9,7 +9,7 @@
@Generated
public class CredentialValidationResult {
- /** Error message would exist when the result does not equal to **PASS**. */
+ /** Error message would exist when the result does not equal to PASS. */
@JsonProperty("message")
private String message;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsAPI.java
index 149b025f6..5e1933b3f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsAPI.java
@@ -12,9 +12,9 @@
* your cloud tenant. Each credential is subject to Unity Catalog access-control policies that
* control which users and groups can access the credential.
*
- * To create credentials, you must be a Databricks account admin or have the `CREATE SERVICE
- * CREDENTIAL` privilege. The user who creates the credential can delegate ownership to another user
- * or group to manage permissions on it.
+ * To create credentials, you must be a Databricks account admin or have the {@code CREATE
+ * SERVICE CREDENTIAL} privilege. The user who creates the credential can delegate ownership to
+ * another user or group to manage permissions on it.
*/
@Generated
public class CredentialsAPI {
@@ -33,12 +33,12 @@ public CredentialsAPI(CredentialsService mock) {
}
/**
- * Creates a new credential. The type of credential to be created is determined by the **purpose**
- * field, which should be either **SERVICE** or **STORAGE**.
+ * Creates a new credential. The type of credential to be created is determined by the
+ * purpose field, which should be either SERVICE or STORAGE.
*
* The caller must be a metastore admin or have the metastore privilege
- * **CREATE_STORAGE_CREDENTIAL** for storage credentials, or **CREATE_SERVICE_CREDENTIAL** for
- * service credentials.
+ * CREATE_STORAGE_CREDENTIAL for storage credentials, or CREATE_SERVICE_CREDENTIAL
+ * for service credentials.
*/
public CredentialInfo createCredential(CreateCredentialRequest request) {
return impl.createCredential(request);
@@ -58,7 +58,7 @@ public void deleteCredential(DeleteCredentialRequest request) {
/**
* Returns a set of temporary credentials generated using the specified service credential. The
- * caller must be a metastore admin or have the metastore privilege **ACCESS** on the service
+ * caller must be a metastore admin or have the metastore privilege ACCESS on the service
* credential.
*/
public TemporaryCredentials generateTemporaryServiceCredential(
@@ -79,7 +79,7 @@ public CredentialInfo getCredential(GetCredentialRequest request) {
}
/**
- * Gets an array of credentials (as __CredentialInfo__ objects).
+ * Gets an array of credentials (as CredentialInfo objects).
*
* The array is limited to only the credentials that the caller has permission to access. If
* the caller is a metastore admin, retrieval of credentials is unrestricted. There is no
@@ -106,8 +106,9 @@ public Iterable The caller must be the owner of the credential or a metastore admin or have the `MANAGE`
- * permission. If the caller is a metastore admin, only the __owner__ field can be changed.
+ * The caller must be the owner of the credential or a metastore admin or have the {@code
+ * MANAGE} permission. If the caller is a metastore admin, only the owner field can be
+ * changed.
*/
public CredentialInfo updateCredential(UpdateCredentialRequest request) {
return impl.updateCredential(request);
@@ -116,18 +117,18 @@ public CredentialInfo updateCredential(UpdateCredentialRequest request) {
/**
* Validates a credential.
*
- * For service credentials (purpose is **SERVICE**), either the __credential_name__ or the
- * cloud-specific credential must be provided.
+ * For service credentials (purpose is SERVICE), either the credential_name or
+ * the cloud-specific credential must be provided.
*
- * For storage credentials (purpose is **STORAGE**), at least one of __external_location_name__
- * and __url__ need to be provided. If only one of them is provided, it will be used for
- * validation. And if both are provided, the __url__ will be used for validation, and
- * __external_location_name__ will be ignored when checking overlapping urls. Either the
- * __credential_name__ or the cloud-specific credential must be provided.
+ * For storage credentials (purpose is STORAGE), at least one of
+ * external_location_name and url need to be provided. If only one of them is
+ * provided, it will be used for validation. And if both are provided, the url will be used
+ * for validation, and external_location_name will be ignored when checking overlapping
+ * urls. Either the credential_name or the cloud-specific credential must be provided.
*
* The caller must be a metastore admin or the credential owner or have the required permission
- * on the metastore and the credential (e.g., **CREATE_EXTERNAL_LOCATION** when purpose is
- * **STORAGE**).
+ * on the metastore and the credential (e.g., CREATE_EXTERNAL_LOCATION when purpose is
+ * STORAGE).
*/
public ValidateCredentialResponse validateCredential(ValidateCredentialRequest request) {
return impl.validateCredential(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsService.java
index c10706d32..56ef4394f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialsService.java
@@ -8,9 +8,9 @@
* your cloud tenant. Each credential is subject to Unity Catalog access-control policies that
* control which users and groups can access the credential.
*
- * To create credentials, you must be a Databricks account admin or have the `CREATE SERVICE
- * CREDENTIAL` privilege. The user who creates the credential can delegate ownership to another user
- * or group to manage permissions on it.
+ * To create credentials, you must be a Databricks account admin or have the {@code CREATE
+ * SERVICE CREDENTIAL} privilege. The user who creates the credential can delegate ownership to
+ * another user or group to manage permissions on it.
*
* This is the high-level interface, that contains generated methods.
*
@@ -19,12 +19,12 @@
@Generated
public interface CredentialsService {
/**
- * Creates a new credential. The type of credential to be created is determined by the **purpose**
- * field, which should be either **SERVICE** or **STORAGE**.
+ * Creates a new credential. The type of credential to be created is determined by the
+ * purpose field, which should be either SERVICE or STORAGE.
*
* The caller must be a metastore admin or have the metastore privilege
- * **CREATE_STORAGE_CREDENTIAL** for storage credentials, or **CREATE_SERVICE_CREDENTIAL** for
- * service credentials.
+ * CREATE_STORAGE_CREDENTIAL for storage credentials, or CREATE_SERVICE_CREDENTIAL
+ * for service credentials.
*/
CredentialInfo createCredential(CreateCredentialRequest createCredentialRequest);
@@ -36,7 +36,7 @@ public interface CredentialsService {
/**
* Returns a set of temporary credentials generated using the specified service credential. The
- * caller must be a metastore admin or have the metastore privilege **ACCESS** on the service
+ * caller must be a metastore admin or have the metastore privilege ACCESS on the service
* credential.
*/
TemporaryCredentials generateTemporaryServiceCredential(
@@ -49,7 +49,7 @@ TemporaryCredentials generateTemporaryServiceCredential(
CredentialInfo getCredential(GetCredentialRequest getCredentialRequest);
/**
- * Gets an array of credentials (as __CredentialInfo__ objects).
+ * Gets an array of credentials (as CredentialInfo objects).
*
* The array is limited to only the credentials that the caller has permission to access. If
* the caller is a metastore admin, retrieval of credentials is unrestricted. There is no
@@ -64,26 +64,27 @@ TemporaryCredentials generateTemporaryServiceCredential(
/**
* Updates a service or storage credential on the metastore.
*
- * The caller must be the owner of the credential or a metastore admin or have the `MANAGE`
- * permission. If the caller is a metastore admin, only the __owner__ field can be changed.
+ * The caller must be the owner of the credential or a metastore admin or have the {@code
+ * MANAGE} permission. If the caller is a metastore admin, only the owner field can be
+ * changed.
*/
CredentialInfo updateCredential(UpdateCredentialRequest updateCredentialRequest);
/**
* Validates a credential.
*
- * For service credentials (purpose is **SERVICE**), either the __credential_name__ or the
- * cloud-specific credential must be provided.
+ * For service credentials (purpose is SERVICE), either the credential_name or
+ * the cloud-specific credential must be provided.
*
- * For storage credentials (purpose is **STORAGE**), at least one of __external_location_name__
- * and __url__ need to be provided. If only one of them is provided, it will be used for
- * validation. And if both are provided, the __url__ will be used for validation, and
- * __external_location_name__ will be ignored when checking overlapping urls. Either the
- * __credential_name__ or the cloud-specific credential must be provided.
+ * For storage credentials (purpose is STORAGE), at least one of
+ * external_location_name and url need to be provided. If only one of them is
+ * provided, it will be used for validation. And if both are provided, the url will be used
+ * for validation, and external_location_name will be ignored when checking overlapping
+ * urls. Either the credential_name or the cloud-specific credential must be provided.
*
* The caller must be a metastore admin or the credential owner or have the required permission
- * on the metastore and the credential (e.g., **CREATE_EXTERNAL_LOCATION** when purpose is
- * **STORAGE**).
+ * on the metastore and the credential (e.g., CREATE_EXTERNAL_LOCATION when purpose is
+ * STORAGE).
*/
ValidateCredentialResponse validateCredential(
ValidateCredentialRequest validateCredentialRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java
index 67d0cc835..14b9bac83 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java
@@ -11,8 +11,8 @@
@Generated
public class DeleteCredentialRequest {
/**
- * Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent
- * external locations and external tables (when purpose is **STORAGE**).
+ * Force an update even if there are dependent services (when purpose is SERVICE) or
+ * dependent external locations and external tables (when purpose is STORAGE).
*/
@JsonIgnore
@QueryParam("force")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteFunctionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteFunctionRequest.java
index 35a82e3ec..906c40350 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteFunctionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteFunctionRequest.java
@@ -17,7 +17,7 @@ public class DeleteFunctionRequest {
/**
* The fully-qualified name of the function (of the form
- * __catalog_name__.__schema_name__.__function__name__) .
+ * catalog_name.schema_name.function__name) .
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteQualityMonitorRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteQualityMonitorRequest.java
index 03ce0a737..524e807fe 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteQualityMonitorRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteQualityMonitorRequest.java
@@ -10,7 +10,7 @@
@Generated
public class DeleteQualityMonitorRequest {
/**
- * UC table name in format `catalog.schema.table_name`. This field corresponds to the
+ * UC table name in format {@code catalog.schema.table_name}. This field corresponds to the
* {full_table_name_arg} arg in the endpoint path.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSecretRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSecretRequest.java
index 6ad224c23..e945bfe77 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSecretRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSecretRequest.java
@@ -11,7 +11,7 @@
public class DeleteSecretRequest {
/**
* The three-level (fully qualified) name of the secret (for example,
- * **catalog_name.schema_name.secret_name**).
+ * catalog_name.schema_name.secret_name).
*/
@JsonIgnore private String fullName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java
index 8c23769e9..bf51a110a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java
@@ -12,7 +12,7 @@
public class DeleteStorageCredentialRequest {
/**
* Force an update even if there are dependent external locations or external tables (when purpose
- * is **STORAGE**) or dependent services (when purpose is **SERVICE**).
+ * is STORAGE) or dependent services (when purpose is SERVICE).
*/
@JsonIgnore
@QueryParam("force")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeltaRuntimePropertiesKvPairs.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeltaRuntimePropertiesKvPairs.java
index 8416788a2..27349f6e9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeltaRuntimePropertiesKvPairs.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeltaRuntimePropertiesKvPairs.java
@@ -10,7 +10,7 @@
/**
* Properties pertaining to the current state of the delta table as given by the commit server. This
- * does not contain **delta.*** (input) properties in __TableInfo.properties__.
+ * does not contain delta.* (input) properties in TableInfo.properties.
*/
@Generated
public class DeltaRuntimePropertiesKvPairs {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Dependency.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Dependency.java
index 00f9f76e5..0901ff136 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Dependency.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Dependency.java
@@ -8,8 +8,8 @@
import java.util.Objects;
/**
- * A dependency of a SQL object. One of the following fields must be defined: __table__,
- * __function__, __connection__, __credential__, __volume__, or __secret__.
+ * A dependency of a SQL object. One of the following fields must be defined: table,
+ * function, connection, credential, volume, or secret.
*/
@Generated
public class Dependency {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EffectivePermissionsList.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EffectivePermissionsList.java
index 175d38ada..a5e39c364 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EffectivePermissionsList.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EffectivePermissionsList.java
@@ -12,7 +12,8 @@
public class EffectivePermissionsList {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsAPI.java
index e1e425506..19dc21daa 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsAPI.java
@@ -33,14 +33,18 @@ public EntityTagAssignmentsAPI(EntityTagAssignmentsService mock) {
* Creates a tag assignment for an Unity Catalog entity.
*
* To add tags to Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema -
- * **USE CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To add a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To add a governed tag to Unity Catalog entities, you must also have the ASSIGN or
+ * MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
public EntityTagAssignment create(CreateEntityTagAssignmentRequest request) {
return impl.create(request);
@@ -58,14 +62,18 @@ public void delete(String entityType, String entityName, String tagKey) {
* Deletes a tag assignment for an Unity Catalog entity by its key.
*
* To delete tags from Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on the entity's parent schema -
- * **USE_CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To delete a governed tag from Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To delete a governed tag from Unity Catalog entities, you must also have the ASSIGN
+ * or MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
public void delete(DeleteEntityTagAssignmentRequest request) {
impl.delete(request);
@@ -114,14 +122,18 @@ public Iterable To update tags to Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema -
- * **USE CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To update a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To update a governed tag to Unity Catalog entities, you must also have the ASSIGN or
+ * MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
public EntityTagAssignment update(UpdateEntityTagAssignmentRequest request) {
return impl.update(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsService.java
index 66b13ea63..29fe676fa 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EntityTagAssignmentsService.java
@@ -19,14 +19,18 @@ public interface EntityTagAssignmentsService {
* Creates a tag assignment for an Unity Catalog entity.
*
* To add tags to Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema -
- * **USE CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To add a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To add a governed tag to Unity Catalog entities, you must also have the ASSIGN or
+ * MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
EntityTagAssignment create(CreateEntityTagAssignmentRequest createEntityTagAssignmentRequest);
@@ -34,14 +38,18 @@ public interface EntityTagAssignmentsService {
* Deletes a tag assignment for an Unity Catalog entity by its key.
*
* To delete tags from Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on the entity's parent schema -
- * **USE_CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To delete a governed tag from Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To delete a governed tag from Unity Catalog entities, you must also have the ASSIGN
+ * or MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
void delete(DeleteEntityTagAssignmentRequest deleteEntityTagAssignmentRequest);
@@ -62,14 +70,18 @@ ListEntityTagAssignmentsResponse list(
* Updates an existing tag assignment for an Unity Catalog entity.
*
* To update tags to Unity Catalog entities, you must own the entity or have the following
- * privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema -
- * **USE CATALOG** on the entity's parent catalog
+ * privileges:
*
- * To update a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or
- * **MANAGE** permission on the tag policy. See [Manage tag policy permissions].
+ * [Manage tag policy permissions]:
- * https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions
+ * To update a governed tag to Unity Catalog entities, you must also have the ASSIGN or
+ * MANAGE permission on the tag policy. See Manage tag
+ * policy permissions.
*/
EntityTagAssignment update(UpdateEntityTagAssignmentRequest updateEntityTagAssignmentRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java
index a370e06da..b3a88b676 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java
@@ -36,23 +36,23 @@ public class ExternalLocationInfo {
@JsonProperty("credential_name")
private String credentialName;
- /** The effective value of `enable_file_events` after applying server-side defaults. */
+ /** The effective value of {@code enable_file_events} after applying server-side defaults. */
@JsonProperty("effective_enable_file_events")
private Boolean effectiveEnableFileEvents;
/**
* The effective file event queue configuration after applying server-side defaults. Always
- * populated when a queue is provisioned, regardless of whether the user explicitly set
- * `enable_file_events`. Use this field instead of `file_event_queue` for reading the actual queue
- * state.
+ * populated when a queue is provisioned, regardless of whether the user explicitly set {@code
+ * enable_file_events}. Use this field instead of {@code file_event_queue} for reading the actual
+ * queue state.
*/
@JsonProperty("effective_file_event_queue")
private FileEventQueue effectiveFileEventQueue;
/**
- * Whether to enable file events on this external location. Default to `true`. Set to `false` to
- * disable file events. The actual applied value may differ due to server-side defaults; check
- * `effective_enable_file_events` for the effective state.
+ * Whether to enable file events on this external location. Default to {@code true}. Set to {@code
+ * false} to disable file events. The actual applied value may differ due to server-side defaults;
+ * check {@code effective_enable_file_events} for the effective state.
*/
@JsonProperty("enable_file_events")
private Boolean enableFileEvents;
@@ -70,8 +70,8 @@ public class ExternalLocationInfo {
private Boolean fallback;
/**
- * File event queue settings. If `enable_file_events` is not `false`, must be defined and have
- * exactly one of the documented properties.
+ * File event queue settings. If {@code enable_file_events} is not {@code false}, must be defined
+ * and have exactly one of the documented properties.
*/
@JsonProperty("file_event_queue")
private FileEventQueue fileEventQueue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsAPI.java
index dcf5f6634..da04de5a2 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsAPI.java
@@ -17,7 +17,7 @@
* Databricks recommends using external locations rather than using storage credentials directly.
*
* To create external locations, you must be a metastore admin or a user with the
- * **CREATE_EXTERNAL_LOCATION** privilege.
+ * CREATE_EXTERNAL_LOCATION privilege.
*/
@Generated
public class ExternalLocationsAPI {
@@ -37,7 +37,7 @@ public ExternalLocationsAPI(ExternalLocationsService mock) {
/**
* Creates a new external location entry in the metastore. The caller must be a metastore admin or
- * have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated
+ * have the CREATE_EXTERNAL_LOCATION privilege on both the metastore and the associated
* storage credential.
*/
public ExternalLocationInfo create(CreateExternalLocation request) {
@@ -69,15 +69,15 @@ public ExternalLocationInfo get(GetExternalLocationRequest request) {
}
/**
- * Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The
- * caller must be a metastore admin, the owner of the external location, or a user that has some
- * privilege on the external location. There is no guarantee of a specific ordering of the
+ * Gets an array of external locations (ExternalLocationInfo objects) from the metastore.
+ * The caller must be a metastore admin, the owner of the external location, or a user that has
+ * some privilege on the external location. There is no guarantee of a specific ordering of the
* elements in the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsService.java
index d7307ebd1..be460d2b4 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationsService.java
@@ -13,7 +13,7 @@
* Databricks recommends using external locations rather than using storage credentials directly.
*
* To create external locations, you must be a metastore admin or a user with the
- * **CREATE_EXTERNAL_LOCATION** privilege.
+ * CREATE_EXTERNAL_LOCATION privilege.
*
* This is the high-level interface, that contains generated methods.
*
@@ -23,7 +23,7 @@
public interface ExternalLocationsService {
/**
* Creates a new external location entry in the metastore. The caller must be a metastore admin or
- * have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated
+ * have the CREATE_EXTERNAL_LOCATION privilege on both the metastore and the associated
* storage credential.
*/
ExternalLocationInfo create(CreateExternalLocation createExternalLocation);
@@ -41,15 +41,15 @@ public interface ExternalLocationsService {
ExternalLocationInfo get(GetExternalLocationRequest getExternalLocationRequest);
/**
- * Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The
- * caller must be a metastore admin, the owner of the external location, or a user that has some
- * privilege on the external location. There is no guarantee of a specific ordering of the
+ * Gets an array of external locations (ExternalLocationInfo objects) from the metastore.
+ * The caller must be a metastore admin, the owner of the external location, or a user that has
+ * some privilege on the external location. There is no guarantee of a specific ordering of the
* elements in the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
index c2b25c013..98fa010ee 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
@@ -33,8 +33,8 @@ public ExternalMetadataAPI(ExternalMetadataService mock) {
/**
* Creates a new external metadata object in the parent metastore if the caller is a metastore
- * admin or has the **CREATE_EXTERNAL_METADATA** privilege. Grants **BROWSE** to all account users
- * upon creation by default.
+ * admin or has the CREATE_EXTERNAL_METADATA privilege. Grants BROWSE to all account
+ * users upon creation by default.
*/
public ExternalMetadata createExternalMetadata(CreateExternalMetadataRequest request) {
return impl.createExternalMetadata(request);
@@ -46,8 +46,8 @@ public void deleteExternalMetadata(String name) {
/**
* Deletes the external metadata object that matches the supplied name. The caller must be a
- * metastore admin, the owner of the external metadata object, or a user that has the **MANAGE**
- * privilege.
+ * metastore admin, the owner of the external metadata object, or a user that has the
+ * MANAGE privilege.
*/
public void deleteExternalMetadata(DeleteExternalMetadataRequest request) {
impl.deleteExternalMetadata(request);
@@ -59,7 +59,8 @@ public ExternalMetadata getExternalMetadata(String name) {
/**
* Gets the specified external metadata object in a metastore. The caller must be a metastore
- * admin, the owner of the external metadata object, or a user that has the **BROWSE** privilege.
+ * admin, the owner of the external metadata object, or a user that has the BROWSE
+ * privilege.
*/
public ExternalMetadata getExternalMetadata(GetExternalMetadataRequest request) {
return impl.getExternalMetadata(request);
@@ -68,7 +69,7 @@ public ExternalMetadata getExternalMetadata(GetExternalMetadataRequest request)
/**
* Gets an array of external metadata objects in the metastore. If the caller is the metastore
* admin, all external metadata objects will be retrieved. Otherwise, only external metadata
- * objects that the caller has **BROWSE** on will be retrieved. There is no guarantee of a
+ * objects that the caller has BROWSE on will be retrieved. There is no guarantee of a
* specific ordering of the elements in the array.
*/
public Iterable The function implementation can be any SQL expression or Query, and it can be invoked wherever
* a table reference is allowed in a query. In Unity Catalog, a function resides at the same level
* as a table, so it can be referenced with the form
- * __catalog_name__.__schema_name__.__function_name__.
+ * catalog_name.schema_name.function_name.
*/
@Generated
public class FunctionsAPI {
@@ -32,13 +32,16 @@ public FunctionsAPI(FunctionsService mock) {
}
/**
- * **WARNING: This API is experimental and will change in future versions**
+ * WARNING: This API is experimental and will change in future versions
*
* Creates a new function
*
- * The user must have the following permissions in order for the function to be created: -
- * **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** and **CREATE_FUNCTION** on
- * the function's parent schema
+ * The user must have the following permissions in order for the function to be created:
+ *
+ * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -116,10 +130,17 @@ public Iterable The function implementation can be any SQL expression or Query, and it can be invoked wherever
* a table reference is allowed in a query. In Unity Catalog, a function resides at the same level
* as a table, so it can be referenced with the form
- * __catalog_name__.__schema_name__.__function_name__.
+ * catalog_name.schema_name.function_name.
*
* This is the high-level interface, that contains generated methods.
*
@@ -18,47 +18,61 @@
@Generated
public interface FunctionsService {
/**
- * **WARNING: This API is experimental and will change in future versions**
+ * WARNING: This API is experimental and will change in future versions
*
* Creates a new function
*
- * The user must have the following permissions in order for the function to be created: -
- * **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** and **CREATE_FUNCTION** on
- * the function's parent schema
+ * The user must have the following permissions in order for the function to be created:
+ *
+ * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -68,10 +82,17 @@ public interface FunctionsService {
/**
* Updates the function that matches the supplied name. Only the owner of the function can be
* updated. If the user is not a metastore admin, the user must be a member of the group that is
- * the new function owner. - Is a metastore admin - Is the owner of the function's parent catalog
- * - Is the owner of the function's parent schema and has the **USE_CATALOG** privilege on its
- * parent catalog - Is the owner of the function itself and has the **USE_CATALOG** privilege on
- * its parent catalog as well as the **USE_SCHEMA** privilege on the function's parent schema.
+ * the new function owner.
+ *
+ * If not set, all the effective permissions are returned. If set to - lesser than 0: invalid
- * parameter error - 0: page length is set to a server configured value - lesser than 150 but
- * greater than 0: invalid parameter error (this is to ensure that server is able to return at
- * least one complete EffectivePrivilegeAssignment in a single page response) - greater than (or
- * equal to) 150: page length is the minimum of this value and a server configured value
+ * If not set, all the effective permissions are returned. If set to
+ *
+ * If not set, all the permissions are returned. If set to - lesser than 0: invalid parameter
- * error - 0: page length is set to a server configured value - lesser than 150 but greater than
- * 0: invalid parameter error (this is to ensure that server is able to return at least one
- * complete PrivilegeAssignment in a single page response) - greater than (or equal to) 150: page
- * length is the minimum of this value and a server configured value
+ * If not set, all the permissions are returned. If set to
+ *
+ * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -64,7 +64,7 @@ public EffectivePermissionsList getEffective(String securableType, String fullNa
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsService.java
index 11f9831f7..3e1aee940 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsService.java
@@ -26,7 +26,7 @@ public interface GrantsService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -40,7 +40,7 @@ public interface GrantsService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java
index 758e8afff..6aa0f93ca 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java
@@ -27,13 +27,18 @@ public class ListCatalogsRequest {
private Boolean includeUnbound;
/**
- * Maximum number of catalogs to return. - when set to 0, the page length is set to a server
- * configured value (recommended); - when set to a value greater than 0, the page length is the
- * minimum of this value and a server configured value; - when set to a value less than 0, an
- * invalid parameter error is returned; - If not set, all valid catalogs are returned (not
- * recommended). - Note: The number of returned catalogs might be less than the specified
- * max_results size, even zero. The only definitive indication that no further catalogs can be
- * fetched is when the next_page_token is unset from the response.
+ * Maximum number of catalogs to return.
+ *
+ * If both catalog and schema are specified: - when max_results is not specified, the page
- * length is set to a server configured value (10000, as of 4/2/2024). - when set to a value
- * greater than 0, the page length is the minimum of this value and a server configured value
- * (10000, as of 4/2/2024); - when set to 0, the page length is set to a server configured value
- * (10000, as of 4/2/2024); - when set to a value less than 0, an invalid parameter error is
- * returned;
+ * If both catalog and schema are specified:
*
- * If neither schema nor catalog is specified: - when max_results is not specified, the page
- * length is set to a server configured value (100, as of 4/2/2024). - when set to a value greater
- * than 0, the page length is the minimum of this value and a server configured value (1000, as of
- * 4/2/2024); - when set to 0, the page length is set to a server configured value (100, as of
- * 4/2/2024); - when set to a value less than 0, an invalid parameter error is returned;
+ * If neither schema nor catalog is specified:
+ *
+ * - If not specified, at most 10000 secrets are returned. - If set to a value greater than 0,
- * the page length is the minimum of this value and 10000. - If set to 0, the page length is set
- * to 10000. - If set to a value less than 0, an invalid parameter error is returned.
+ * If not set, the page length is set to a server configured value (10000, as of 1/29/2024). -
- * when set to a value greater than 0, the page length is the minimum of this value and a server
- * configured value (10000, as of 1/29/2024); - when set to 0, the page length is set to a server
- * configured value (10000, as of 1/29/2024) (recommended); - when set to a value less than 0, an
- * invalid parameter error is returned;
+ * If not set, the page length is set to a server configured value (10000, as of 1/29/2024).
+ *
+ * Note: this parameter controls only the maximum number of volumes to return. The actual
* number of volumes returned in a page may be smaller than this value, including 0, even if there
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesResponseContent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesResponseContent.java
index 2df7aebe6..12ac997d9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesResponseContent.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesResponseContent.java
@@ -12,7 +12,7 @@
public class ListVolumesResponseContent {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request to retrieve the next page of
+ * page_token should be set to this value for the next request to retrieve the next page of
* results.
*/
@JsonProperty("next_page_token")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoreInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoreInfo.java
index 2a4d57758..84660d411 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoreInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoreInfo.java
@@ -9,7 +9,7 @@
@Generated
public class MetastoreInfo {
- /** Cloud vendor of the metastore home shard (e.g., `aws`, `azure`, `gcp`). */
+ /** Cloud vendor of the metastore home shard (e.g., {@code aws}, {@code azure}, {@code gcp}). */
@JsonProperty("cloud")
private String cloud;
@@ -45,8 +45,8 @@ public class MetastoreInfo {
private Boolean externalAccessEnabled;
/**
- * Globally unique metastore ID across clouds and regions, of the form
- * `cloud:region:metastore_id`.
+ * Globally unique metastore ID across clouds and regions, of the form {@code
+ * cloud:region:metastore_id}.
*/
@JsonProperty("global_metastore_id")
private String globalMetastoreId;
@@ -63,11 +63,13 @@ public class MetastoreInfo {
@JsonProperty("owner")
private String owner;
- /** Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`). */
+ /**
+ * Privilege model version of the metastore, of the form {@code major.minor} (e.g., {@code 1.0}).
+ */
@JsonProperty("privilege_model_version")
private String privilegeModelVersion;
- /** Cloud region which the metastore serves (e.g., `us-west-2`, `westus`). */
+ /** Cloud region which the metastore serves (e.g., {@code us-west-2}, {@code westus}). */
@JsonProperty("region")
private String region;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresAPI.java
index 4704e9712..16680cdac 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresAPI.java
@@ -37,9 +37,9 @@ public MetastoresAPI(MetastoresService mock) {
}
/**
- * Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it
- * will be overwritten by the new __metastore_id__ and __default_catalog_name__. The caller must
- * be an account admin.
+ * Creates a new metastore assignment. If an assignment for the same workspace_id exists,
+ * it will be overwritten by the new metastore_id and default_catalog_name. The
+ * caller must be an account admin.
*/
public void assign(CreateMetastoreAssignment request) {
impl.assign(request);
@@ -47,9 +47,9 @@ public void assign(CreateMetastoreAssignment request) {
/**
* Creates a new metastore based on a provided name and optional storage root path. By default (if
- * the __owner__ field is not set), the owner of the new metastore is the user calling the
- * __createMetastore__ API. If the __owner__ field is set to the empty string (**""**), the
- * ownership is assigned to the System User instead.
+ * the owner field is not set), the owner of the new metastore is the user calling the
+ * createMetastore API. If the owner field is set to the empty string (""),
+ * the ownership is assigned to the System User instead.
*/
public MetastoreInfo create(CreateMetastore request) {
return impl.create(request);
@@ -82,14 +82,14 @@ public MetastoreInfo get(GetMetastoreRequest request) {
}
/**
- * Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an
- * admin to retrieve this info. There is no guarantee of a specific ordering of the elements in
+ * Gets an array of the available metastores (as MetastoreInfo objects). The caller must be
+ * an admin to retrieve this info. There is no guarantee of a specific ordering of the elements in
* the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -131,17 +131,17 @@ public void unassign(UnassignRequest request) {
/**
* Updates information for a specific metastore. The caller must be a metastore admin. If the
- * __owner__ field is set to the empty string (**""**), the ownership is updated to the System
- * User.
+ * owner field is set to the empty string (""), the ownership is updated to the
+ * System User.
*/
public MetastoreInfo update(UpdateMetastore request) {
return impl.update(request);
}
/**
- * Updates a metastore assignment. This operation can be used to update __metastore_id__ or
- * __default_catalog_name__ for a specified Workspace, if the Workspace is already assigned a
- * metastore. The caller must be an account admin to update __metastore_id__; otherwise, the
+ * Updates a metastore assignment. This operation can be used to update metastore_id or
+ * default_catalog_name for a specified Workspace, if the Workspace is already assigned a
+ * metastore. The caller must be an account admin to update metastore_id; otherwise, the
* caller can be a Workspace admin.
*/
public void updateAssignment(UpdateMetastoreAssignment request) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresService.java
index 7efb89b22..dc4763977 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MetastoresService.java
@@ -23,17 +23,17 @@
@Generated
public interface MetastoresService {
/**
- * Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it
- * will be overwritten by the new __metastore_id__ and __default_catalog_name__. The caller must
- * be an account admin.
+ * Creates a new metastore assignment. If an assignment for the same workspace_id exists,
+ * it will be overwritten by the new metastore_id and default_catalog_name. The
+ * caller must be an account admin.
*/
void assign(CreateMetastoreAssignment createMetastoreAssignment);
/**
* Creates a new metastore based on a provided name and optional storage root path. By default (if
- * the __owner__ field is not set), the owner of the new metastore is the user calling the
- * __createMetastore__ API. If the __owner__ field is set to the empty string (**""**), the
- * ownership is assigned to the System User instead.
+ * the owner field is not set), the owner of the new metastore is the user calling the
+ * createMetastore API. If the owner field is set to the empty string (""),
+ * the ownership is assigned to the System User instead.
*/
MetastoreInfo create(CreateMetastore createMetastore);
@@ -50,14 +50,14 @@ public interface MetastoresService {
MetastoreInfo get(GetMetastoreRequest getMetastoreRequest);
/**
- * Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an
- * admin to retrieve this info. There is no guarantee of a specific ordering of the elements in
+ * Gets an array of the available metastores (as MetastoreInfo objects). The caller must be
+ * an admin to retrieve this info. There is no guarantee of a specific ordering of the elements in
* the array.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -75,15 +75,15 @@ public interface MetastoresService {
/**
* Updates information for a specific metastore. The caller must be a metastore admin. If the
- * __owner__ field is set to the empty string (**""**), the ownership is updated to the System
- * User.
+ * owner field is set to the empty string (""), the ownership is updated to the
+ * System User.
*/
MetastoreInfo update(UpdateMetastore updateMetastore);
/**
- * Updates a metastore assignment. This operation can be used to update __metastore_id__ or
- * __default_catalog_name__ for a specified Workspace, if the Workspace is already assigned a
- * metastore. The caller must be an account admin to update __metastore_id__; otherwise, the
+ * Updates a metastore assignment. This operation can be used to update metastore_id or
+ * default_catalog_name for a specified Workspace, if the Workspace is already assigned a
+ * metastore. The caller must be an account admin to update metastore_id; otherwise, the
* caller can be a Workspace admin.
*/
void updateAssignment(UpdateMetastoreAssignment updateMetastoreAssignment);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionInfo.java
index dd2cc00b9..f1017aac3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionInfo.java
@@ -47,7 +47,7 @@ public class ModelVersionInfo {
private DependencyList modelVersionDependencies;
/**
- * MLflow run ID used when creating the model version, if ``source`` was generated by an
+ * MLflow run ID used when creating the model version, if {@code source} was generated by an
* experiment run stored in an MLflow tracking server
*/
@JsonProperty("run_id")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsAPI.java
index f59ca853e..b59a62fc1 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsAPI.java
@@ -13,7 +13,8 @@
* Databricks workspaces.
*
* This API reference documents the REST endpoints for managing model versions in Unity Catalog.
- * For more details, see the [registered models API docs](/api/workspace/registeredmodels).
+ * For more details, see the registered models API
+ * docs.
*/
@Generated
public class ModelVersionsAPI {
@@ -40,8 +41,8 @@ public void delete(String fullName, long version) {
* version will also be deleted.
*
* The caller must be a metastore admin or an owner of the parent registered model. For the
- * latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * latter case, the caller must also be the owner or have the USE_CATALOG privilege on the
+ * parent catalog and the USE_SCHEMA privilege on the parent schema.
*/
public void delete(DeleteModelVersionRequest request) {
impl.delete(request);
@@ -54,10 +55,10 @@ public ModelVersionInfo get(String fullName, long version) {
/**
* Get a model version.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the parent registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the parent registered model. For the latter case, the caller must also be the owner or have
+ * the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on
+ * the parent schema.
*/
public ModelVersionInfo get(GetModelVersionRequest request) {
return impl.get(request);
@@ -70,10 +71,10 @@ public ModelVersionInfo getByAlias(String fullName, String alias) {
/**
* Get a model version by alias.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the registered model. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
public ModelVersionInfo getByAlias(GetByAliasRequest request) {
return impl.getByAlias(request);
@@ -89,10 +90,10 @@ public Iterable The returned models are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the model versions. A regular user needs to be the
- * owner or have the **EXECUTE** privilege on the parent registered model to recieve the model
+ * owner or have the EXECUTE privilege on the parent registered model to recieve the model
* versions in the response. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*
* There is no guarantee of a specific ordering of the elements in the response. The elements
* in the response will not contain any aliases or tags.
@@ -119,8 +120,8 @@ public Iterable The caller must be a metastore admin or an owner of the parent registered model. For the
- * latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * latter case, the caller must also be the owner or have the USE_CATALOG privilege on the
+ * parent catalog and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the comment of the model version can be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsService.java
index 0fc7c97d5..2f54d9c19 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelVersionsService.java
@@ -9,7 +9,8 @@
* Databricks workspaces.
*
* This API reference documents the REST endpoints for managing model versions in Unity Catalog.
- * For more details, see the [registered models API docs](/api/workspace/registeredmodels).
+ * For more details, see the registered models API
+ * docs.
*
* This is the high-level interface, that contains generated methods.
*
@@ -22,28 +23,28 @@ public interface ModelVersionsService {
* version will also be deleted.
*
* The caller must be a metastore admin or an owner of the parent registered model. For the
- * latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * latter case, the caller must also be the owner or have the USE_CATALOG privilege on the
+ * parent catalog and the USE_SCHEMA privilege on the parent schema.
*/
void delete(DeleteModelVersionRequest deleteModelVersionRequest);
/**
* Get a model version.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the parent registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the parent registered model. For the latter case, the caller must also be the owner or have
+ * the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on
+ * the parent schema.
*/
ModelVersionInfo get(GetModelVersionRequest getModelVersionRequest);
/**
* Get a model version by alias.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the registered model. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
ModelVersionInfo getByAlias(GetByAliasRequest getByAliasRequest);
@@ -53,10 +54,10 @@ public interface ModelVersionsService {
*
* The returned models are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the model versions. A regular user needs to be the
- * owner or have the **EXECUTE** privilege on the parent registered model to recieve the model
+ * owner or have the EXECUTE privilege on the parent registered model to recieve the model
* versions in the response. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*
* There is no guarantee of a specific ordering of the elements in the response. The elements
* in the response will not contain any aliases or tags.
@@ -71,8 +72,8 @@ public interface ModelVersionsService {
* Updates the specified model version.
*
* The caller must be a metastore admin or an owner of the parent registered model. For the
- * latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * latter case, the caller must also be the owner or have the USE_CATALOG privilege on the
+ * parent catalog and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the comment of the model version can be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorCronSchedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorCronSchedule.java
index 44023d6ad..fae658da1 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorCronSchedule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorCronSchedule.java
@@ -14,15 +14,13 @@ public class MonitorCronSchedule {
private MonitorCronSchedulePauseStatus pauseStatus;
/**
- * The expression that determines when to run the monitor. See [examples].
- *
- * [examples]:
- * https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
+ * The expression that determines when to run the monitor. See examples.
*/
@JsonProperty("quartz_cron_expression")
private String quartzCronExpression;
- /** The timezone id (e.g., ``PST``) in which to evaluate the quartz expression. */
+ /** The timezone id (e.g., {@code PST}) in which to evaluate the quartz expression. */
@JsonProperty("timezone_id")
private String timezoneId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorInfo.java
index d906f7dc4..d67315cfc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorInfo.java
@@ -20,8 +20,8 @@ public class MonitorInfo {
/**
* [Create:OPT Update:OPT] Baseline table name. Baseline data is used to compute drift from the
- * data in the monitored `table_name`. The baseline table and the monitored table shall have the
- * same schema.
+ * data in the monitored {@code table_name}. The baseline table and the monitored table shall have
+ * the same schema.
*/
@JsonProperty("baseline_table_name")
private String baselineTableName;
@@ -42,8 +42,8 @@ public class MonitorInfo {
private MonitorDataClassificationConfig dataClassificationConfig;
/**
- * [Create:ERR Update:IGN] Table that stores drift metrics data. Format:
- * `catalog.schema.table_name`.
+ * [Create:ERR Update:IGN] Table that stores drift metrics data. Format: {@code
+ * catalog.schema.table_name}.
*/
@JsonProperty("drift_metrics_table_name")
private String driftMetricsTableName;
@@ -76,8 +76,8 @@ public class MonitorInfo {
private String outputSchemaName;
/**
- * [Create:ERR Update:IGN] Table that stores profile metrics data. Format:
- * `catalog.schema.table_name`.
+ * [Create:ERR Update:IGN] Table that stores profile metrics data. Format: {@code
+ * catalog.schema.table_name}.
*/
@JsonProperty("profile_metrics_table_name")
private String profileMetricsTableName;
@@ -89,10 +89,10 @@ public class MonitorInfo {
/**
* [Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis.
* The data is grouped by each expression independently, resulting in a separate slice for each
- * predicate and its complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will
- * generate the following slices: two slices for `col_2 > 10` (True and False), and one slice per
- * unique value in `col1`. For high-cardinality columns, only the top 100 unique values by
- * frequency will generate slices.
+ * predicate and its complements. For example {@code slicing_exprs=[“col_1”, “col_2 > 10”]} will
+ * generate the following slices: two slices for {@code col_2 > 10} (True and False), and one
+ * slice per unique value in {@code col1}. For high-cardinality columns, only the top 100 unique
+ * values by frequency will generate slices.
*/
@JsonProperty("slicing_exprs")
private Collection [create metric definition]:
- * https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition
+ * Jinja template for a SQL expression that specifies how to compute the metric. See create
+ * metric definition.
*/
@JsonProperty("definition")
private String definition;
/**
- * A list of column names in the input table the metric should be computed for. Can use
- * ``":table"`` to indicate that the metric needs information from multiple columns.
+ * A list of column names in the input table the metric should be computed for. Can use {@code
+ * ":table"} to indicate that the metric needs information from multiple columns.
*/
@JsonProperty("input_columns")
private Collection This is the high-level interface, that contains generated methods.
*
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/PolicyInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/PolicyInfo.java
index d24d09501..a780916ee 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/PolicyInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/PolicyInfo.java
@@ -11,9 +11,9 @@
@Generated
public class PolicyInfo {
/**
- * Options for column mask policies. Valid only if `policy_type` is `POLICY_TYPE_COLUMN_MASK`.
- * Required on create and optional on update. When specified on update, the new options will
- * replace the existing options as a whole.
+ * Options for column mask policies. Valid only if {@code policy_type} is {@code
+ * POLICY_TYPE_COLUMN_MASK}. Required on create and optional on update. When specified on update,
+ * the new options will replace the existing options as a whole.
*/
@JsonProperty("column_mask")
private ColumnMaskOptions columnMask;
@@ -35,8 +35,8 @@ public class PolicyInfo {
private Collection The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on
- * the table's parent schema, and have **SELECT** access on the table 2. have **USE_CATALOG** on
- * the table's parent catalog, be an owner of the table's parent schema, and have **SELECT**
- * access on the table. 3. have the following permissions: - **USE_CATALOG** on the table's parent
- * catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Workspace assets, such as the dashboard, will be created in the workspace where this call
* was made.
@@ -66,10 +76,20 @@ public DeleteMonitorResponse delete(String tableName) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Deletes a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*
@@ -88,10 +108,20 @@ public MonitorInfo get(String tableName) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema. 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * The returned information includes configuration values, as well as information on assets
* created by the monitor. Some information (e.g., dashboard) may be filtered out if the caller is
@@ -109,10 +139,20 @@ public MonitorRefreshInfo getRefresh(String tableName, long refreshId) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets info
* about a specific monitor refresh using the given refresh ID.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -128,10 +168,20 @@ public MonitorRefreshListResponse listRefreshes(String tableName) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets an
* array containing the history of the most recent refreshes (up to 25) for this table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -143,10 +193,20 @@ public MonitorRefreshListResponse listRefreshes(ListRefreshesRequest request) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Regenerates
* the monitoring dashboard for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table
+ * The caller must either:
+ *
+ * The call must be made from the workspace where the monitor was created. The dashboard will
* be regenerated in the assets directory that was specified when the monitor was created.
@@ -160,10 +220,20 @@ public RegenerateDashboardResponse regenerateDashboard(RegenerateDashboardReques
* metric refresh on the monitor for the specified table. The refresh will execute in the
* background.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -175,10 +245,20 @@ public MonitorRefreshInfo runRefresh(RunRefreshRequest request) {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Updates a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created, and
* the caller must be the original creator of the monitor.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/QualityMonitorsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/QualityMonitorsService.java
index a98c3fc58..1f0b18b00 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/QualityMonitorsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/QualityMonitorsService.java
@@ -11,8 +11,8 @@
* generates metrics tables and a dashboard that you can use to monitor table health and set alerts.
* Most write operations require the user to be the owner of the table (or its parent schema or
* parent catalog). Viewing the dashboard, computed metrics, or monitor configuration only requires
- * the user to have **SELECT** privileges on the table (along with **USE_SCHEMA** and
- * **USE_CATALOG**).
+ * the user to have SELECT privileges on the table (along with USE_SCHEMA and
+ * USE_CATALOG).
*
* This is the high-level interface, that contains generated methods.
*
@@ -30,11 +30,21 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Creates a
* new monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on
- * the table's parent schema, and have **SELECT** access on the table 2. have **USE_CATALOG** on
- * the table's parent catalog, be an owner of the table's parent schema, and have **SELECT**
- * access on the table. 3. have the following permissions: - **USE_CATALOG** on the table's parent
- * catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Workspace assets, such as the dashboard, will be created in the workspace where this call
* was made.
@@ -45,10 +55,20 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Deletes a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*
@@ -61,10 +81,20 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema. 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * The returned information includes configuration values, as well as information on assets
* created by the monitor. Some information (e.g., dashboard) may be filtered out if the caller is
@@ -76,10 +106,20 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets info
* about a specific monitor refresh using the given refresh ID.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -89,10 +129,20 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Gets an
* array containing the history of the most recent refreshes (up to 25) for this table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - **SELECT** privilege on the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -102,10 +152,20 @@ public interface QualityMonitorsService {
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Regenerates
* the monitoring dashboard for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table
+ * The caller must either:
+ *
+ * The call must be made from the workspace where the monitor was created. The dashboard will
* be regenerated in the assets directory that was specified when the monitor was created.
@@ -118,10 +178,20 @@ RegenerateDashboardResponse regenerateDashboard(
* metric refresh on the monitor for the specified table. The refresh will execute in the
* background.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created.
*/
@@ -131,10 +201,20 @@ RegenerateDashboardResponse regenerateDashboard(
* Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors). Updates a
* monitor for the specified table.
*
- * The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG**
- * on the table's parent catalog and be an owner of the table's parent schema 3. have the
- * following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the
- * table's parent schema - be an owner of the table.
+ * The caller must either:
+ *
+ * Additionally, the call must be made from the workspace where the monitor was created, and
* the caller must be the original creator of the monitor.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegenerateDashboardRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegenerateDashboardRequest.java
index 954b77c15..1e5817e2a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegenerateDashboardRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegenerateDashboardRequest.java
@@ -11,7 +11,7 @@
@Generated
public class RegenerateDashboardRequest {
/**
- * UC table name in format `catalog.schema.table_name`. This field corresponds to the
+ * UC table name in format {@code catalog.schema.table_name}. This field corresponds to the
* {full_table_name_arg} arg in the endpoint path.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsAPI.java
index c7737bf48..f103477a3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsAPI.java
@@ -22,13 +22,17 @@
* enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the following
* additional privileges are required for various operations:
*
- * * To create a registered model, users must additionally have the CREATE_MODEL permission on
- * the target schema. * To view registered model or model version metadata, model version data
- * files, or invoke a model version, users must additionally have the EXECUTE permission on the
- * registered model * To update registered model or model version tags, users must additionally have
- * APPLY TAG permissions on the registered model * To update other registered model or model version
- * metadata (comments, aliases) create a new model version, or update permissions on the registered
- * model, users must be owners of the registered model.
+ * Note: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants)
* that specify a securable type, use FUNCTION as the securable type.
@@ -55,11 +59,15 @@ public RegisteredModelsAPI(RegisteredModelsService mock) {
* File storage for model versions in the registered model will be located in the default
* location which is specified by the parent schema, or the parent catalog, or the Metastore.
*
- * For registered model creation to succeed, the user must satisfy the following conditions: -
- * The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have
- * the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the
- * parent schema. - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on
- * the parent schema.
+ * For registered model creation to succeed, the user must satisfy the following conditions:
+ *
+ * The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
public void delete(DeleteRegisteredModelRequest request) {
impl.delete(request);
@@ -89,8 +97,8 @@ public void deleteAlias(String fullName, String alias) {
* Deletes a registered model alias.
*
* The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
public void deleteAlias(DeleteAliasRequest request) {
impl.deleteAlias(request);
@@ -103,10 +111,10 @@ public RegisteredModelInfo get(String fullName) {
/**
* Get a registered model.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the registered model. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
public RegisteredModelInfo get(GetRegisteredModelRequest request) {
return impl.get(request);
@@ -118,10 +126,10 @@ public RegisteredModelInfo get(GetRegisteredModelRequest request) {
*
* The returned models are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the registered models. A regular user needs to be the
- * owner or have the **EXECUTE** privilege on the registered model to recieve the registered
+ * owner or have the EXECUTE privilege on the registered model to recieve the registered
* models in the response. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*
* There is no guarantee of a specific ordering of the elements in the response.
*
@@ -147,8 +155,8 @@ public Iterable The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
public RegisteredModelAlias setAlias(SetRegisteredModelAliasRequest request) {
return impl.setAlias(request);
@@ -158,8 +166,8 @@ public RegisteredModelAlias setAlias(SetRegisteredModelAliasRequest request) {
* Updates the specified registered model.
*
* The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the name, the owner or the comment of the registered model can be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsService.java
index 2573bae72..062b584d6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RegisteredModelsService.java
@@ -18,13 +18,17 @@
* enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the following
* additional privileges are required for various operations:
*
- * * To create a registered model, users must additionally have the CREATE_MODEL permission on
- * the target schema. * To view registered model or model version metadata, model version data
- * files, or invoke a model version, users must additionally have the EXECUTE permission on the
- * registered model * To update registered model or model version tags, users must additionally have
- * APPLY TAG permissions on the registered model * To update other registered model or model version
- * metadata (comments, aliases) create a new model version, or update permissions on the registered
- * model, users must be owners of the registered model.
+ * Note: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants)
* that specify a securable type, use FUNCTION as the securable type.
@@ -41,11 +45,15 @@ public interface RegisteredModelsService {
* File storage for model versions in the registered model will be located in the default
* location which is specified by the parent schema, or the parent catalog, or the Metastore.
*
- * For registered model creation to succeed, the user must satisfy the following conditions: -
- * The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have
- * the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the
- * parent schema. - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on
- * the parent schema.
+ * For registered model creation to succeed, the user must satisfy the following conditions:
+ *
+ * The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
void delete(DeleteRegisteredModelRequest deleteRegisteredModelRequest);
@@ -63,18 +71,18 @@ public interface RegisteredModelsService {
* Deletes a registered model alias.
*
* The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
void deleteAlias(DeleteAliasRequest deleteAliasRequest);
/**
* Get a registered model.
*
- * The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on)
- * the registered model. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the EXECUTE privilege
+ * on) the registered model. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
RegisteredModelInfo get(GetRegisteredModelRequest getRegisteredModelRequest);
@@ -84,10 +92,10 @@ public interface RegisteredModelsService {
*
* The returned models are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the registered models. A regular user needs to be the
- * owner or have the **EXECUTE** privilege on the registered model to recieve the registered
+ * owner or have the EXECUTE privilege on the registered model to recieve the registered
* models in the response. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*
* There is no guarantee of a specific ordering of the elements in the response.
*
@@ -101,8 +109,8 @@ public interface RegisteredModelsService {
* Set an alias on the specified registered model.
*
* The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*/
RegisteredModelAlias setAlias(SetRegisteredModelAliasRequest setRegisteredModelAliasRequest);
@@ -110,8 +118,8 @@ public interface RegisteredModelsService {
* Updates the specified registered model.
*
* The caller must be a metastore admin or an owner of the registered model. For the latter
- * case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
- * catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * case, the caller must also be the owner or have the USE_CATALOG privilege on the parent
+ * catalog and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the name, the owner or the comment of the registered model can be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasAPI.java
index f392e0cd8..e31422d90 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasAPI.java
@@ -11,11 +11,9 @@
* Unity Catalog enforces resource quotas on all securable objects, which limits the number of
* resources that can be created. Quotas are expressed in terms of a resource type and a parent (for
* example, tables per metastore or schemas per catalog). The resource quota APIs enable you to
- * monitor your current usage and limits. For more information on resource quotas see the [Unity
- * Catalog documentation].
- *
- * [Unity Catalog documentation]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#resource-quotas
+ * monitor your current usage and limits. For more information on resource quotas see the Unity
+ * Catalog documentation.
*/
@Generated
public class ResourceQuotasAPI {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasService.java
index f14ad81c1..d801a2553 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ResourceQuotasService.java
@@ -7,11 +7,9 @@
* Unity Catalog enforces resource quotas on all securable objects, which limits the number of
* resources that can be created. Quotas are expressed in terms of a resource type and a parent (for
* example, tables per metastore or schemas per catalog). The resource quota APIs enable you to
- * monitor your current usage and limits. For more information on resource quotas see the [Unity
- * Catalog documentation].
- *
- * [Unity Catalog documentation]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#resource-quotas
+ * monitor your current usage and limits. For more information on resource quotas see the Unity
+ * Catalog documentation.
*
* This is the high-level interface, that contains generated methods.
*
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java
index 7773bb76b..9293ccf8f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java
@@ -52,7 +52,7 @@ public AccessRequestDestinations getAccessRequestDestinations(
/**
* Gets an array of access request destinations for the specified securable. Any caller can see
- * URL destinations or the destinations on the metastore. Otherwise, only those with **BROWSE**
+ * URL destinations or the destinations on the metastore. Otherwise, only those with BROWSE
* permissions on the securable can see destinations.
*
* The supported securable types are: "metastore", "catalog", "schema", "table",
@@ -65,12 +65,12 @@ public AccessRequestDestinations getAccessRequestDestinations(
/**
* Updates the access request destinations for the given securable. The caller must be a metastore
- * admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable
- * in order to assign destinations. Destinations cannot be updated for securables underneath
- * schemas (tables, volumes, functions, and models). For these securable types, destinations are
- * inherited from the parent securable. A maximum of 5 emails and 5 external notification
- * destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be assigned to a
- * securable. If a URL destination is assigned, no other destinations can be set.
+ * admin, the owner of the securable, or a user that has the MANAGE privilege on the
+ * securable in order to assign destinations. Destinations cannot be updated for securables
+ * underneath schemas (tables, volumes, functions, and models). For these securable types,
+ * destinations are inherited from the parent securable. A maximum of 5 emails and 5 external
+ * notification destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be
+ * assigned to a securable. If a URL destination is assigned, no other destinations can be set.
*
* The supported securable types are: "metastore", "catalog", "schema", "table",
* "external_location", "connection", "credential", "function", "registered_model", and "volume".
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java
index cdd8ef843..2b6004ac3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java
@@ -29,7 +29,7 @@ BatchCreateAccessRequestsResponse batchCreateAccessRequests(
/**
* Gets an array of access request destinations for the specified securable. Any caller can see
- * URL destinations or the destinations on the metastore. Otherwise, only those with **BROWSE**
+ * URL destinations or the destinations on the metastore. Otherwise, only those with BROWSE
* permissions on the securable can see destinations.
*
* The supported securable types are: "metastore", "catalog", "schema", "table",
@@ -40,12 +40,12 @@ AccessRequestDestinations getAccessRequestDestinations(
/**
* Updates the access request destinations for the given securable. The caller must be a metastore
- * admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable
- * in order to assign destinations. Destinations cannot be updated for securables underneath
- * schemas (tables, volumes, functions, and models). For these securable types, destinations are
- * inherited from the parent securable. A maximum of 5 emails and 5 external notification
- * destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be assigned to a
- * securable. If a URL destination is assigned, no other destinations can be set.
+ * admin, the owner of the securable, or a user that has the MANAGE privilege on the
+ * securable in order to assign destinations. Destinations cannot be updated for securables
+ * underneath schemas (tables, volumes, functions, and models). For these securable types,
+ * destinations are inherited from the parent securable. A maximum of 5 emails and 5 external
+ * notification destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be
+ * assigned to a securable. If a URL destination is assigned, no other destinations can be set.
*
* The supported securable types are: "metastore", "catalog", "schema", "table",
* "external_location", "connection", "credential", "function", "registered_model", and "volume".
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RunRefreshRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RunRefreshRequest.java
index 183580b35..a1a0172aa 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RunRefreshRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RunRefreshRequest.java
@@ -10,8 +10,8 @@
@Generated
public class RunRefreshRequest {
/**
- * UC table name in format `catalog.schema.table_name`. table_name is case insensitive and spaces
- * are disallowed.
+ * UC table name in format {@code catalog.schema.table_name}. table_name is case insensitive and
+ * spaces are disallowed.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
index 8c226865e..0a063f85d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
@@ -50,7 +50,7 @@ public class SchemaInfo {
@JsonProperty("enable_predictive_optimization")
private EnablePredictiveOptimization enablePredictiveOptimization;
- /** Full name of schema, in form of __catalog_name__.__schema_name__. */
+ /** Full name of schema, in form of catalog_name.schema_name. */
@JsonProperty("full_name")
private String fullName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemasAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemasAPI.java
index 28bf44a5c..86e2fa397 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemasAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemasAPI.java
@@ -31,7 +31,7 @@ public SchemasAPI(SchemasService mock) {
/**
* Creates a new schema for catalog in the Metastore. The caller must be a metastore admin, or
- * have the **CREATE_SCHEMA** privilege in the parent catalog.
+ * have the CREATE_SCHEMA privilege in the parent catalog.
*/
public SchemaInfo create(CreateSchema request) {
return impl.create(request);
@@ -55,7 +55,7 @@ public SchemaInfo get(String fullName) {
/**
* Gets the specified schema within the metastore. The caller must be a metastore admin, the owner
- * of the schema, or a user that has the **USE_SCHEMA** privilege on the schema.
+ * of the schema, or a user that has the USE_SCHEMA privilege on the schema.
*/
public SchemaInfo get(GetSchemaRequest request) {
return impl.get(request);
@@ -68,13 +68,13 @@ public Iterable NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -99,9 +99,9 @@ public Iterable NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -51,9 +51,9 @@ public interface SchemasService {
/**
* Updates a schema for a catalog. The caller must be the owner of the schema or a metastore
- * admin. If the caller is a metastore admin, only the __owner__ field can be changed in the
- * update. If the __name__ field must be updated, the caller must be a metastore admin or have the
- * **CREATE_SCHEMA** privilege on the parent catalog.
+ * admin. If the caller is a metastore admin, only the owner field can be changed in the
+ * update. If the name field must be updated, the caller must be a metastore admin or have
+ * the CREATE_SCHEMA privilege on the parent catalog.
*/
SchemaInfo update(UpdateSchema updateSchema);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Secret.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Secret.java
index a20759b2c..0fee3759a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Secret.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Secret.java
@@ -17,7 +17,7 @@
public class Secret {
/**
* Indicates whether the principal is limited to retrieving metadata for the associated object
- * through the **BROWSE** privilege when **include_browse** is enabled in the request.
+ * through the BROWSE privilege when include_browse is enabled in the request.
*/
@JsonProperty("browse_only")
private Boolean browseOnly;
@@ -39,15 +39,15 @@ public class Secret {
private String createdBy;
/**
- * The effective owner of the secret, which may differ from the directly-set **owner** due to
+ * The effective owner of the secret, which may differ from the directly-set owner due to
* inheritance.
*/
@JsonProperty("effective_owner")
private String effectiveOwner;
/**
- * The secret value. Only populated in responses when you have the **READ_SECRET** privilege and
- * **include_value** is set to true in the request. The maximum size is 60 KiB.
+ * The secret value. Only populated in responses when you have the READ_SECRET privilege
+ * and include_value is set to true in the request. The maximum size is 60 KiB.
*/
@JsonProperty("effective_value")
private String effectiveValue;
@@ -66,7 +66,7 @@ public class Secret {
/**
* The three-level (fully qualified) name of the secret, in the form of
- * **catalog_name.schema_name.secret_name**.
+ * catalog_name.schema_name.secret_name.
*/
@JsonProperty("full_name")
private String fullName;
@@ -100,8 +100,8 @@ public class Secret {
/**
* The secret value to store. This field is input-only and is not returned in responses — use the
- * **effective_value** field (via GetSecret with **include_value** set to true) to read the secret
- * value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords,
+ * effective_value field (via GetSecret with include_value set to true) to read the
+ * secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords,
* tokens, keys, and other sensitive credential data.
*/
@JsonProperty("value")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcAPI.java
index b9569f509..84e140da0 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcAPI.java
@@ -10,7 +10,7 @@
/**
* A secret is a Unity Catalog securable object that stores sensitive credential data (such as
* passwords, tokens, and keys) within a three-level namespace
- * (**catalog_name.schema_name.secret_name**).
+ * (catalog_name.schema_name.secret_name).
*
* Secrets can be managed using standard Unity Catalog permissions and are scoped to a schema
* within a catalog.
@@ -34,11 +34,11 @@ public SecretsUcAPI(SecretsUcService mock) {
/**
* Creates a new secret in Unity Catalog.
*
- * You must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA**
- * privileges on the parent schema and **USE CATALOG** on the parent catalog.
+ * You must be the owner of the parent schema or have the CREATE_SECRET and USE
+ * SCHEMA privileges on the parent schema and USE CATALOG on the parent catalog.
*
- * The secret is stored in the specified catalog and schema, and the **value** field contains
- * the sensitive data to be securely stored.
+ * The secret is stored in the specified catalog and schema, and the value field
+ * contains the sensitive data to be securely stored.
*/
public Secret createSecret(CreateSecretRequest request) {
return impl.createSecret(request);
@@ -64,11 +64,11 @@ public Secret getSecret(String fullName) {
/**
* Gets a secret by its three-level (fully qualified) name.
*
- * You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on
- * the secret.
+ * You must be a metastore admin, the owner of the secret, or have the MANAGE privilege
+ * on the secret.
*
* The secret value isn't returned by default. To retrieve it, you must also have the
- * **READ_SECRET** privilege and set **include_value** to true in the request.
+ * READ_SECRET privilege and set include_value to true in the request.
*/
public Secret getSecret(GetSecretRequest request) {
return impl.getSecret(request);
@@ -77,12 +77,12 @@ public Secret getSecret(GetSecretRequest request) {
/**
* Lists secrets in Unity Catalog.
*
- * You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on
- * the secret.
+ * You must be a metastore admin, the owner of the secret, or have the MANAGE privilege
+ * on the secret.
*
- * Both **catalog_name** and **schema_name** must be specified together to filter secrets
- * within a specific schema. Results are paginated; use the **page_token** field from the response
- * to retrieve subsequent pages.
+ * Both catalog_name and schema_name must be specified together to filter secrets
+ * within a specific schema. Results are paginated; use the page_token field from the
+ * response to retrieve subsequent pages.
*/
public Iterable You must be the owner of the secret or a metastore admin. If you are a metastore admin, only
- * the **owner** field can be changed.
+ * the owner field can be changed.
*
- * Use the **update_mask** field to specify which fields to update. Supported updatable fields
- * include **value**, **comment**, **owner**, and **expire_time**.
+ * Use the update_mask field to specify which fields to update. Supported updatable
+ * fields include value, comment, owner, and expire_time.
*/
public Secret updateSecret(UpdateSecretRequest request) {
return impl.updateSecret(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcService.java
index 8e753c35b..3e840e57d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecretsUcService.java
@@ -6,7 +6,7 @@
/**
* A secret is a Unity Catalog securable object that stores sensitive credential data (such as
* passwords, tokens, and keys) within a three-level namespace
- * (**catalog_name.schema_name.secret_name**).
+ * (catalog_name.schema_name.secret_name).
*
* Secrets can be managed using standard Unity Catalog permissions and are scoped to a schema
* within a catalog.
@@ -20,11 +20,11 @@ public interface SecretsUcService {
/**
* Creates a new secret in Unity Catalog.
*
- * You must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA**
- * privileges on the parent schema and **USE CATALOG** on the parent catalog.
+ * You must be the owner of the parent schema or have the CREATE_SECRET and USE
+ * SCHEMA privileges on the parent schema and USE CATALOG on the parent catalog.
*
- * The secret is stored in the specified catalog and schema, and the **value** field contains
- * the sensitive data to be securely stored.
+ * The secret is stored in the specified catalog and schema, and the value field
+ * contains the sensitive data to be securely stored.
*/
Secret createSecret(CreateSecretRequest createSecretRequest);
@@ -38,23 +38,23 @@ public interface SecretsUcService {
/**
* Gets a secret by its three-level (fully qualified) name.
*
- * You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on
- * the secret.
+ * You must be a metastore admin, the owner of the secret, or have the MANAGE privilege
+ * on the secret.
*
* The secret value isn't returned by default. To retrieve it, you must also have the
- * **READ_SECRET** privilege and set **include_value** to true in the request.
+ * READ_SECRET privilege and set include_value to true in the request.
*/
Secret getSecret(GetSecretRequest getSecretRequest);
/**
* Lists secrets in Unity Catalog.
*
- * You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on
- * the secret.
+ * You must be a metastore admin, the owner of the secret, or have the MANAGE privilege
+ * on the secret.
*
- * Both **catalog_name** and **schema_name** must be specified together to filter secrets
- * within a specific schema. Results are paginated; use the **page_token** field from the response
- * to retrieve subsequent pages.
+ * Both catalog_name and schema_name must be specified together to filter secrets
+ * within a specific schema. Results are paginated; use the page_token field from the
+ * response to retrieve subsequent pages.
*/
ListSecretsResponse listSecrets(ListSecretsRequest listSecretsRequest);
@@ -62,10 +62,10 @@ public interface SecretsUcService {
* Updates an existing secret in Unity Catalog.
*
* You must be the owner of the secret or a metastore admin. If you are a metastore admin, only
- * the **owner** field can be changed.
+ * the owner field can be changed.
*
- * Use the **update_mask** field to specify which fields to update. Supported updatable fields
- * include **value**, **comment**, **owner**, and **expire_time**.
+ * Use the update_mask field to specify which fields to update. Supported updatable
+ * fields include value, comment, owner, and expire_time.
*/
Secret updateSecret(UpdateSecretRequest updateSecretRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java
index 4ea241418..5dd07eb34 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java
@@ -73,7 +73,7 @@ public class StorageCredentialInfo {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
@@ -88,7 +88,7 @@ public class StorageCredentialInfo {
/**
* Whether this credential is the current metastore's root storage credential. Only applicable
- * when purpose is **STORAGE**.
+ * when purpose is STORAGE.
*/
@JsonProperty("used_for_managed_storage")
private Boolean usedForManagedStorage;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsAPI.java
index ff05dc3ec..04a0fabf6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsAPI.java
@@ -39,8 +39,8 @@ public StorageCredentialsAPI(StorageCredentialsService mock) {
/**
* Creates a new storage credential.
*
- * The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on
- * the metastore.
+ * The caller must be a metastore admin or have the CREATE_STORAGE_CREDENTIAL privilege
+ * on the metastore.
*/
public StorageCredentialInfo create(CreateStorageCredential request) {
return impl.create(request);
@@ -71,7 +71,7 @@ public StorageCredentialInfo get(GetStorageCredentialRequest request) {
}
/**
- * Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is
+ * Gets an array of storage credentials (as StorageCredentialInfo objects). The array is
* limited to only those storage credentials the caller has permission to access. If the caller is
* a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a
* specific ordering of the elements in the array.
@@ -79,7 +79,7 @@ public StorageCredentialInfo get(GetStorageCredentialRequest request) {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -106,22 +106,22 @@ public Iterable The caller must be the owner of the storage credential or a metastore admin. If the caller
- * is a metastore admin, only the **owner** field can be changed.
+ * is a metastore admin, only the owner field can be changed.
*/
public StorageCredentialInfo update(UpdateStorageCredential request) {
return impl.update(request);
}
/**
- * Validates a storage credential. At least one of __external_location_name__ and __url__ need to
- * be provided. If only one of them is provided, it will be used for validation. And if both are
- * provided, the __url__ will be used for validation, and __external_location_name__ will be
- * ignored when checking overlapping urls.
+ * Validates a storage credential. At least one of external_location_name and url
+ * need to be provided. If only one of them is provided, it will be used for validation. And if
+ * both are provided, the url will be used for validation, and
+ * external_location_name will be ignored when checking overlapping urls.
*
- * Either the __storage_credential_name__ or the cloud-specific credential must be provided.
+ * Either the storage_credential_name or the cloud-specific credential must be provided.
*
* The caller must be a metastore admin or the storage credential owner or have the
- * **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.
+ * CREATE_EXTERNAL_LOCATION privilege on the metastore and the storage credential.
*/
public ValidateStorageCredentialResponse validate(ValidateStorageCredential request) {
return impl.validate(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsService.java
index cc774418a..c2b5e0692 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialsService.java
@@ -25,8 +25,8 @@ public interface StorageCredentialsService {
/**
* Creates a new storage credential.
*
- * The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on
- * the metastore.
+ * The caller must be a metastore admin or have the CREATE_STORAGE_CREDENTIAL privilege
+ * on the metastore.
*/
StorageCredentialInfo create(CreateStorageCredential createStorageCredential);
@@ -43,7 +43,7 @@ public interface StorageCredentialsService {
StorageCredentialInfo get(GetStorageCredentialRequest getStorageCredentialRequest);
/**
- * Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is
+ * Gets an array of storage credentials (as StorageCredentialInfo objects). The array is
* limited to only those storage credentials the caller has permission to access. If the caller is
* a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a
* specific ordering of the elements in the array.
@@ -51,7 +51,7 @@ public interface StorageCredentialsService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -62,20 +62,20 @@ public interface StorageCredentialsService {
* Updates a storage credential on the metastore.
*
* The caller must be the owner of the storage credential or a metastore admin. If the caller
- * is a metastore admin, only the **owner** field can be changed.
+ * is a metastore admin, only the owner field can be changed.
*/
StorageCredentialInfo update(UpdateStorageCredential updateStorageCredential);
/**
- * Validates a storage credential. At least one of __external_location_name__ and __url__ need to
- * be provided. If only one of them is provided, it will be used for validation. And if both are
- * provided, the __url__ will be used for validation, and __external_location_name__ will be
- * ignored when checking overlapping urls.
+ * Validates a storage credential. At least one of external_location_name and url
+ * need to be provided. If only one of them is provided, it will be used for validation. And if
+ * both are provided, the url will be used for validation, and
+ * external_location_name will be ignored when checking overlapping urls.
*
- * Either the __storage_credential_name__ or the cloud-specific credential must be provided.
+ * Either the storage_credential_name or the cloud-specific credential must be provided.
*
* The caller must be a metastore admin or the storage credential owner or have the
- * **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.
+ * CREATE_EXTERNAL_LOCATION privilege on the metastore and the storage credential.
*/
ValidateStorageCredentialResponse validate(ValidateStorageCredential validateStorageCredential);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasAPI.java
index 03c34a27e..50c5226f2 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasAPI.java
@@ -59,7 +59,7 @@ public Iterable NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasService.java
index 71b277295..07968b504 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemasService.java
@@ -33,7 +33,7 @@ public interface SystemSchemasService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraint.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraint.java
index 43699a737..515aece57 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraint.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraint.java
@@ -8,8 +8,8 @@
import java.util.Objects;
/**
- * A table constraint, as defined by *one* of the following fields being set:
- * __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
+ * A table constraint, as defined by one of the following fields being set:
+ * primary_key_constraint, foreign_key_constraint, named_table_constraint.
*/
@Generated
public class TableConstraint {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsAPI.java
index 4a8a02a5f..524f66761 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsAPI.java
@@ -38,11 +38,16 @@ public TableConstraintsAPI(TableConstraintsService mock) {
* Creates a new table constraint.
*
* For the table constraint creation to succeed, the user must satisfy both of these
- * conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
- * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if
- * the new constraint is a __ForeignKeyConstraint__, the user must have the **USE_CATALOG**
- * privilege on the referenced parent table's catalog, the **USE_SCHEMA** privilege on the
- * referenced parent table's schema, and be the owner of the referenced parent table.
+ * conditions:
+ *
+ * For the table constraint deletion to succeed, the user must satisfy both of these
- * conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
- * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if
- * __cascade__ argument is **true**, the user must have the following permissions on all of the
- * child tables: the **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA**
- * privilege on the table's schema, and be the owner of the table.
+ * conditions:
+ *
+ * For the table constraint creation to succeed, the user must satisfy both of these
- * conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
- * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if
- * the new constraint is a __ForeignKeyConstraint__, the user must have the **USE_CATALOG**
- * privilege on the referenced parent table's catalog, the **USE_SCHEMA** privilege on the
- * referenced parent table's schema, and be the owner of the referenced parent table.
+ * conditions:
+ *
+ * For the table constraint deletion to succeed, the user must satisfy both of these
- * conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog,
- * the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if
- * __cascade__ argument is **true**, the user must have the following permissions on all of the
- * child tables: the **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA**
- * privilege on the table's schema, and be the owner of the table.
+ * conditions:
+ *
+ * A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind
- * of table (rather than a managed or external table).
+ * A table can be managed or external. From an API perspective, a VIEW is a particular
+ * kind of table (rather than a managed or external table).
*/
@Generated
public class TablesAPI {
@@ -36,25 +36,26 @@ public TablesAPI(TablesService mock) {
/**
* Creates a new table in the specified catalog and schema.
*
- * To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA**
- * privilege on the parent schema and the **EXTERNAL_USE_LOCATION** privilege on the external
+ * To create an external delta table, the caller must have the EXTERNAL_USE_SCHEMA
+ * privilege on the parent schema and the EXTERNAL_USE_LOCATION privilege on the external
* location. These privileges must always be granted explicitly, and cannot be inherited through
- * ownership or **ALL_PRIVILEGES**.
+ * ownership or ALL_PRIVILEGES.
*
- * Standard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent
- * catalog (or ownership of the parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent
- * schema (or ownership of the parent schema), and **CREATE_EXTERNAL_TABLE** on external location.
+ * Standard UC permissions needed to create tables still apply: USE_CATALOG on the
+ * parent catalog (or ownership of the parent catalog), CREATE_TABLE and USE_SCHEMA
+ * on the parent schema (or ownership of the parent schema), and CREATE_EXTERNAL_TABLE on
+ * external location.
*
- * The **columns** field needs to be in a Spark compatible format, so we recommend you use
+ * The columns field needs to be in a Spark compatible format, so we recommend you use
* Spark to create these tables. The API itself does not validate the correctness of the column
* spec. If the spec is not Spark compatible, the tables may not be readable by Databricks
* Runtime.
*
- * NOTE: The Create Table API for external clients only supports creating **external delta
- * tables**. The values shown in the respective enums are all values supported by Databricks,
- * however for this specific Create Table API, only **table_type** **EXTERNAL** and
- * **data_source_format** **DELTA** are supported. Additionally, column masks are not supported
- * when creating tables through this API.
+ * NOTE: The Create Table API for external clients only supports creating external delta
+ * tables. The values shown in the respective enums are all values supported by Databricks,
+ * however for this specific Create Table API, only table_type EXTERNAL and
+ * data_source_format DELTA are supported. Additionally, column masks are not
+ * supported when creating tables through this API.
*/
public TableInfo create(CreateTableRequest request) {
return impl.create(request);
@@ -66,9 +67,9 @@ public void delete(String fullName) {
/**
* Deletes a table from the specified parent catalog and schema. The caller must be the owner of
- * the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner
- * of the parent schema, or be the owner of the table and have the **USE_CATALOG** privilege on
- * the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * the parent catalog, have the USE_CATALOG privilege on the parent catalog and be the
+ * owner of the parent schema, or be the owner of the table and have the USE_CATALOG
+ * privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema.
*/
public void delete(DeleteTableRequest request) {
impl.delete(request);
@@ -80,12 +81,19 @@ public TableExistsResponse exists(String fullName) {
/**
* Gets if a table exists in the metastore for a specific catalog and schema. The caller must
- * satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent
- * catalog * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the
- * parent catalog * Have the **USE_CATALOG** privilege on the parent catalog and the
- * **USE_SCHEMA** privilege on the parent schema, and either be the table owner or have the
- * **SELECT** privilege on the table. * Have **BROWSE** privilege on the parent catalog * Have
- * **BROWSE** privilege on the parent schema
+ * satisfy one of the following requirements:
+ *
+ * NOTE: **view_dependencies** and **table_constraints** are not returned by ListTables
+ * NOTE: view_dependencies and table_constraints are not returned by ListTables
* queries.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -154,11 +169,14 @@ public Iterable * summaries for tables (within the current metastore and parent catalog and schema), when
- * the user is a metastore admin, or: * summaries for tables and schemas (within the current
- * metastore and parent catalog) for which the user has ownership or the **SELECT** privilege on
- * the table and ownership or **USE_SCHEMA** privilege on the schema, provided that the user also
- * has ownership or the **USE_CATALOG** privilege on the parent catalog.
+ * There is no guarantee of a specific ordering of the elements in the array.
*
@@ -182,9 +200,9 @@ public Iterable A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind
- * of table (rather than a managed or external table).
+ * A table can be managed or external. From an API perspective, a VIEW is a particular
+ * kind of table (rather than a managed or external table).
*
* This is the high-level interface, that contains generated methods.
*
@@ -22,70 +22,85 @@ public interface TablesService {
/**
* Creates a new table in the specified catalog and schema.
*
- * To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA**
- * privilege on the parent schema and the **EXTERNAL_USE_LOCATION** privilege on the external
+ * To create an external delta table, the caller must have the EXTERNAL_USE_SCHEMA
+ * privilege on the parent schema and the EXTERNAL_USE_LOCATION privilege on the external
* location. These privileges must always be granted explicitly, and cannot be inherited through
- * ownership or **ALL_PRIVILEGES**.
+ * ownership or ALL_PRIVILEGES.
*
- * Standard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent
- * catalog (or ownership of the parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent
- * schema (or ownership of the parent schema), and **CREATE_EXTERNAL_TABLE** on external location.
+ * Standard UC permissions needed to create tables still apply: USE_CATALOG on the
+ * parent catalog (or ownership of the parent catalog), CREATE_TABLE and USE_SCHEMA
+ * on the parent schema (or ownership of the parent schema), and CREATE_EXTERNAL_TABLE on
+ * external location.
*
- * The **columns** field needs to be in a Spark compatible format, so we recommend you use
+ * The columns field needs to be in a Spark compatible format, so we recommend you use
* Spark to create these tables. The API itself does not validate the correctness of the column
* spec. If the spec is not Spark compatible, the tables may not be readable by Databricks
* Runtime.
*
- * NOTE: The Create Table API for external clients only supports creating **external delta
- * tables**. The values shown in the respective enums are all values supported by Databricks,
- * however for this specific Create Table API, only **table_type** **EXTERNAL** and
- * **data_source_format** **DELTA** are supported. Additionally, column masks are not supported
- * when creating tables through this API.
+ * NOTE: The Create Table API for external clients only supports creating external delta
+ * tables. The values shown in the respective enums are all values supported by Databricks,
+ * however for this specific Create Table API, only table_type EXTERNAL and
+ * data_source_format DELTA are supported. Additionally, column masks are not
+ * supported when creating tables through this API.
*/
TableInfo create(CreateTableRequest createTableRequest);
/**
* Deletes a table from the specified parent catalog and schema. The caller must be the owner of
- * the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner
- * of the parent schema, or be the owner of the table and have the **USE_CATALOG** privilege on
- * the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * the parent catalog, have the USE_CATALOG privilege on the parent catalog and be the
+ * owner of the parent schema, or be the owner of the table and have the USE_CATALOG
+ * privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema.
*/
void delete(DeleteTableRequest deleteTableRequest);
/**
* Gets if a table exists in the metastore for a specific catalog and schema. The caller must
- * satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent
- * catalog * Be the owner of the parent schema and have the **USE_CATALOG** privilege on the
- * parent catalog * Have the **USE_CATALOG** privilege on the parent catalog and the
- * **USE_SCHEMA** privilege on the parent schema, and either be the table owner or have the
- * **SELECT** privilege on the table. * Have **BROWSE** privilege on the parent catalog * Have
- * **BROWSE** privilege on the parent schema
+ * satisfy one of the following requirements:
+ *
+ * NOTE: **view_dependencies** and **table_constraints** are not returned by ListTables
+ * NOTE: view_dependencies and table_constraints are not returned by ListTables
* queries.
*
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
@@ -96,11 +111,14 @@ public interface TablesService {
* Gets an array of summaries for tables for a schema and catalog within the metastore. The table
* summaries returned are either:
*
- * * summaries for tables (within the current metastore and parent catalog and schema), when
- * the user is a metastore admin, or: * summaries for tables and schemas (within the current
- * metastore and parent catalog) for which the user has ownership or the **SELECT** privilege on
- * the table and ownership or **USE_SCHEMA** privilege on the schema, provided that the user also
- * has ownership or the **USE_CATALOG** privilege on the parent catalog.
+ * There is no guarantee of a specific ordering of the elements in the array.
*
@@ -112,9 +130,9 @@ public interface TablesService {
/**
* Change the owner of the table. The caller must be the owner of the parent catalog, have the
- * **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be
- * the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the
- * **USE_SCHEMA** privilege on the parent schema.
+ * USE_CATALOG privilege on the parent catalog and be the owner of the parent schema, or be
+ * the owner of the table and have the USE_CATALOG privilege on the parent catalog and the
+ * USE_SCHEMA privilege on the parent schema.
*/
void update(UpdateTableRequest updateTableRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsAPI.java
index 8ba3bec52..ccf431878 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsAPI.java
@@ -47,11 +47,11 @@ public TemporaryPathCredentialsAPI(TemporaryPathCredentialsService mock) {
* Get a short-lived credential for directly accessing cloud storage locations registered in
* Databricks. The Generate Temporary Path Credentials API is only supported for external storage
* paths, specifically external locations and external tables. Managed tables are not supported by
- * this API. The metastore must have **external_access_enabled** flag set to true (default false).
- * The caller must have the **EXTERNAL_USE_LOCATION** privilege on the external location; this
- * privilege can only be granted by external location owners. For requests on existing external
- * tables, the caller must also have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema;
- * this privilege can only be granted by catalog owners.
+ * this API. The metastore must have external_access_enabled flag set to true (default
+ * false). The caller must have the EXTERNAL_USE_LOCATION privilege on the external
+ * location; this privilege can only be granted by external location owners. For requests on
+ * existing external tables, the caller must also have the EXTERNAL_USE_SCHEMA privilege on
+ * the parent schema; this privilege can only be granted by catalog owners.
*/
public GenerateTemporaryPathCredentialResponse generateTemporaryPathCredentials(
GenerateTemporaryPathCredentialRequest request) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsService.java
index a77a2663d..11b1f0b85 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryPathCredentialsService.java
@@ -34,11 +34,11 @@ public interface TemporaryPathCredentialsService {
* Get a short-lived credential for directly accessing cloud storage locations registered in
* Databricks. The Generate Temporary Path Credentials API is only supported for external storage
* paths, specifically external locations and external tables. Managed tables are not supported by
- * this API. The metastore must have **external_access_enabled** flag set to true (default false).
- * The caller must have the **EXTERNAL_USE_LOCATION** privilege on the external location; this
- * privilege can only be granted by external location owners. For requests on existing external
- * tables, the caller must also have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema;
- * this privilege can only be granted by catalog owners.
+ * this API. The metastore must have external_access_enabled flag set to true (default
+ * false). The caller must have the EXTERNAL_USE_LOCATION privilege on the external
+ * location; this privilege can only be granted by external location owners. For requests on
+ * existing external tables, the caller must also have the EXTERNAL_USE_SCHEMA privilege on
+ * the parent schema; this privilege can only be granted by catalog owners.
*/
GenerateTemporaryPathCredentialResponse generateTemporaryPathCredentials(
GenerateTemporaryPathCredentialRequest generateTemporaryPathCredentialRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsAPI.java
index 337b5f8ae..52c0c2ee6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsAPI.java
@@ -40,8 +40,8 @@ public TemporaryTableCredentialsAPI(TemporaryTableCredentialsService mock) {
/**
* Get a short-lived credential for directly accessing the table data on cloud storage. The
- * metastore must have **external_access_enabled** flag set to true (default false). The caller
- * must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can
+ * metastore must have external_access_enabled flag set to true (default false). The caller
+ * must have the EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can
* only be granted by catalog owners.
*/
public GenerateTemporaryTableCredentialResponse generateTemporaryTableCredentials(
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsService.java
index f5057721c..34013db5a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryTableCredentialsService.java
@@ -27,8 +27,8 @@
public interface TemporaryTableCredentialsService {
/**
* Get a short-lived credential for directly accessing the table data on cloud storage. The
- * metastore must have **external_access_enabled** flag set to true (default false). The caller
- * must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can
+ * metastore must have external_access_enabled flag set to true (default false). The caller
+ * must have the EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can
* only be granted by catalog owners.
*/
GenerateTemporaryTableCredentialResponse generateTemporaryTableCredentials(
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsAPI.java
index d91363f13..96014ba9e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsAPI.java
@@ -40,8 +40,8 @@ public TemporaryVolumeCredentialsAPI(TemporaryVolumeCredentialsService mock) {
/**
* Get a short-lived credential for directly accessing the volume data on cloud storage. The
- * metastore must have **external_access_enabled** flag set to true (default false). The caller
- * must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can
+ * metastore must have external_access_enabled flag set to true (default false). The caller
+ * must have the EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can
* only be granted by catalog owners.
*/
public GenerateTemporaryVolumeCredentialResponse generateTemporaryVolumeCredentials(
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsService.java
index 726abe937..7b2fcb6cc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryVolumeCredentialsService.java
@@ -27,8 +27,8 @@
public interface TemporaryVolumeCredentialsService {
/**
* Get a short-lived credential for directly accessing the volume data on cloud storage. The
- * metastore must have **external_access_enabled** flag set to true (default false). The caller
- * must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can
+ * metastore must have external_access_enabled flag set to true (default false). The caller
+ * must have the EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can
* only be granted by catalog owners.
*/
GenerateTemporaryVolumeCredentialResponse generateTemporaryVolumeCredentials(
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java
index dac6c0ae3..2a8429e53 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java
@@ -13,21 +13,21 @@
public class UpdateAccessRequestDestinationsRequest {
/**
* The access request destinations to assign to the securable. For each destination, a
- * **destination_id** and **destination_type** must be defined.
+ * destination_id and destination_type must be defined.
*/
@JsonProperty("access_request_destinations")
private AccessRequestDestinations accessRequestDestinations;
/**
* 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.
+ * The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsMetastore.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsMetastore.java
index edb988b14..37056ac63 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsMetastore.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsMetastore.java
@@ -32,7 +32,9 @@ public class UpdateAccountsMetastore {
@JsonProperty("owner")
private String owner;
- /** Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`). */
+ /**
+ * Privilege model version of the metastore, of the form {@code major.minor} (e.g., {@code 1.0}).
+ */
@JsonProperty("privilege_model_version")
private String privilegeModelVersion;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java
index 22801de40..613ba9483 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java
@@ -46,7 +46,7 @@ public class UpdateAccountsStorageCredential {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCredentialRequest.java
index bba0e810a..7e2cc1f21 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCredentialRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCredentialRequest.java
@@ -31,8 +31,8 @@ public class UpdateCredentialRequest {
private DatabricksGcpServiceAccount databricksGcpServiceAccount;
/**
- * Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent
- * external locations and external tables (when purpose is **STORAGE**).
+ * Force an update even if there are dependent services (when purpose is SERVICE) or
+ * dependent external locations and external tables (when purpose is STORAGE).
*/
@JsonProperty("force")
private Boolean force;
@@ -57,7 +57,7 @@ public class UpdateCredentialRequest {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateEntityTagAssignmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateEntityTagAssignmentRequest.java
index 46758b6d3..4ccc152ff 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateEntityTagAssignmentRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateEntityTagAssignmentRequest.java
@@ -26,14 +26,14 @@ public class UpdateEntityTagAssignmentRequest {
/**
* 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.
+ * The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java
index 1b42084f5..14dff5bdf 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java
@@ -17,14 +17,14 @@ public class UpdateExternalLineageRelationshipRequest {
/**
* 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.
+ * The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java
index 30a957764..a32156904 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java
@@ -18,23 +18,23 @@ public class UpdateExternalLocation {
@JsonProperty("credential_name")
private String credentialName;
- /** The effective value of `enable_file_events` after applying server-side defaults. */
+ /** The effective value of {@code enable_file_events} after applying server-side defaults. */
@JsonProperty("effective_enable_file_events")
private Boolean effectiveEnableFileEvents;
/**
* The effective file event queue configuration after applying server-side defaults. Always
- * populated when a queue is provisioned, regardless of whether the user explicitly set
- * `enable_file_events`. Use this field instead of `file_event_queue` for reading the actual queue
- * state.
+ * populated when a queue is provisioned, regardless of whether the user explicitly set {@code
+ * enable_file_events}. Use this field instead of {@code file_event_queue} for reading the actual
+ * queue state.
*/
@JsonProperty("effective_file_event_queue")
private FileEventQueue effectiveFileEventQueue;
/**
- * Whether to enable file events on this external location. Default to `true`. Set to `false` to
- * disable file events. The actual applied value may differ due to server-side defaults; check
- * `effective_enable_file_events` for the effective state.
+ * Whether to enable file events on this external location. Default to {@code true}. Set to {@code
+ * false} to disable file events. The actual applied value may differ due to server-side defaults;
+ * check {@code effective_enable_file_events} for the effective state.
*/
@JsonProperty("enable_file_events")
private Boolean enableFileEvents;
@@ -52,8 +52,8 @@ public class UpdateExternalLocation {
private Boolean fallback;
/**
- * File event queue settings. If `enable_file_events` is not `false`, must be defined and have
- * exactly one of the documented properties.
+ * File event queue settings. If {@code enable_file_events} is not {@code false}, must be defined
+ * and have exactly one of the documented properties.
*/
@JsonProperty("file_event_queue")
private FileEventQueue fileEventQueue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
index 890161e0e..f2647037b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
@@ -20,14 +20,14 @@ public class UpdateExternalMetadataRequest {
/**
* 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.
+ * The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateFunction.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateFunction.java
index bdbf23c12..5dfde3a4b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateFunction.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateFunction.java
@@ -12,7 +12,7 @@
public class UpdateFunction {
/**
* The fully-qualified name of the function (of the form
- * __catalog_name__.__schema_name__.__function__name__).
+ * catalog_name.schema_name.function__name).
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMetastore.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMetastore.java
index 4c66f7533..a4f3743ec 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMetastore.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMetastore.java
@@ -40,7 +40,9 @@ public class UpdateMetastore {
@JsonProperty("owner")
private String owner;
- /** Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`). */
+ /**
+ * Privilege model version of the metastore, of the form {@code major.minor} (e.g., {@code 1.0}).
+ */
@JsonProperty("privilege_model_version")
private String privilegeModelVersion;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelVersionRequest.java
index b49178472..e9e797c4f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelVersionRequest.java
@@ -51,7 +51,7 @@ public class UpdateModelVersionRequest {
private DependencyList modelVersionDependencies;
/**
- * MLflow run ID used when creating the model version, if ``source`` was generated by an
+ * MLflow run ID used when creating the model version, if {@code source} was generated by an
* experiment run stored in an MLflow tracking server
*/
@JsonProperty("run_id")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMonitor.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMonitor.java
index bea5e8a7c..9779d6f46 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMonitor.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMonitor.java
@@ -13,8 +13,8 @@
public class UpdateMonitor {
/**
* [Create:OPT Update:OPT] Baseline table name. Baseline data is used to compute drift from the
- * data in the monitored `table_name`. The baseline table and the monitored table shall have the
- * same schema.
+ * data in the monitored {@code table_name}. The baseline table and the monitored table shall have
+ * the same schema.
*/
@JsonProperty("baseline_table_name")
private String baselineTableName;
@@ -60,10 +60,10 @@ public class UpdateMonitor {
/**
* [Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis.
* The data is grouped by each expression independently, resulting in a separate slice for each
- * predicate and its complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will
- * generate the following slices: two slices for `col_2 > 10` (True and False), and one slice per
- * unique value in `col1`. For high-cardinality columns, only the top 100 unique values by
- * frequency will generate slices.
+ * predicate and its complements. For example {@code slicing_exprs=[“col_1”, “col_2 > 10”]} will
+ * generate the following slices: two slices for {@code col_2 > 10} (True and False), and one
+ * slice per unique value in {@code col1}. For high-cardinality columns, only the top 100 unique
+ * values by frequency will generate slices.
*/
@JsonProperty("slicing_exprs")
private Collection [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external
+ * the parent catalog, or the Metastore. Learn more
*/
@JsonProperty("volume_type")
private VolumeType volumeType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java
index ebbf25311..70731f131 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java
@@ -40,15 +40,23 @@ public VolumesAPI(VolumesService mock) {
* default location which is specified by the parent schema, or the parent catalog, or the
* Metastore.
*
- * For the volume creation to succeed, the user must satisfy following conditions: - The caller
- * must be a metastore admin, or be the owner of the parent catalog and schema, or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema. - The caller must have **CREATE VOLUME** privilege on the parent schema.
+ * For the volume creation to succeed, the user must satisfy following conditions:
*
- * For an external volume, following conditions also need to satisfy - The caller must have
- * **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other tables, nor
- * volumes existing in the specified storage location. - The specified storage location is not
- * under the location of other tables, nor volumes, or catalogs or schemas.
+ * For an external volume, following conditions also need to satisfy
+ *
+ * The caller must be a metastore admin or an owner of the volume. For the latter case, the
- * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and
- * the **USE_SCHEMA** privilege on the parent schema.
+ * caller must also be the owner or have the USE_CATALOG privilege on the parent catalog
+ * and the USE_SCHEMA privilege on the parent schema.
*/
public void delete(DeleteVolumeRequest request) {
impl.delete(request);
@@ -78,9 +86,9 @@ public Iterable The returned volumes are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the volumes. A regular user needs to be the owner or
- * have the **READ VOLUME** privilege on the volume to receive the volumes in the response. For
- * the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * have the READ VOLUME privilege on the volume to receive the volumes in the response. For
+ * the latter case, the caller must also be the owner or have the USE_CATALOG privilege on
+ * the parent catalog and the USE_SCHEMA privilege on the parent schema.
*
* There is no guarantee of a specific ordering of the elements in the array.
*
@@ -109,10 +117,10 @@ public VolumeInfo read(String name) {
/**
* Gets a volume from the metastore for a specific catalog and schema.
*
- * The caller must be a metastore admin or an owner of (or have the **READ VOLUME** privilege
- * on) the volume. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the READ VOLUME
+ * privilege on) the volume. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
public VolumeInfo read(ReadVolumeRequest request) {
return impl.read(request);
@@ -122,8 +130,8 @@ public VolumeInfo read(ReadVolumeRequest request) {
* Updates the specified volume under the specified parent catalog and schema.
*
* The caller must be a metastore admin or an owner of the volume. For the latter case, the
- * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and
- * the **USE_SCHEMA** privilege on the parent schema.
+ * caller must also be the owner or have the USE_CATALOG privilege on the parent catalog
+ * and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the name, the owner or the comment of the volume could be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java
index 14a3115b4..67e1ade4e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java
@@ -26,15 +26,23 @@ public interface VolumesService {
* default location which is specified by the parent schema, or the parent catalog, or the
* Metastore.
*
- * For the volume creation to succeed, the user must satisfy following conditions: - The caller
- * must be a metastore admin, or be the owner of the parent catalog and schema, or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema. - The caller must have **CREATE VOLUME** privilege on the parent schema.
+ * For the volume creation to succeed, the user must satisfy following conditions:
*
- * For an external volume, following conditions also need to satisfy - The caller must have
- * **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other tables, nor
- * volumes existing in the specified storage location. - The specified storage location is not
- * under the location of other tables, nor volumes, or catalogs or schemas.
+ * For an external volume, following conditions also need to satisfy
+ *
+ * The caller must be a metastore admin or an owner of the volume. For the latter case, the
- * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and
- * the **USE_SCHEMA** privilege on the parent schema.
+ * caller must also be the owner or have the USE_CATALOG privilege on the parent catalog
+ * and the USE_SCHEMA privilege on the parent schema.
*/
void delete(DeleteVolumeRequest deleteVolumeRequest);
@@ -52,9 +60,9 @@ public interface VolumesService {
*
* The returned volumes are filtered based on the privileges of the calling user. For example,
* the metastore admin is able to list all the volumes. A regular user needs to be the owner or
- * have the **READ VOLUME** privilege on the volume to receive the volumes in the response. For
- * the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the
- * parent catalog and the **USE_SCHEMA** privilege on the parent schema.
+ * have the READ VOLUME privilege on the volume to receive the volumes in the response. For
+ * the latter case, the caller must also be the owner or have the USE_CATALOG privilege on
+ * the parent catalog and the USE_SCHEMA privilege on the parent schema.
*
* There is no guarantee of a specific ordering of the elements in the array.
*
@@ -67,10 +75,10 @@ public interface VolumesService {
/**
* Gets a volume from the metastore for a specific catalog and schema.
*
- * The caller must be a metastore admin or an owner of (or have the **READ VOLUME** privilege
- * on) the volume. For the latter case, the caller must also be the owner or have the
- * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent
- * schema.
+ * The caller must be a metastore admin or an owner of (or have the READ VOLUME
+ * privilege on) the volume. For the latter case, the caller must also be the owner or have the
+ * USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the
+ * parent schema.
*/
VolumeInfo read(ReadVolumeRequest readVolumeRequest);
@@ -78,8 +86,8 @@ public interface VolumesService {
* Updates the specified volume under the specified parent catalog and schema.
*
* The caller must be a metastore admin or an owner of the volume. For the latter case, the
- * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and
- * the **USE_SCHEMA** privilege on the parent schema.
+ * caller must also be the owner or have the USE_CATALOG privilege on the parent catalog
+ * and the USE_SCHEMA privilege on the parent schema.
*
* Currently only the name, the owner or the comment of the volume could be updated.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingBindingType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingBindingType.java
index 0aeb76cc9..faf8df6b9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingBindingType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingBindingType.java
@@ -5,8 +5,8 @@
import com.databricks.sdk.support.Generated;
/**
- * Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in
- * `credentials_common.proto`.
+ * Using {@code BINDING_TYPE_} prefix here to avoid conflict with {@code TableOperation} enum in
+ * {@code credentials_common.proto}.
*/
@Generated
public enum WorkspaceBindingBindingType {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsAPI.java
index ad41bcda5..b2ad0ae66 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsAPI.java
@@ -8,13 +8,14 @@
import com.databricks.sdk.support.Paginator;
/**
- * A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable
- * can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a
- * configured list of workspaces. This API allows you to configure (bind) securables to workspaces.
+ * A securable in Databricks can be configured as OPEN or ISOLATED. An OPEN
+ * securable can be accessed from any workspace, while an ISOLATED securable can only be
+ * accessed from a configured list of workspaces. This API allows you to configure (bind) securables
+ * to workspaces.
*
- * NOTE: The __isolation_mode__ is configured for the securable itself (using its Update method)
- * and the workspace bindings are only consulted when the securable's __isolation_mode__ is set to
- * __ISOLATED__.
+ * NOTE: The isolation_mode is configured for the securable itself (using its Update
+ * method) and the workspace bindings are only consulted when the securable's isolation_mode
+ * is set to ISOLATED.
*
* A securable's workspace bindings can be configured by a metastore admin or the owner of the
* securable.
@@ -23,8 +24,14 @@
* Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which
* introduces the ability to bind a securable in READ_ONLY mode (catalogs only).
*
- * Securable types that support binding: - catalog - storage_credential - credential -
- * external_location
+ * Securable types that support binding:
+ *
+ * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsService.java
index 5b7b2ccf3..d05aa6751 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/WorkspaceBindingsService.java
@@ -4,13 +4,14 @@
import com.databricks.sdk.support.Generated;
/**
- * A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable
- * can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a
- * configured list of workspaces. This API allows you to configure (bind) securables to workspaces.
+ * A securable in Databricks can be configured as OPEN or ISOLATED. An OPEN
+ * securable can be accessed from any workspace, while an ISOLATED securable can only be
+ * accessed from a configured list of workspaces. This API allows you to configure (bind) securables
+ * to workspaces.
*
- * NOTE: The __isolation_mode__ is configured for the securable itself (using its Update method)
- * and the workspace bindings are only consulted when the securable's __isolation_mode__ is set to
- * __ISOLATED__.
+ * NOTE: The isolation_mode is configured for the securable itself (using its Update
+ * method) and the workspace bindings are only consulted when the securable's isolation_mode
+ * is set to ISOLATED.
*
* A securable's workspace bindings can be configured by a metastore admin or the owner of the
* securable.
@@ -19,10 +20,16 @@
* Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which
* introduces the ability to bind a securable in READ_ONLY mode (catalogs only).
*
- * Securable types that support binding: - catalog - storage_credential - credential -
- * external_location
+ * Securable types that support binding:
*
- * This is the high-level interface, that contains generated methods.
+ * Evolving: this interface is under development. Method signatures may change.
*/
@@ -41,7 +48,7 @@ public interface WorkspaceBindingsService {
* NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated
* calls will be deprecated soon.
*
- * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
+ * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero
* results while still providing a next_page_token. Clients must continue reading pages until
* next_page_token is absent, which is the only indication that the end of results has been
* reached.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
index 0372a8bd2..6bc2ddea5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
@@ -10,9 +10,8 @@
@Generated
public class CleanRoom {
/**
- * Whether clean room access is restricted due to [CSP]
- *
- * [CSP]: https://docs.databricks.com/en/security/privacy/security-profile.html
+ * Whether clean room access is restricted due to CSP
*/
@JsonProperty("access_restricted")
private CleanRoomAccessRestricted accessRestricted;
@@ -30,10 +29,9 @@ public class CleanRoom {
private String localCollaboratorAlias;
/**
- * The name of the clean room. It should follow [UC securable naming requirements].
- *
- * [UC securable naming requirements]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements
+ * The name of the clean room. It should follow UC
+ * securable naming requirements.
*/
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAsset.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAsset.java
index 92ccceeeb..e342d6841 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAsset.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAsset.java
@@ -27,14 +27,14 @@ public class CleanRoomAsset {
/**
* Foreign table details available to all collaborators of the clean room. Present if and only if
- * **asset_type** is **FOREIGN_TABLE**
+ * asset_type is FOREIGN_TABLE
*/
@JsonProperty("foreign_table")
private CleanRoomAssetForeignTable foreignTable;
/**
* Local details for a foreign that are only available to its owner. Present if and only if
- * **asset_type** is **FOREIGN_TABLE**
+ * asset_type is FOREIGN_TABLE
*/
@JsonProperty("foreign_table_local_details")
private CleanRoomAssetForeignTableLocalDetails foreignTableLocalDetails;
@@ -44,7 +44,7 @@ public class CleanRoomAsset {
* the name displayed in the clean room UI.
*
* For UC securable assets (tables, volumes, etc.), the format is
- * *shared_catalog*.*shared_schema*.*asset_name*
+ * shared_catalog.shared_schema.asset_name
*
* For notebooks, the name is the notebook file name. For jar analyses, the name is the jar
* analysis name.
@@ -54,7 +54,7 @@ public class CleanRoomAsset {
/**
* Notebook details available to all collaborators of the clean room. Present if and only if
- * **asset_type** is **NOTEBOOK_FILE**
+ * asset_type is NOTEBOOK_FILE
*/
@JsonProperty("notebook")
private CleanRoomAssetNotebook notebook;
@@ -69,35 +69,35 @@ public class CleanRoomAsset {
/**
* Table details available to all collaborators of the clean room. Present if and only if
- * **asset_type** is **TABLE**
+ * asset_type is TABLE
*/
@JsonProperty("table")
private CleanRoomAssetTable table;
/**
* Local details for a table that are only available to its owner. Present if and only if
- * **asset_type** is **TABLE**
+ * asset_type is TABLE
*/
@JsonProperty("table_local_details")
private CleanRoomAssetTableLocalDetails tableLocalDetails;
/**
* View details available to all collaborators of the clean room. Present if and only if
- * **asset_type** is **VIEW**
+ * asset_type is VIEW
*/
@JsonProperty("view")
private CleanRoomAssetView view;
/**
* Local details for a view that are only available to its owner. Present if and only if
- * **asset_type** is **VIEW**
+ * asset_type is VIEW
*/
@JsonProperty("view_local_details")
private CleanRoomAssetViewLocalDetails viewLocalDetails;
/**
* Local details for a volume that are only available to its owner. Present if and only if
- * **asset_type** is **VOLUME**
+ * asset_type is VOLUME
*/
@JsonProperty("volume_local_details")
private CleanRoomAssetVolumeLocalDetails volumeLocalDetails;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetForeignTableLocalDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetForeignTableLocalDetails.java
index 04e0234e0..e639a5fd7 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetForeignTableLocalDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetForeignTableLocalDetails.java
@@ -11,7 +11,7 @@
public class CleanRoomAssetForeignTableLocalDetails {
/**
* The fully qualified name of the foreign table in its owner's local metastore, in the format of
- * *catalog*.*schema*.*foreign_table_name*
+ * catalog.schema.foreign_table_name
*/
@JsonProperty("local_name")
private String localName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetNotebook.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetNotebook.java
index c4d6211cc..bcc1747a8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetNotebook.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetNotebook.java
@@ -16,7 +16,7 @@ public class CleanRoomAssetNotebook {
/**
* Base 64 representation of the notebook contents. This is the same format as returned by
- * :method:workspace/export with the format of **HTML**.
+ * :method:workspace/export with the format of HTML.
*/
@JsonProperty("notebook_content")
private String notebookContent;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetTableLocalDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetTableLocalDetails.java
index 308f3b99c..0d5905d33 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetTableLocalDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetTableLocalDetails.java
@@ -12,7 +12,7 @@
public class CleanRoomAssetTableLocalDetails {
/**
* The fully qualified name of the table in its owner's local metastore, in the format of
- * *catalog*.*schema*.*table_name*
+ * catalog.schema.table_name
*/
@JsonProperty("local_name")
private String localName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetViewLocalDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetViewLocalDetails.java
index 8727c5ab7..c12f57d50 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetViewLocalDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetViewLocalDetails.java
@@ -11,7 +11,7 @@
public class CleanRoomAssetViewLocalDetails {
/**
* The fully qualified name of the view in its owner's local metastore, in the format of
- * *catalog*.*schema*.*view_name*
+ * catalog.schema.view_name
*/
@JsonProperty("local_name")
private String localName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetVolumeLocalDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetVolumeLocalDetails.java
index 8899663c9..201f350a3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetVolumeLocalDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetVolumeLocalDetails.java
@@ -11,7 +11,7 @@
public class CleanRoomAssetVolumeLocalDetails {
/**
* The fully qualified name of the volume in its owner's local metastore, in the format of
- * *catalog*.*schema*.*volume_name*
+ * catalog.schema.volume_name
*/
@JsonProperty("local_name")
private String localName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAutoApprovalRule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAutoApprovalRule.java
index f9697996f..19ee047eb 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAutoApprovalRule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAutoApprovalRule.java
@@ -10,15 +10,15 @@
@Generated
public class CleanRoomAutoApprovalRule {
/**
- * Collaborator alias of the author covered by the rule. Only one of `author_collaborator_alias`
- * and `author_scope` can be set.
+ * Collaborator alias of the author covered by the rule. Only one of {@code
+ * author_collaborator_alias} and {@code author_scope} can be set.
*/
@JsonProperty("author_collaborator_alias")
private String authorCollaboratorAlias;
/**
- * Scope of authors covered by the rule. Only one of `author_collaborator_alias` and
- * `author_scope` can be set.
+ * Scope of authors covered by the rule. Only one of {@code author_collaborator_alias} and {@code
+ * author_scope} can be set.
*/
@JsonProperty("author_scope")
private CleanRoomAutoApprovalRuleAuthorScope authorScope;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomCollaborator.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomCollaborator.java
index f757862ee..fceb7031f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomCollaborator.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomCollaborator.java
@@ -13,11 +13,9 @@ public class CleanRoomCollaborator {
/**
* Collaborator alias specified by the clean room creator. It is unique across all collaborators
* of this clean room, and used to derive multiple values internally such as catalog alias and
- * clean room name for single metastore clean rooms. It should follow [UC securable naming
- * requirements].
- *
- * [UC securable naming requirements]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements
+ * clean room name for single metastore clean rooms. It should follow UC
+ * securable naming requirements.
*/
@JsonProperty("collaborator_alias")
private String collaboratorAlias;
@@ -54,8 +52,8 @@ public class CleanRoomCollaborator {
private Long inviteRecipientWorkspaceId;
/**
- * [Organization name](:method:metastores/list#metastores-delta_sharing_organization_name)
- * configured in the metastore
+ * Organization
+ * name configured in the metastore
*/
@JsonProperty("organization_name")
private String organizationName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
index eb864a9ee..8df7d8fd8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
@@ -10,11 +10,9 @@
@Generated
public class CleanRoomOutputCatalog {
/**
- * The name of the output catalog in UC. It should follow [UC securable naming requirements]. The
- * field will always exist if status is CREATED.
- *
- * [UC securable naming requirements]:
- * https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements
+ * The name of the output catalog in UC. It should follow UC
+ * securable naming requirements. The field will always exist if status is CREATED.
*/
@JsonProperty("catalog_name")
private String catalogName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
index 46f713c85..72c13d20b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
@@ -23,9 +23,10 @@ public class CleanRoomRemoteDetail {
* Collaborators in the central clean room. There should one and only one collaborator in the list
* that satisfies the owner condition:
*
- * 1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom).
- *
- * 2. Its invite_recipient_email is empty.
+ * The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the
+ * The caller must be a metastore admin or have the CREATE_CLEAN_ROOM privilege on the
* metastore.
*/
public Wait When the caller is a metastore admin, only the __owner__ field can be updated.
+ * When the caller is a metastore admin, only the owner field can be updated.
*/
public CleanRoom update(UpdateCleanRoomRequest request) {
return impl.update(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
index 56c3b7fb3..f63072e20 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
@@ -21,7 +21,7 @@ public interface CleanRoomsService {
* PROVISIONING state, with only name, owner, comment, created_at and status populated. The clean
* room will be usable once it enters an ACTIVE state.
*
- * The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the
+ * The caller must be a metastore admin or have the CREATE_CLEAN_ROOM privilege on the
* metastore.
*/
CleanRoom create(CreateCleanRoomRequest createCleanRoomRequest);
@@ -48,10 +48,10 @@ CreateCleanRoomOutputCatalogResponse createOutputCatalog(
ListCleanRoomsResponse list(ListCleanRoomsRequest listCleanRoomsRequest);
/**
- * Update a clean room. The caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM**
- * privilege, or be metastore admin.
+ * Update a clean room. The caller must be the owner of the clean room, have
+ * MODIFY_CLEAN_ROOM privilege, or be metastore admin.
*
- * When the caller is a metastore admin, only the __owner__ field can be updated.
+ * When the caller is a metastore admin, only the owner field can be updated.
*/
CleanRoom update(UpdateCleanRoomRequest updateCleanRoomRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomAssetRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomAssetRequest.java
index 57d530c52..f8752bb98 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomAssetRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomAssetRequest.java
@@ -11,8 +11,8 @@
@Generated
public class UpdateCleanRoomAssetRequest {
/**
- * The asset to update. The asset's `name` and `asset_type` fields are used to identify the asset
- * to update.
+ * The asset to update. The asset's {@code name} and {@code asset_type} fields are used to
+ * identify the asset to update.
*/
@JsonProperty("asset")
private CleanRoomAsset asset;
@@ -28,7 +28,7 @@ public class UpdateCleanRoomAssetRequest {
* the name displayed in the clean room UI.
*
* For UC securable assets (tables, volumes, etc.), the format is
- * *shared_catalog*.*shared_schema*.*asset_name*
+ * shared_catalog.shared_schema.asset_name
*
* For notebooks, the name is the notebook file name. For jar analyses, the name is the jar
* analysis name.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AddInstanceProfile.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AddInstanceProfile.java
index 947d3bffa..f8938fc11 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AddInstanceProfile.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AddInstanceProfile.java
@@ -12,11 +12,10 @@ public class AddInstanceProfile {
/**
* The AWS IAM role ARN of the role associated with the instance profile. This field is required
* if your role name and instance profile name do not match and you want to use the instance
- * profile with [Databricks SQL Serverless].
+ * profile with Databricks SQL
+ * Serverless.
*
* Otherwise, this field is optional.
- *
- * [Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html
*/
@JsonProperty("iam_role_arn")
private String iamRoleArn;
@@ -29,7 +28,7 @@ public class AddInstanceProfile {
* Boolean flag indicating whether the instance profile should only be used in credential
* passthrough scenarios. If true, it means the instance profile contains an meta IAM role which
* could assume a wide range of roles. Therefore it should always be used with authorization. This
- * field is optional, the default value is `false`.
+ * field is optional, the default value is {@code false}.
*/
@JsonProperty("is_meta_instance_profile")
private Boolean isMetaInstanceProfile;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Adlsgen2Info.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Adlsgen2Info.java
index 9aa66fa06..9c08c123a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Adlsgen2Info.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Adlsgen2Info.java
@@ -11,8 +11,8 @@
@Generated
public class Adlsgen2Info {
/**
- * abfss destination, e.g.
- * `abfss:// These EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc. Instance store volumes will
- * be mounted at `/local_disk0`, `/local_disk1`, and etc.
+ * These EBS volumes will be mounted at {@code /ebs0}, {@code /ebs1}, and etc. Instance store
+ * volumes will be mounted at {@code /local_disk0}, {@code /local_disk1}, and etc.
*
* If EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for
* scratch storage because heterogenously sized scratch devices can lead to inefficient disk
* utilization. If no EBS volumes are attached, Databricks will configure Spark to use instance
* store volumes.
*
- * Please note that if EBS volumes are specified, then the Spark configuration
- * `spark.local.dir` will be overridden.
+ * Please note that if EBS volumes are specified, then the Spark configuration {@code
+ * spark.local.dir} will be overridden.
*/
@JsonProperty("ebs_volume_count")
private Long ebsVolumeCount;
@@ -61,13 +61,13 @@ public class AwsAttributes {
private EbsVolumeType ebsVolumeType;
/**
- * The first `first_on_demand` nodes of the cluster will be placed on on-demand instances. If this
- * value is greater than 0, the cluster driver node in particular will be placed on an on-demand
- * instance. If this value is greater than or equal to the current cluster size, all nodes will be
- * placed on on-demand instances. If this value is less than the current cluster size,
- * `first_on_demand` nodes will be placed on on-demand instances and the remainder will be placed
- * on `availability` instances. Note that this value does not affect cluster size and cannot
- * currently be mutated over the lifetime of a cluster.
+ * The first {@code first_on_demand} nodes of the cluster will be placed on on-demand instances.
+ * If this value is greater than 0, the cluster driver node in particular will be placed on an
+ * on-demand instance. If this value is greater than or equal to the current cluster size, all
+ * nodes will be placed on on-demand instances. If this value is less than the current cluster
+ * size, {@code first_on_demand} nodes will be placed on on-demand instances and the remainder
+ * will be placed on {@code availability} instances. Note that this value does not affect cluster
+ * size and cannot currently be mutated over the lifetime of a cluster.
*/
@JsonProperty("first_on_demand")
private Long firstOnDemand;
@@ -85,10 +85,10 @@ public class AwsAttributes {
/**
* The bid price for AWS spot instances, as a percentage of the corresponding instance type's
- * on-demand price. For example, if this field is set to 50, and the cluster needs a new
- * `r3.xlarge` spot instance, then the bid price is half of the price of on-demand `r3.xlarge`
- * instances. Similarly, if this field is set to 200, the bid price is twice the price of
- * on-demand `r3.xlarge` instances. If not specified, the default value is 100. When spot
+ * on-demand price. For example, if this field is set to 50, and the cluster needs a new {@code
+ * r3.xlarge} spot instance, then the bid price is half of the price of on-demand {@code
+ * r3.xlarge} instances. Similarly, if this field is set to 200, the bid price is twice the price
+ * of on-demand {@code r3.xlarge} instances. If not specified, the default value is 100. When spot
* instances are requested for this cluster, only spot instances whose bid price percentage
* matches this field will be considered. Note that, for safety, we enforce this field to be no
* more than 10000.
@@ -105,8 +105,8 @@ public class AwsAttributes {
* to place cluster in a zone with high availability, and will retry placement in a different AZ
* if there is not enough capacity.
*
- * The list of available zones as well as the default value can be found by using the `List
- * Zones` method.
+ * The list of available zones as well as the default value can be found by using the {@code
+ * List Zones} method.
*/
@JsonProperty("zone_id")
private String zoneId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAvailability.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAvailability.java
index c420e5f1f..e84fc566d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAvailability.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAvailability.java
@@ -5,9 +5,9 @@
import com.databricks.sdk.support.Generated;
/**
- * Availability type used for all subsequent nodes past the `first_on_demand` ones.
+ * Availability type used for all subsequent nodes past the {@code first_on_demand} ones.
*
- * Note: If `first_on_demand` is zero, this availability type will be used for the entire
+ * Note: If {@code first_on_demand} is zero, this availability type will be used for the entire
* cluster.
*/
@Generated
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
index ec8f49702..19bc6cc9e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
@@ -11,20 +11,20 @@
@Generated
public class AzureAttributes {
/**
- * Availability type used for all subsequent nodes past the `first_on_demand` ones. Note: If
- * `first_on_demand` is zero, this availability type will be used for the entire cluster.
+ * Availability type used for all subsequent nodes past the {@code first_on_demand} ones. Note: If
+ * {@code first_on_demand} is zero, this availability type will be used for the entire cluster.
*/
@JsonProperty("availability")
private AzureAvailability availability;
/**
- * The first `first_on_demand` nodes of the cluster will be placed on on-demand instances. This
- * value should be greater than 0, to make sure the cluster driver node is placed on an on-demand
- * instance. If this value is greater than or equal to the current cluster size, all nodes will be
- * placed on on-demand instances. If this value is less than the current cluster size,
- * `first_on_demand` nodes will be placed on on-demand instances and the remainder will be placed
- * on `availability` instances. Note that this value does not affect cluster size and cannot
- * currently be mutated over the lifetime of a cluster.
+ * The first {@code first_on_demand} nodes of the cluster will be placed on on-demand instances.
+ * This value should be greater than 0, to make sure the cluster driver node is placed on an
+ * on-demand instance. If this value is greater than or equal to the current cluster size, all
+ * nodes will be placed on on-demand instances. If this value is less than the current cluster
+ * size, {@code first_on_demand} nodes will be placed on on-demand instances and the remainder
+ * will be placed on {@code availability} instances. Note that this value does not affect cluster
+ * size and cannot currently be mutated over the lifetime of a cluster.
*/
@JsonProperty("first_on_demand")
private Long firstOnDemand;
@@ -37,7 +37,7 @@ public class AzureAttributes {
* The max bid price to be used for Azure spot instances. The Max price for the bid cannot be
* higher than the on-demand price of the instance. If not specified, the default value is -1,
* which specifies that the instance cannot be evicted on the basis of price, and only on the
- * basis of availability. Further, the value should > 0 or -1.
+ * basis of availability. Further, the value should > 0 or -1.
*/
@JsonProperty("spot_bid_max_price")
private Double spotBidMaxPrice;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAvailability.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAvailability.java
index 1f68f9678..26901ea4f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAvailability.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAvailability.java
@@ -5,8 +5,8 @@
import com.databricks.sdk.support.Generated;
/**
- * Availability type used for all subsequent nodes past the `first_on_demand` ones. Note: If
- * `first_on_demand` is zero, this availability type will be used for the entire cluster.
+ * Availability type used for all subsequent nodes past the {@code first_on_demand} ones. Note: If
+ * {@code first_on_demand} is zero, this availability type will be used for the entire cluster.
*/
@Generated
public enum AzureAvailability {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
index 468dabd30..d61aef257 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
@@ -42,8 +42,8 @@ public class ClusterAttributes {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -58,12 +58,13 @@ public class ClusterAttributes {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -118,8 +119,8 @@ public class ClusterAttributes {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -164,8 +165,9 @@ public class ClusterAttributes {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -173,45 +175,45 @@ public class ClusterAttributes {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map `effective_spark_version` is determined by `spark_version` (DBR release), this field
- * `use_ml_runtime`, and whether `node_type_id` is gpu node or not.
+ * {@code effective_spark_version} is determined by {@code spark_version} (DBR release), this
+ * field {@code use_ml_runtime}, and whether {@code node_type_id} is gpu node or not.
*/
@JsonProperty("use_ml_runtime")
private Boolean useMlRuntime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
index 142f7384c..0c2c84ccd 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
@@ -61,8 +61,8 @@ public class ClusterDetails {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -99,12 +99,13 @@ public class ClusterDetails {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * - Vendor: Databricks
- *
- * - Creator: - ClusterName: - ClusterId: - Name: This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -186,8 +185,8 @@ public class ClusterDetails {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -234,14 +233,14 @@ public class ClusterDetails {
private String nodeTypeId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
@@ -260,8 +259,9 @@ public class ClusterDetails {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -269,45 +269,45 @@ public class ClusterDetails {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map `effective_spark_version` is determined by `spark_version` (DBR release), this field
- * `use_ml_runtime`, and whether `node_type_id` is gpu node or not.
+ * {@code effective_spark_version} is determined by {@code spark_version} (DBR release), this
+ * field {@code use_ml_runtime}, and whether {@code node_type_id} is gpu node or not.
*/
@JsonProperty("use_ml_runtime")
private Boolean useMlRuntime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterLogConf.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterLogConf.java
index e22885f56..8ef24996d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterLogConf.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterLogConf.java
@@ -11,24 +11,24 @@
@Generated
public class ClusterLogConf {
/**
- * destination needs to be provided. e.g. `{ "dbfs" : { "destination" : "dbfs:/home/cluster_log" }
- * }`
+ * destination needs to be provided. e.g. {@code { "dbfs" : { "destination" :
+ * "dbfs:/home/cluster_log" } }}
*/
@JsonProperty("dbfs")
private DbfsStorageInfo dbfs;
/**
- * destination and either the region or endpoint need to be provided. e.g. `{ "s3": {
- * "destination" : "s3://cluster_log_bucket/prefix", "region" : "us-west-2" } }` Cluster iam role
- * is used to access s3, please make sure the cluster iam role in `instance_profile_arn` has
+ * destination and either the region or endpoint need to be provided. e.g. {@code { "s3": {
+ * "destination" : "s3://cluster_log_bucket/prefix", "region" : "us-west-2" } }} Cluster iam role
+ * is used to access s3, please make sure the cluster iam role in {@code instance_profile_arn} has
* permission to write data to the s3 destination.
*/
@JsonProperty("s3")
private S3StorageInfo s3;
/**
- * destination needs to be provided, e.g. `{ "volumes": { "destination":
- * "/Volumes/catalog/schema/volume/cluster_log" } }`
+ * destination needs to be provided, e.g. {@code { "volumes": { "destination":
+ * "/Volumes/catalog/schema/volume/cluster_log" } }}
*/
@JsonProperty("volumes")
private VolumesStorageInfo volumes;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesAPI.java
index b05b19567..2901f5262 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesAPI.java
@@ -12,18 +12,28 @@
* rules. These rules specify which attributes or attribute values can be used during cluster
* creation. Cluster policies have ACLs that limit their use to specific users and groups.
*
- * With cluster policies, you can: - Auto-install cluster libraries on the next restart by
- * listing them in the policy's "libraries" field (Public Preview). - Limit users to creating
- * clusters with the prescribed settings. - Simplify the user interface, enabling more users to
- * create clusters, by fixing and hiding some fields. - Manage costs by setting limits on attributes
- * that impact the hourly rate.
+ * With cluster policies, you can:
+ *
+ * Cluster policy permissions limit which policies a user can select in the Policy drop-down when
- * the user creates a cluster: - A user who has unrestricted cluster create permission can select
- * the Unrestricted policy and create fully-configurable clusters. - A user who has both
- * unrestricted cluster create permission and access to cluster policies can select the Unrestricted
- * policy and policies they have access to. - A user that has access to only cluster policies, can
- * select the policies they have access to.
+ * the user creates a cluster:
+ *
+ * If no policies exist in the workspace, the Policy drop-down doesn't appear. Only admin users
* can create, edit, and delete policies. Admin users also have access to all policies.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesService.java
index a8ef9fa37..b1666c213 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterPoliciesService.java
@@ -8,18 +8,28 @@
* rules. These rules specify which attributes or attribute values can be used during cluster
* creation. Cluster policies have ACLs that limit their use to specific users and groups.
*
- * With cluster policies, you can: - Auto-install cluster libraries on the next restart by
- * listing them in the policy's "libraries" field (Public Preview). - Limit users to creating
- * clusters with the prescribed settings. - Simplify the user interface, enabling more users to
- * create clusters, by fixing and hiding some fields. - Manage costs by setting limits on attributes
- * that impact the hourly rate.
+ * With cluster policies, you can:
+ *
+ * Cluster policy permissions limit which policies a user can select in the Policy drop-down when
- * the user creates a cluster: - A user who has unrestricted cluster create permission can select
- * the Unrestricted policy and create fully-configurable clusters. - A user who has both
- * unrestricted cluster create permission and access to cluster policies can select the Unrestricted
- * policy and policies they have access to. - A user that has access to only cluster policies, can
- * select the policies they have access to.
+ * the user creates a cluster:
+ *
+ * If no policies exist in the workspace, the Policy drop-down doesn't appear. Only admin users
* can create, edit, and delete policies. Admin users also have access to all policies.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSize.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSize.java
index 6f3b6efdf..2a67810ce 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSize.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSize.java
@@ -17,14 +17,14 @@ public class ClusterSize {
private AutoScale autoscale;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
index 70344f42a..5c7fc5431 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
@@ -56,8 +56,8 @@ public class ClusterSpec {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -72,12 +72,13 @@ public class ClusterSpec {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -132,8 +133,8 @@ public class ClusterSpec {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -165,14 +166,14 @@ public class ClusterSpec {
private String nodeTypeId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
@@ -191,8 +192,9 @@ public class ClusterSpec {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -200,45 +202,45 @@ public class ClusterSpec {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map `effective_spark_version` is determined by `spark_version` (DBR release), this field
- * `use_ml_runtime`, and whether `node_type_id` is gpu node or not.
+ * {@code effective_spark_version} is determined by {@code spark_version} (DBR release), this
+ * field {@code use_ml_runtime}, and whether {@code node_type_id} is gpu node or not.
*/
@JsonProperty("use_ml_runtime")
private Boolean useMlRuntime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClustersAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClustersAPI.java
index 26a9c8dd7..991a49727 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClustersAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClustersAPI.java
@@ -145,7 +145,7 @@ public ClusterDetails waitGetClusterTerminated(
/**
* Change the owner of the cluster. You must be an admin and the cluster must be terminated to
* perform this operation. The service principal application ID can be supplied as an argument to
- * `owner_username`.
+ * {@code owner_username}.
*/
public void changeOwner(ChangeClusterOwner request) {
impl.changeOwner(request);
@@ -153,19 +153,18 @@ public void changeOwner(ChangeClusterOwner request) {
/**
* Creates a new Spark cluster. This method will acquire new instances from the cloud provider if
- * necessary. This method is asynchronous; the returned ``cluster_id`` can be used to poll the
- * cluster status. When this method returns, the cluster will be in a ``PENDING`` state. The
- * cluster will be usable once it enters a ``RUNNING`` state. Note: Databricks may not be able to
- * acquire some of the requested nodes, due to cloud provider limitations (account limits, spot
+ * necessary. This method is asynchronous; the returned {@code cluster_id} can be used to poll the
+ * cluster status. When this method returns, the cluster will be in a {@code PENDING} state. The
+ * cluster will be usable once it enters a {@code RUNNING} state. Note: Databricks may not be able
+ * to acquire some of the requested nodes, due to cloud provider limitations (account limits, spot
* price, etc.) or transient network issues.
*
* If Databricks acquires at least 85% of the requested on-demand nodes, cluster creation will
* succeed. Otherwise the cluster will terminate with an informative error message.
*
* Rather than authoring the cluster's JSON definition from scratch, Databricks recommends
- * filling out the [create compute UI] and then copying the generated JSON definition from the UI.
- *
- * [create compute UI]: https://docs.databricks.com/compute/configure.html
+ * filling out the create compute
+ * UI and then copying the generated JSON definition from the UI.
*/
public Wait If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new
- * attributes can take effect.
+ * If a cluster is updated while in a {@code RUNNING} state, it will be restarted so that the
+ * new attributes can take effect.
*
- * If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next
- * time it is started using the `clusters/start` API, the new attributes will take effect. Any
- * attempt to update a cluster in any other state will be rejected with an `INVALID_STATE` error
- * code.
+ * If a cluster is updated while in a {@code TERMINATED} state, it will remain {@code
+ * TERMINATED}. The next time it is started using the {@code clusters/start} API, the new
+ * attributes will take effect. Any attempt to update a cluster in any other state will be
+ * rejected with an {@code INVALID_STATE} error code.
*
* Clusters created by the Databricks Jobs service cannot be edited.
*/
@@ -313,7 +312,7 @@ public void pin(PinCluster request) {
/**
* Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in
- * a `RUNNING` state.
+ * a {@code RUNNING} state.
*/
public Wait If Databricks acquires at least 85% of the requested on-demand nodes, cluster creation will
* succeed. Otherwise the cluster will terminate with an informative error message.
*
* Rather than authoring the cluster's JSON definition from scratch, Databricks recommends
- * filling out the [create compute UI] and then copying the generated JSON definition from the UI.
- *
- * [create compute UI]: https://docs.databricks.com/compute/configure.html
+ * filling out the create compute
+ * UI and then copying the generated JSON definition from the UI.
*/
CreateClusterResponse create(CreateCluster createCluster);
/**
* Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once
- * the termination has completed, the cluster will be in a `TERMINATED` state. If the cluster is
- * already in a `TERMINATING` or `TERMINATED` state, nothing will happen.
+ * the termination has completed, the cluster will be in a {@code TERMINATED} state. If the
+ * cluster is already in a {@code TERMINATING} or {@code TERMINATED} state, nothing will happen.
*/
void delete(DeleteCluster deleteCluster);
/**
* Updates the configuration of a cluster to match the provided attributes and size. A cluster can
- * be updated if it is in a `RUNNING` or `TERMINATED` state.
+ * be updated if it is in a {@code RUNNING} or {@code TERMINATED} state.
*
- * If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new
- * attributes can take effect.
+ * If a cluster is updated while in a {@code RUNNING} state, it will be restarted so that the
+ * new attributes can take effect.
*
- * If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next
- * time it is started using the `clusters/start` API, the new attributes will take effect. Any
- * attempt to update a cluster in any other state will be rejected with an `INVALID_STATE` error
- * code.
+ * If a cluster is updated while in a {@code TERMINATED} state, it will remain {@code
+ * TERMINATED}. The next time it is started using the {@code clusters/start} API, the new
+ * attributes will take effect. Any attempt to update a cluster in any other state will be
+ * rejected with an {@code INVALID_STATE} error code.
*
* Clusters created by the Databricks Jobs service cannot be edited.
*/
@@ -135,13 +134,13 @@ GetClusterPermissionLevelsResponse getPermissionLevels(
/**
* Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in
- * a `RUNNING` state.
+ * a {@code RUNNING} state.
*/
void resize(ResizeCluster resizeCluster);
/**
- * Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a `RUNNING`
- * state, nothing will happen.
+ * Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a {@code
+ * RUNNING} state, nothing will happen.
*/
void restart(RestartCluster restartCluster);
@@ -157,11 +156,17 @@ GetClusterPermissionLevelsResponse getPermissionLevels(
GetSparkVersionsResponse sparkVersions();
/**
- * Starts a terminated Spark cluster with the supplied ID. This works similar to `createCluster`
- * except: - The previous cluster id and attributes are preserved. - The cluster starts with the
- * last specified cluster size. - If the previous cluster was an autoscaling cluster, the current
- * cluster starts with the minimum number of nodes. - If the cluster is not currently in a
- * ``TERMINATED`` state, nothing will happen. - Clusters launched to run a job cannot be started.
+ * Starts a terminated Spark cluster with the supplied ID. This works similar to {@code
+ * createCluster} except:
+ *
+ * The command ID is obtained from a prior successful call to __execute__.
+ * The command ID is obtained from a prior successful call to execute.
*/
public Wait The command ID is obtained from a prior successful call to __execute__.
+ * The command ID is obtained from a prior successful call to execute.
*/
public CommandStatusResponse commandStatus(CommandStatusRequest request) {
return impl.commandStatus(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java
index a28c23aaf..93553411d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java
@@ -16,14 +16,14 @@ public interface CommandExecutionService {
/**
* Cancels a currently running command within an execution context.
*
- * The command ID is obtained from a prior successful call to __execute__.
+ * The command ID is obtained from a prior successful call to execute.
*/
void cancel(CancelCommand cancelCommand);
/**
* Gets the status of and, if available, the results from a currently executing command.
*
- * The command ID is obtained from a prior successful call to __execute__.
+ * The command ID is obtained from a prior successful call to execute.
*/
CommandStatusResponse commandStatus(CommandStatusRequest commandStatusRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
index f224a7630..47f730f10 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
@@ -59,8 +59,8 @@ public class CreateCluster {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -75,12 +75,13 @@ public class CreateCluster {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -135,8 +136,8 @@ public class CreateCluster {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -168,14 +169,14 @@ public class CreateCluster {
private String nodeTypeId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
@@ -194,8 +195,9 @@ public class CreateCluster {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -203,45 +205,45 @@ public class CreateCluster {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map `effective_spark_version` is determined by `spark_version` (DBR release), this field
- * `use_ml_runtime`, and whether `node_type_id` is gpu node or not.
+ * {@code effective_spark_version} is determined by {@code spark_version} (DBR release), this
+ * field {@code use_ml_runtime}, and whether {@code node_type_id} is gpu node or not.
*/
@JsonProperty("use_ml_runtime")
private Boolean useMlRuntime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateInstancePool.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateInstancePool.java
index 9365e599a..50baaaf7e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateInstancePool.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateInstancePool.java
@@ -27,9 +27,11 @@ public class CreateInstancePool {
/**
* Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS instances
- * and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
+ * [Databricks Cluster Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
+ * Policy definition document expressed in Databricks
+ * Cluster Policy Definition Language.
*/
@JsonProperty("definition")
private String definition;
@@ -45,14 +44,13 @@ public class CreatePolicy {
private String name;
/**
- * Policy definition JSON document expressed in [Databricks Policy Definition Language]. The JSON
- * document must be passed as a string and cannot be embedded in the requests.
+ * Policy definition JSON document expressed in Databricks
+ * Policy Definition Language. The JSON document must be passed as a string and cannot be
+ * embedded in the requests.
*
* You can use this to customize the policy definition inherited from the policy family. Policy
* rules specified here are merged into the inherited policy definition.
- *
- * [Databricks Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
*/
@JsonProperty("policy_family_definition_overrides")
private String policyFamilyDefinitionOverrides;
@@ -61,8 +59,8 @@ public class CreatePolicy {
* ID of the policy family. The cluster policy's policy definition inherits the policy family's
* policy definition.
*
- * Cannot be used with `definition`. Use `policy_family_definition_overrides` instead to
- * customize the policy definition.
+ * Cannot be used with {@code definition}. Use {@code policy_family_definition_overrides}
+ * instead to customize the policy definition.
*/
@JsonProperty("policy_family_id")
private String policyFamilyId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CustomPolicyTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CustomPolicyTag.java
index 57bd01c54..a2b0dfc9b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CustomPolicyTag.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CustomPolicyTag.java
@@ -10,9 +10,13 @@
@Generated
public class CustomPolicyTag {
/**
- * The key of the tag. - Must be unique among all custom tags of the same policy - Cannot be
- * “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are
- * preserved.
+ * The key of the tag.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending
- * on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be
- * shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s
- * data and credentials. Most data governance features are supported in this mode. But programming
- * languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure
- * cluster that can only be exclusively used by a single user specified in `single_user_name`. Most
- * programming languages, cluster features and data governance features are available in this mode.
+ * The following modes are legacy aliases for the above modes:
*
- * * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
- * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ * The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
* for future Databricks Runtime versions:
*
- * * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
- * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
- * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
- * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that
- * doesn’t have UC nor passthrough enabled.
+ * If disks are attached, Databricks will configure Spark to use only the disks for scratch
* storage, because heterogenously sized scratch devices can lead to inefficient disk utilization.
* If no disks are attached, Databricks will configure Spark to use instance store disks.
*
- * Note: If disks are specified, then the Spark configuration `spark.local.dir` will be
+ * Note: If disks are specified, then the Spark configuration {@code spark.local.dir} will be
* overridden.
*
- * Disks will be mounted at: - For AWS: `/ebs0`, `/ebs1`, and etc. - For Azure:
- * `/remote_volume0`, `/remote_volume1`, and etc.
+ * Disks will be mounted at:
+ *
+ * For AWS: - General Purpose SSD: 100 - 4096 GiB - Throughput Optimized HDD: 500 - 4096 GiB
+ * For AWS:
+ *
+ * For Azure:
*
- * For Azure: - Premium LRS (SSD): 1 - 1023 GiB - Standard LRS (HDD): 1- 1023 GiB
+ * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -132,8 +133,8 @@ public class EditCluster {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -165,14 +166,14 @@ public class EditCluster {
private String nodeTypeId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
@@ -191,8 +192,9 @@ public class EditCluster {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -200,45 +202,45 @@ public class EditCluster {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map `effective_spark_version` is determined by `spark_version` (DBR release), this field
- * `use_ml_runtime`, and whether `node_type_id` is gpu node or not.
+ * {@code effective_spark_version} is determined by {@code spark_version} (DBR release), this
+ * field {@code use_ml_runtime}, and whether {@code node_type_id} is gpu node or not.
*/
@JsonProperty("use_ml_runtime")
private Boolean useMlRuntime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditInstancePool.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditInstancePool.java
index b5cd70eb2..22fcda233 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditInstancePool.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditInstancePool.java
@@ -12,9 +12,11 @@
public class EditInstancePool {
/**
* Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS instances
- * and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
+ * [Databricks Cluster Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
+ * Policy definition document expressed in Databricks
+ * Cluster Policy Definition Language.
*/
@JsonProperty("definition")
private String definition;
@@ -45,14 +44,13 @@ public class EditPolicy {
private String name;
/**
- * Policy definition JSON document expressed in [Databricks Policy Definition Language]. The JSON
- * document must be passed as a string and cannot be embedded in the requests.
+ * Policy definition JSON document expressed in Databricks
+ * Policy Definition Language. The JSON document must be passed as a string and cannot be
+ * embedded in the requests.
*
* You can use this to customize the policy definition inherited from the policy family. Policy
* rules specified here are merged into the inherited policy definition.
- *
- * [Databricks Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
*/
@JsonProperty("policy_family_definition_overrides")
private String policyFamilyDefinitionOverrides;
@@ -61,8 +59,8 @@ public class EditPolicy {
* ID of the policy family. The cluster policy's policy definition inherits the policy family's
* policy definition.
*
- * Cannot be used with `definition`. Use `policy_family_definition_overrides` instead to
- * customize the policy definition.
+ * Cannot be used with {@code definition}. Use {@code policy_family_definition_overrides}
+ * instead to customize the policy definition.
*/
@JsonProperty("policy_family_id")
private String policyFamilyId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java
index 4c9b5894d..205286ca8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java
@@ -18,19 +18,19 @@ public class Environment {
/**
* The base environment this environment is built on top of. A base environment defines the
* environment version and a list of dependencies for serverless compute. The value can be a file
- * path to a custom `env.yaml` file (e.g., `/Workspace/path/to/env.yaml`). Support for a
- * Databricks-provided base environment ID (e.g., `workspace-base-environments/databricks_ai_v4`)
- * and workspace base environment ID (e.g.,
- * `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta. Either
- * `environment_version` or `base_environment` can be provided. For more information about
- * Databricks-provided base environments, see the [list workspace base
- * environments](:method:Environments/ListWorkspaceBaseEnvironments) API. For more information,
- * see
+ * path to a custom {@code env.yaml} file (e.g., {@code /Workspace/path/to/env.yaml}). Support for
+ * a Databricks-provided base environment ID (e.g., {@code
+ * workspace-base-environments/databricks_ai_v4}) and workspace base environment ID (e.g., {@code
+ * workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7}) is in Beta. Either
+ * {@code environment_version} or {@code base_environment} can be provided. For more information
+ * about Databricks-provided base environments, see the list workspace base environments
+ * API. For more information, see
*/
@JsonProperty("base_environment")
private String baseEnvironment;
- /** Use `environment_version` instead. */
+ /** Use {@code environment_version} instead. */
@JsonProperty("client")
private String client;
@@ -45,16 +45,16 @@ public class Environment {
private Collection [GCP documentation]:
- * https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds
+ * attached. Each local SSD is 375GB in size. Refer to GCP
+ * documentation for the supported number of local SSDs for each instance type.
*/
@JsonProperty("local_ssd_count")
private Long localSsdCount;
@@ -70,10 +68,15 @@ public class GcpAttributes {
/**
* Identifier for the availability zone in which the cluster resides. This can be one of the
- * following: - "HA" => High availability, spread nodes across availability zones for a Databricks
- * deployment region [default]. - "AUTO" => Databricks picks an availability zone to schedule the
- * cluster on. - A GCP availability zone => Pick One of the available zones for (machine type +
- * region) from https://cloud.google.com/compute/docs/regions-zones.
+ * following:
+ *
+ * - Currently, Databricks allows at most 45 custom tags
+ * - Vendor: Databricks
- *
- * - InstancePoolCreator: - InstancePoolName: - InstancePoolId: **Important:** Existing clusters must be restarted to pick up any changes made to global init
- * scripts. Global init scripts are run in order. If the init script returns with a bad exit code,
- * the Apache Spark container fails to launch and init scripts with later position are skipped. If
- * enough containers fail, the entire cluster fails with a `GLOBAL_INIT_SCRIPT_FAILURE` error code.
+ * Important: Existing clusters must be restarted to pick up any changes made to global
+ * init scripts. Global init scripts are run in order. If the init script returns with a bad exit
+ * code, the Apache Spark container fails to launch and init scripts with later position are
+ * skipped. If enough containers fail, the entire cluster fails with a {@code
+ * GLOBAL_INIT_SCRIPT_FAILURE} error code.
*/
@Generated
public class GlobalInitScriptsAPI {
@@ -57,8 +58,8 @@ public GlobalInitScriptDetailsWithContent get(GetGlobalInitScriptRequest request
/**
* Get a list of all global init scripts for this workspace. This returns all properties for each
- * script but **not** the script contents. To retrieve the contents of a script, use the [get a
- * global init script](:method:globalinitscripts/get) operation.
+ * script but not the script contents. To retrieve the contents of a script, use the get a global init script operation.
*/
public Iterable **Important:** Existing clusters must be restarted to pick up any changes made to global init
- * scripts. Global init scripts are run in order. If the init script returns with a bad exit code,
- * the Apache Spark container fails to launch and init scripts with later position are skipped. If
- * enough containers fail, the entire cluster fails with a `GLOBAL_INIT_SCRIPT_FAILURE` error code.
+ * Important: Existing clusters must be restarted to pick up any changes made to global
+ * init scripts. Global init scripts are run in order. If the init script returns with a bad exit
+ * code, the Apache Spark container fails to launch and init scripts with later position are
+ * skipped. If enough containers fail, the entire cluster fails with a {@code
+ * GLOBAL_INIT_SCRIPT_FAILURE} error code.
*
* This is the high-level interface, that contains generated methods.
*
@@ -29,8 +30,8 @@ public interface GlobalInitScriptsService {
/**
* Get a list of all global init scripts for this workspace. This returns all properties for each
- * script but **not** the script contents. To retrieve the contents of a script, use the [get a
- * global init script](:method:globalinitscripts/get) operation.
+ * script but not the script contents. To retrieve the contents of a script, use the get a global init script operation.
*/
ListGlobalInitScriptsResponse list();
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InitScriptInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InitScriptInfo.java
index 9a696988e..da0531704 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InitScriptInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InitScriptInfo.java
@@ -11,51 +11,52 @@
@Generated
public class InitScriptInfo {
/**
- * destination needs to be provided, e.g.
- * `abfss:// - Currently, Databricks allows at most 45 custom tags
+ * - Vendor: Databricks
- *
- * - InstancePoolCreator: - InstancePoolName: - InstancePoolId: [GCP documentation]:
- * https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds
+ * local SSD is 375GB in size. Refer to GCP
+ * documentation for the supported number of local SSDs for each instance type.
*/
@JsonProperty("local_ssd_count")
private Long localSsdCount;
@@ -32,10 +30,14 @@ public class InstancePoolGcpAttributes {
* workspace resides in the "us-east1" region. This is an optional field at instance pool
* creation, and if not specified, a default zone will be used.
*
- * This field can be one of the following: - "HA" => High availability, spread nodes across
- * availability zones for a Databricks deployment region - A GCP availability zone => Pick One of
- * the available zones for (machine type + region) from
- * https://cloud.google.com/compute/docs/regions-zones (e.g. "us-west1-a").
+ * This field can be one of the following:
+ *
+ * If empty, Databricks picks an availability zone to schedule the cluster on.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolState.java
index b89994ca2..b6b9f6da6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolState.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolState.java
@@ -7,8 +7,12 @@
/**
* The state of a Cluster. The current allowable state transitions are as follows:
*
- * - ``ACTIVE`` -> ``STOPPED`` - ``ACTIVE`` -> ``DELETED`` - ``STOPPED`` -> ``ACTIVE`` -
- * ``STOPPED`` -> ``DELETED``
+ * Otherwise, this field is optional.
- *
- * [Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html
*/
@JsonProperty("iam_role_arn")
private String iamRoleArn;
@@ -29,7 +28,7 @@ public class InstanceProfile {
* Boolean flag indicating whether the instance profile should only be used in credential
* passthrough scenarios. If true, it means the instance profile contains an meta IAM role which
* could assume a wide range of roles. Therefore it should always be used with authorization. This
- * field is optional, the default value is `false`.
+ * field is optional, the default value is {@code false}.
*/
@JsonProperty("is_meta_instance_profile")
private Boolean isMetaInstanceProfile;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesAPI.java
index f6582bbba..b37e8e049 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesAPI.java
@@ -9,11 +9,9 @@
/**
* The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
- * launch clusters with. Regular users can list the instance profiles available to them. See [Secure
- * access to S3 buckets] using instance profiles for more information.
- *
- * [Secure access to S3 buckets]:
- * https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html
+ * launch clusters with. Regular users can list the instance profiles available to them. See Secure
+ * access to S3 buckets using instance profiles for more information.
*/
@Generated
public class InstanceProfilesAPI {
@@ -45,16 +43,19 @@ public void add(AddInstanceProfile request) {
* The only supported field to change is the optional IAM role ARN associated with the instance
* profile. It is required to specify the IAM role ARN if both of the following are true:
*
- * * Your role name and instance profile name do not match. The name is the part after the last
- * slash in each ARN. * You want to use the instance profile with [Databricks SQL Serverless].
+ * To understand where these fields are in the AWS console, see [Enable serverless SQL
- * warehouses].
+ * To understand where these fields are in the AWS console, see Enable serverless SQL
+ * warehouses.
*
* This API is only available to admin users.
- *
- * [Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html [Enable
- * serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html
*/
public void edit(InstanceProfile request) {
impl.edit(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesService.java
index e5b4d304f..872cb9b8b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfilesService.java
@@ -5,11 +5,9 @@
/**
* The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
- * launch clusters with. Regular users can list the instance profiles available to them. See [Secure
- * access to S3 buckets] using instance profiles for more information.
- *
- * [Secure access to S3 buckets]:
- * https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html
+ * launch clusters with. Regular users can list the instance profiles available to them. See Secure
+ * access to S3 buckets using instance profiles for more information.
*
* This is the high-level interface, that contains generated methods.
*
@@ -29,16 +27,19 @@ public interface InstanceProfilesService {
* The only supported field to change is the optional IAM role ARN associated with the instance
* profile. It is required to specify the IAM role ARN if both of the following are true:
*
- * * Your role name and instance profile name do not match. The name is the part after the last
- * slash in each ARN. * You want to use the instance profile with [Databricks SQL Serverless].
+ * To understand where these fields are in the AWS console, see [Enable serverless SQL
- * warehouses].
+ * To understand where these fields are in the AWS console, see Enable serverless SQL
+ * warehouses.
*
* This API is only available to admin users.
- *
- * [Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html [Enable
- * serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html
*/
void edit(InstanceProfile instanceProfile);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Kind.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Kind.java
index ce7ff97e2..0d61fcac6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Kind.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Kind.java
@@ -7,15 +7,18 @@
/**
* The kind of compute described by this compute specification.
*
- * Depending on `kind`, different validations and default values will be applied.
+ * Depending on {@code kind}, different validations and default values will be applied.
*
- * Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no
- * specified `kind` do not. * [is_single_node](/api/workspace/clusters/create#is_single_node) *
- * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)
+ * Clusters with {@code kind = CLASSIC_PREVIEW} support the following fields, whereas clusters
+ * with no specified {@code kind} do not.
*
- * By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html
+ * By using the simple form,
+ * your clusters are automatically using {@code kind = CLASSIC_PREVIEW}.
*/
@Generated
public enum Kind {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
index 488e06abb..5087f70b5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
@@ -58,10 +58,14 @@ public Iterable Maven dependency exclusions:
* https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Policy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Policy.java
index e81025059..5dd5a7c73 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Policy.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Policy.java
@@ -23,10 +23,9 @@ public class Policy {
private String creatorUserName;
/**
- * Policy definition document expressed in [Databricks Cluster Policy Definition Language].
- *
- * [Databricks Cluster Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
+ * Policy definition document expressed in Databricks
+ * Cluster Policy Definition Language.
*/
@JsonProperty("definition")
private String definition;
@@ -64,14 +63,13 @@ public class Policy {
private String name;
/**
- * Policy definition JSON document expressed in [Databricks Policy Definition Language]. The JSON
- * document must be passed as a string and cannot be embedded in the requests.
+ * Policy definition JSON document expressed in Databricks
+ * Policy Definition Language. The JSON document must be passed as a string and cannot be
+ * embedded in the requests.
*
* You can use this to customize the policy definition inherited from the policy family. Policy
* rules specified here are merged into the inherited policy definition.
- *
- * [Databricks Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
*/
@JsonProperty("policy_family_definition_overrides")
private String policyFamilyDefinitionOverrides;
@@ -80,8 +78,8 @@ public class Policy {
* ID of the policy family. The cluster policy's policy definition inherits the policy family's
* policy definition.
*
- * Cannot be used with `definition`. Use `policy_family_definition_overrides` instead to
- * customize the policy definition.
+ * Cannot be used with {@code definition}. Use {@code policy_family_definition_overrides}
+ * instead to customize the policy definition.
*/
@JsonProperty("policy_family_id")
private String policyFamilyId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersAPI.java
index 9933b1997..a9ad20963 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersAPI.java
@@ -37,13 +37,13 @@ public PolicyComplianceForClustersAPI(PolicyComplianceForClustersService mock) {
/**
* Updates a cluster to be compliant with the current version of its policy. A cluster can be
- * updated if it is in a `RUNNING` or `TERMINATED` state.
+ * updated if it is in a {@code RUNNING} or {@code TERMINATED} state.
*
- * If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new
- * attributes can take effect.
+ * If a cluster is updated while in a {@code RUNNING} state, it will be restarted so that the
+ * new attributes can take effect.
*
- * If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next
- * time the cluster is started, the new attributes will take effect.
+ * If a cluster is updated while in a {@code TERMINATED} state, it will remain {@code
+ * TERMINATED}. The next time the cluster is started, the new attributes will take effect.
*
* Clusters created by the Databricks Jobs, SDP, or Models services cannot be enforced by this
* API. Instead, use the "Enforce job policy compliance" API to enforce policy compliance on jobs.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersService.java
index cd613370b..7e3752c92 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyComplianceForClustersService.java
@@ -23,13 +23,13 @@
public interface PolicyComplianceForClustersService {
/**
* Updates a cluster to be compliant with the current version of its policy. A cluster can be
- * updated if it is in a `RUNNING` or `TERMINATED` state.
+ * updated if it is in a {@code RUNNING} or {@code TERMINATED} state.
*
- * If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new
- * attributes can take effect.
+ * If a cluster is updated while in a {@code RUNNING} state, it will be restarted so that the
+ * new attributes can take effect.
*
- * If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next
- * time the cluster is started, the new attributes will take effect.
+ * If a cluster is updated while in a {@code TERMINATED} state, it will remain {@code
+ * TERMINATED}. The next time the cluster is started, the new attributes will take effect.
*
* Clusters created by the Databricks Jobs, SDP, or Models services cannot be enforced by this
* API. Instead, use the "Enforce job policy compliance" API to enforce policy compliance on jobs.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyFamily.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyFamily.java
index 8b1cc84cb..53c236916 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyFamily.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PolicyFamily.java
@@ -10,10 +10,9 @@
@Generated
public class PolicyFamily {
/**
- * Policy definition document expressed in [Databricks Cluster Policy Definition Language].
- *
- * [Databricks Cluster Policy Definition Language]:
- * https://docs.databricks.com/administration-guide/clusters/policy-definition.html
+ * Policy definition document expressed in Databricks
+ * Cluster Policy Definition Language.
*/
@JsonProperty("definition")
private String definition;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ResizeCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ResizeCluster.java
index 5af6421b9..63f37bf3d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ResizeCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ResizeCluster.java
@@ -21,14 +21,14 @@ public class ResizeCluster {
private String clusterId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java
index 4ea0454c8..282399cdd 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java
@@ -22,11 +22,13 @@ public class Results {
/**
* The image data in one of the following formats:
*
- * 1. A Data URL with base64-encoded image data: `data:image/{type};base64,{base64-data}`.
- * Example: `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...`
- *
- * 2. A FileStore file path for large images: `/plots/{filename}.png`. Example:
- * `/plots/b6a7ad70-fb2c-4353-8aed-3f1e015174a4.png`
+ * - `PENDING` -> `RUNNING` - `PENDING` -> `TERMINATING` - `RUNNING` -> `RESIZING` - `RUNNING` ->
- * `RESTARTING` - `RUNNING` -> `TERMINATING` - `RESTARTING` -> `RUNNING` - `RESTARTING` ->
- * `TERMINATING` - `RESIZING` -> `RUNNING` - `RESIZING` -> `TERMINATING` - `TERMINATING` ->
- * `TERMINATED`
+ * 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.
+ * spaces). The field path is relative to the resource object, using a dot ({@code .}) to navigate
+ * sub-fields (e.g., {@code 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.
+ * A field mask of {@code *} indicates full replacement. It’s recommended to always explicitly
+ * list the fields being updated and avoid using {@code *} wildcards, as it can lead to unintended
+ * results if the API changes in the future.
*/
@JsonProperty("update_mask")
private String updateMask;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
index a981f6779..05549dcbb 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
@@ -45,8 +45,8 @@ public class UpdateClusterResource {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -61,12 +61,13 @@ public class UpdateClusterResource {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- * - Currently, Databricks allows at most 45 custom tags
- *
- * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster
- * tags
+ * This field, along with node_type_id, should not be set if virtual_cluster_size is set. If
* both driver_node_type_id, node_type_id, and virtual_cluster_size are specified,
@@ -121,8 +122,8 @@ public class UpdateClusterResource {
/**
* The configuration for storing init scripts. Any number of destinations can be specified. The
- * scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified,
- * init script logs are sent to ` When set to true, Databricks will automatically set single node related `custom_tags`,
- * `spark_conf`, and `num_workers`
+ * When set to true, Databricks will automatically set single node related {@code custom_tags},
+ * {@code spark_conf}, and {@code num_workers}
*/
@JsonProperty("is_single_node")
private Boolean isSingleNode;
@@ -154,14 +155,14 @@ public class UpdateClusterResource {
private String nodeTypeId;
/**
- * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and
- * `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver and {@code
+ * num_workers} Executors for a total of {@code num_workers} + 1 Spark nodes.
*
* Note: When reading the properties of a cluster, this field reflects the desired number of
* workers rather than the actual current number of workers. For instance, if a cluster is resized
* from 5 to 10 workers, this field will immediately be updated to reflect the target size of 10
- * workers, whereas the workers listed in `spark_info` will gradually increase from 5 to 10 as the
- * new nodes are provisioned.
+ * workers, whereas the workers listed in {@code spark_info} will gradually increase from 5 to 10
+ * as the new nodes are provisioned.
*/
@JsonProperty("num_workers")
private Long numWorkers;
@@ -180,8 +181,9 @@ public class UpdateClusterResource {
/**
* Determines the cluster's runtime engine, either standard or Photon.
*
- * This field is not compatible with legacy `spark_version` values that contain `-photon-`.
- * Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.
+ * This field is not compatible with legacy {@code spark_version} values that contain {@code
+ * -photon-}. Remove {@code -photon-} from the {@code spark_version} and set {@code
+ * runtime_engine} to {@code PHOTON}.
*
* If left unspecified, the runtime engine defaults to standard unless the spark_version
* contains -photon-, in which case Photon will be used.
@@ -189,45 +191,45 @@ public class UpdateClusterResource {
@JsonProperty("runtime_engine")
private RuntimeEngine runtimeEngine;
- /** Single user name if data_security_mode is `SINGLE_USER` */
+ /** Single user name if data_security_mode is {@code SINGLE_USER} */
@JsonProperty("single_user_name")
private String singleUserName;
/**
* An object containing a set of optional, user-specified Spark configuration key-value pairs.
- * Users can also pass in a string of extra JVM options to the driver and the executors via
- * `spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.
+ * Users can also pass in a string of extra JVM options to the driver and the executors via {@code
+ * spark.driver.extraJavaOptions} and {@code spark.executor.extraJavaOptions} respectively.
*/
@JsonProperty("spark_conf")
private Map In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
- * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all default
- * databricks managed environmental variables are included as well.
+ * In order to specify an additional set of {@code SPARK_DAEMON_JAVA_OPTS}, we recommend
+ * appending them to {@code $SPARK_DAEMON_JAVA_OPTS} as shown in the example below. This ensures
+ * that all default databricks managed environmental variables are included as well.
*
- * Example Spark environment variables: `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS":
- * "/local_disk0"}` or `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS
- * -Dspark.shuffle.service.enabled=true"}`
+ * Example Spark environment variables: {@code {"SPARK_WORKER_MEMORY": "28000m",
+ * "SPARK_LOCAL_DIRS": "/local_disk0"}} or {@code {"SPARK_DAEMON_JAVA_OPTS":
+ * "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}}
*/
@JsonProperty("spark_env_vars")
private Map
+ *
*
- *
+ *
*/
public LogDeliveryAPI logDelivery() {
return logDeliveryAPI;
@@ -441,11 +484,9 @@ public AccountMetastoresAPI metastores() {
* serverless compute resources. This API provides stable subnets for your workspace so that you
* can configure your firewalls on your Azure Storage accounts to allow access from Databricks.
* You can also use the API to provision private endpoints for Databricks to privately connect
- * serverless compute resources to your Azure resources using Azure Private Link. See [configure
- * serverless secure connectivity].
- *
- *
+ *
+ *
+ *
+ *
*
- * {@code
+ * issuer: "https://token.actions.githubusercontent.com"
+ * audiences: ["https://github.com/my-github-org"]
+ * subject: "repo:my-github-org/my-repo:environment:prod"
+ * }
*
*
*
*
+ * {
+ * "iss": "https://token.actions.githubusercontent.com",
+ * "aud": "https://github.com/my-github-org",
+ * "sub": "repo:my-github-org/my-repo:environment:prod"
+ * }
+ *
+ *
*
*
+ *
*
*
+ *
*
- *
+ *
*
*
+ *
*/
public PermissionsAPI permissions() {
return permissionsAPI;
@@ -1377,7 +1397,8 @@ public PipelinesAPI pipelines() {
* hierarchical and scalable manner, based on data attributes rather than specific resources,
* enabling more flexible and comprehensive access control. ABAC policies in Unity Catalog support
* conditions on securable properties, governance tags, and environment contexts. Callers must
- * have the `MANAGE` privilege on a securable to view, create, update, or delete ABAC policies.
+ * have the {@code MANAGE} privilege on a securable to view, create, update, or delete ABAC
+ * policies.
*/
public PoliciesAPI policies() {
return policiesAPI;
@@ -1438,12 +1459,12 @@ public PolicyFamiliesAPI policyFamilies() {
*
+ *
*
*
+ *
*/
public RecipientsAPI recipients() {
return recipientsAPI;
@@ -1661,13 +1686,18 @@ public RedashConfigAPI redashConfig() {
* the enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the
* following additional privileges are required for various operations:
*
- *
+ *
*
*
+ *
*
*
+ *
*
- *
+ *
*/
public StatementExecutionAPI statementExecution() {
return statementExecutionAPI;
@@ -1975,8 +2015,8 @@ public TableConstraintsAPI tableConstraints() {
* users must have the SELECT permission on the table, and they must have the USE_CATALOG
* permission on its parent catalog and the USE_SCHEMA permission on its parent schema.
*
- *
+ *
*/
public VectorSearchIndexesAPI vectorSearchIndexes() {
return vectorSearchIndexesAPI;
@@ -2146,14 +2189,14 @@ public WorkspaceAPI workspace() {
}
/**
- * A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable
- * can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a
- * configured list of workspaces. This API allows you to configure (bind) securables to
- * workspaces.
+ * A securable in Databricks can be configured as OPEN or ISOLATED. An OPEN
+ * securable can be accessed from any workspace, while an ISOLATED securable can only be
+ * accessed from a configured list of workspaces. This API allows you to configure (bind)
+ * securables to workspaces.
*
- *
+ *
*/
public WorkspaceBindingsAPI workspaceBindings() {
return workspaceBindingsAPI;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentbricks/UpdateCustomLlmRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentbricks/UpdateCustomLlmRequest.java
index b64b69262..f01a3ba1b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentbricks/UpdateCustomLlmRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentbricks/UpdateCustomLlmRequest.java
@@ -19,17 +19,17 @@ public class UpdateCustomLlmRequest {
/**
* The list of the CustomLlm fields to update. These should correspond to the values (or lack
- * thereof) present in `custom_llm`.
+ * thereof) present in {@code custom_llm}.
*
*
+ *
*/
@Generated
public enum IndexSubtype {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexType.java
index df384b687..8a7413d4a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexType.java
@@ -5,11 +5,15 @@
import com.databricks.sdk.support.Generated;
/**
- * There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a
- * source Delta Table, automatically and incrementally updating the index as the underlying data in
- * the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of
- * vectors and metadata through our REST and SDK APIs. With this model, the user manages index
- * updates.
+ * There are 2 types of AI Search indexes:
+ *
+ *
+ *
*/
@Generated
public enum IndexType {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListEndpointsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListEndpointsRequest.java
index 3572a0916..9770997c2 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListEndpointsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListEndpointsRequest.java
@@ -12,8 +12,8 @@
public class ListEndpointsRequest {
/**
* Best-effort upper bound on the number of results to return. Honored as an upper bound by the
- * shim: `page_size` only narrows the legacy backend's response, never widens it, so the practical
- * cap is `min(page_size, legacy_fixed_page_size)`.
+ * shim: {@code page_size} only narrows the legacy backend's response, never widens it, so the
+ * practical cap is {@code min(page_size, legacy_fixed_page_size)}.
*/
@JsonIgnore
@QueryParam("page_size")
@@ -24,7 +24,9 @@ public class ListEndpointsRequest {
@QueryParam("page_token")
private String pageToken;
- /** The Workspace that owns this collection of endpoints. Format: `workspaces/{workspace_id}` */
+ /**
+ * The Workspace that owns this collection of endpoints. Format: {@code workspaces/{workspace_id}}
+ */
@JsonIgnore private String parent;
public ListEndpointsRequest setPageSize(Long pageSize) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java
index 2409ed7b1..3ee845d63 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java
@@ -12,8 +12,8 @@
public class ListIndexesRequest {
/**
* Best-effort upper bound on the number of results to return. Honored as an upper bound by the
- * shim: `page_size` only narrows the legacy backend's response, never widens it, so the practical
- * cap is `min(page_size, legacy_fixed_page_size)`.
+ * shim: {@code page_size} only narrows the legacy backend's response, never widens it, so the
+ * practical cap is {@code min(page_size, legacy_fixed_page_size)}.
*/
@JsonIgnore
@QueryParam("page_size")
@@ -25,8 +25,8 @@ public class ListIndexesRequest {
private String pageToken;
/**
- * The Endpoint that owns this collection of indexes. Format:
- * `workspaces/{workspace_id}/endpoints/{endpoint_id}`
+ * The Endpoint that owns this collection of indexes. Format: {@code
+ * workspaces/{workspace_id}/endpoints/{endpoint_id}}
*/
@JsonIgnore private String parent;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesResponse.java
index aba54917c..3ce65b0e1 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesResponse.java
@@ -12,10 +12,10 @@
@Generated
public class ListIndexesResponse {
/**
- * The indexes on the endpoint. The field is named `indexes` (not the irregular plural `indices`)
- * to satisfy core::0132, which derives the response field name from the ListIndexes method.
- * core::0158::response-plural-first-field independently computes the resource plural as `indices`
- * and is satisfied via a scoped field exception below.
+ * The indexes on the endpoint. The field is named {@code indexes} (not the irregular plural
+ * {@code indices}) to satisfy core::0132, which derives the response field name from the
+ * ListIndexes method. core::0158::response-plural-first-field independently computes the resource
+ * plural as {@code indices} and is satisfied via a scoped field exception below.
*/
@JsonProperty("indexes")
private Collection
+ *
*/
@Generated
public enum PipelineType {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java
index 8820c4724..3307bc4cd 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java
@@ -10,9 +10,9 @@
import java.util.Objects;
/**
- * Request to query (search) an AI Search index. The legacy `num_results` count is exposed as
- * `max_results`; v1 returns up to `max_results` rows in a single response (no cursor pagination —
- * see the note on `max_results` below).
+ * Request to query (search) an AI Search index. The legacy {@code num_results} count is exposed as
+ * {@code max_results}; v1 returns up to {@code max_results} rows in a single response (no cursor
+ * pagination — see the note on {@code max_results} below).
*/
@Generated
public class QueryIndexRequest {
@@ -24,25 +24,25 @@ public class QueryIndexRequest {
@JsonProperty("columns_to_rerank")
private Collection
+ *
*
*
+ *
*
*
+ *
*/
@JsonProperty("policy_name")
private String policyName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetConfigurationBudgetAlertConfigurations.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetConfigurationBudgetAlertConfigurations.java
index 4adf795ea..f1649ad14 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetConfigurationBudgetAlertConfigurations.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetConfigurationBudgetAlertConfigurations.java
@@ -19,14 +19,14 @@ public class CreateBudgetConfigurationBudgetAlertConfigurations {
/**
* The threshold for the budget alert to determine if it is in a triggered state. The number is
- * evaluated based on `quantity_type`.
+ * evaluated based on {@code quantity_type}.
*/
@JsonProperty("quantity_threshold")
private String quantityThreshold;
/**
- * The way to calculate cost for this budget alert. This is what `quantity_threshold` is measured
- * in.
+ * The way to calculate cost for this budget alert. This is what {@code quantity_threshold} is
+ * measured in.
*/
@JsonProperty("quantity_type")
private AlertConfigurationQuantityType quantityType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
index 2ed87cd0e..fa9456ad8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
@@ -11,16 +11,16 @@
@Generated
public class CreateBudgetPolicyRequest {
/**
- * The policy to create. `policy_id` needs to be empty as it will be generated `policy_name` must
- * be provided, custom_tags may need to be provided depending on the cloud provider. All other
- * fields are optional.
+ * The policy to create. {@code policy_id} needs to be empty as it will be generated {@code
+ * policy_name} must be provided, custom_tags may need to be provided depending on the cloud
+ * provider. All other fields are optional.
*/
@JsonProperty("policy")
private BudgetPolicy policy;
/**
* A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is
- * recommended. This request is only idempotent if a `request_id` is provided.
+ * recommended. This request is only idempotent if a {@code request_id} is provided.
*/
@JsonProperty("request_id")
private String requestId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateLogDeliveryConfigurationParams.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateLogDeliveryConfigurationParams.java
index 619f90f27..7b6d585bd 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateLogDeliveryConfigurationParams.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateLogDeliveryConfigurationParams.java
@@ -8,7 +8,7 @@
import java.util.Collection;
import java.util.Objects;
-/** * Log Delivery Configuration */
+/** Log Delivery Configuration */
@Generated
public class CreateLogDeliveryConfigurationParams {
/** The optional human-readable name of the log delivery configuration. Defaults to empty. */
@@ -17,11 +17,9 @@ public class CreateLogDeliveryConfigurationParams {
/**
* The ID for a method:credentials/create that represents the AWS IAM role with policy and trust
- * relationship as described in the main billable usage documentation page. See [Configure
- * billable usage delivery].
- *
- *
+ *
*/
@JsonProperty("log_type")
private LogType logType;
/**
- * The file type of log delivery. * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`.
- * Only the CSV (comma-separated values) format is supported. For the schema, see the [View
- * billable usage] * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON
- * (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit
- * logs].
+ * The file type of log delivery.
*
- *
+ *
*/
@JsonProperty("output_format")
private OutputFormat outputFormat;
/**
- * Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled).
- * Defaults to `ENABLED`. You can [enable or disable the
- * configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration
- * is not supported, so disable a log delivery configuration that is no longer needed.
+ * Status of log delivery configuration. Set to {@code ENABLED} (enabled) or {@code DISABLED}
+ * (disabled). Defaults to {@code ENABLED}. You can enable or disable the configuration
+ * later. Deletion of a configuration is not supported, so disable a log delivery configuration
+ * that is no longer needed.
*/
@JsonProperty("status")
private LogDeliveryConfigStatus status;
/**
* The ID for a method:storage/create that represents the S3 bucket with bucket policy as
- * described in the main billable usage documentation page. See [Configure billable usage
- * delivery].
- *
- *
+ *
*
- *
+ *
*
- *
+ *
*/
@Generated
public class LogDeliveryAPI {
@@ -84,14 +98,18 @@ public LogDeliveryAPI(LogDeliveryService mock) {
/**
* Creates a new Databricks log delivery configuration to enable delivery of the specified type of
- * logs to your storage location. This requires that you already created a [credential
- * object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a
- * [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket).
+ * logs to your storage location. This requires that you already created a credential object (which encapsulates a cross-account
+ * service IAM role) and a storage configuration object
+ * (which encapsulates an S3 bucket).
*
- *
+ *
*/
@JsonProperty("log_type")
private LogType logType;
/**
- * The file type of log delivery. * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`.
- * Only the CSV (comma-separated values) format is supported. For the schema, see the [View
- * billable usage] * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON
- * (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit
- * logs].
+ * The file type of log delivery.
*
- *
+ *
*/
@JsonProperty("output_format")
private OutputFormat outputFormat;
/**
- * Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled).
- * Defaults to `ENABLED`. You can [enable or disable the
- * configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration
- * is not supported, so disable a log delivery configuration that is no longer needed.
+ * Status of log delivery configuration. Set to {@code ENABLED} (enabled) or {@code DISABLED}
+ * (disabled). Defaults to {@code ENABLED}. You can enable or disable the configuration
+ * later. Deletion of a configuration is not supported, so disable a log delivery configuration
+ * that is no longer needed.
*/
@JsonProperty("status")
private LogDeliveryConfigStatus status;
/**
* The ID for a method:storage/create that represents the S3 bucket with bucket policy as
- * described in the main billable usage documentation page. See [Configure billable usage
- * delivery].
- *
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*/
@JsonProperty("status")
private DeliveryStatus status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogType.java
index 2df06fe30..1c5610db0 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/LogType.java
@@ -4,7 +4,7 @@
import com.databricks.sdk.support.Generated;
-/** * Log Delivery Type */
+/** Log Delivery Type */
@Generated
public enum LogType {
AUDIT_LOGS,
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/OutputFormat.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/OutputFormat.java
index 4298a6b0f..d465fdf8f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/OutputFormat.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/OutputFormat.java
@@ -4,7 +4,7 @@
import com.databricks.sdk.support.Generated;
-/** * Log Delivery Output Format */
+/** Log Delivery Output Format */
@Generated
public enum OutputFormat {
CSV,
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
index baafb73c5..056e6595c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
@@ -17,9 +17,9 @@ public class UpdateBudgetPolicyRequest {
private LimitConfig limitConfig;
/**
- * The policy to update. `creator_user_id` cannot be specified in the request. All other fields
- * must be specified even if not changed. The `policy_id` is used to identify the policy to
- * update.
+ * The policy to update. {@code creator_user_id} cannot be specified in the request. All other
+ * fields must be specified even if not changed. The {@code policy_id} is used to identify the
+ * policy to update.
*/
@JsonProperty("policy")
private BudgetPolicy policy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateLogDeliveryConfigurationStatusRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateLogDeliveryConfigurationStatusRequest.java
index 3fc98a262..c192e9db7 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateLogDeliveryConfigurationStatusRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateLogDeliveryConfigurationStatusRequest.java
@@ -8,17 +8,18 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
-/** * Update Log Delivery Configuration */
+/** Update Log Delivery Configuration */
@Generated
public class UpdateLogDeliveryConfigurationStatusRequest {
/** The log delivery configuration id of customer */
@JsonIgnore private String logDeliveryConfigurationId;
/**
- * Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled).
- * Defaults to `ENABLED`. You can [enable or disable the
- * configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration
- * is not supported, so disable a log delivery configuration that is no longer needed.
+ * Status of log delivery configuration. Set to {@code ENABLED} (enabled) or {@code DISABLED}
+ * (disabled). Defaults to {@code ENABLED}. You can enable or disable the configuration
+ * later. Deletion of a configuration is not supported, so disable a log delivery configuration
+ * that is no longer needed.
*/
@JsonProperty("status")
private LogDeliveryConfigStatus status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedCreateLogDeliveryConfiguration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedCreateLogDeliveryConfiguration.java
index aa9eb7cb8..c03af9f3e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedCreateLogDeliveryConfiguration.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedCreateLogDeliveryConfiguration.java
@@ -7,7 +7,7 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
-/** * Properties of the new log delivery configuration. */
+/** Properties of the new log delivery configuration. */
@Generated
public class WrappedCreateLogDeliveryConfiguration {
/** */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedLogDeliveryConfigurations.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedLogDeliveryConfigurations.java
index 6d553b893..db4c7d4be 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedLogDeliveryConfigurations.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/WrappedLogDeliveryConfigurations.java
@@ -15,8 +15,8 @@ public class WrappedLogDeliveryConfigurations {
private Collection
+ *
*/
public Version completeVersion(CompleteVersionRequest request) {
return impl.completeVersion(request);
@@ -38,9 +43,9 @@ public Version completeVersion(CompleteVersionRequest request) {
/**
* Creates a new deployment in the workspace.
*
- *
+ *
*/
Version completeVersion(CompleteVersionRequest completeVersionRequest);
/**
* Creates a new deployment in the workspace.
*
- *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*/
public FunctionInfo create(CreateFunctionRequest request) {
return impl.create(request);
@@ -50,10 +53,15 @@ public void delete(String name) {
/**
* Deletes the function that matches the supplied name. For the deletion to succeed, the user must
- * satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is
- * the owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent
- * catalog - Is the owner of the function itself and have both the **USE_CATALOG** privilege on
- * its parent catalog and the **USE_SCHEMA** privilege on its parent schema
+ * satisfy one of the following conditions:
+ *
+ *
+ *
*/
public void delete(DeleteFunctionRequest request) {
impl.delete(request);
@@ -65,11 +73,17 @@ public FunctionInfo get(String name) {
/**
* Gets a function from within a parent catalog and schema. For the fetch to succeed, the user
- * must satisfy one of the following requirements: - Is a metastore admin - Is an owner of the
- * function's parent catalog - Have the **USE_CATALOG** privilege on the function's parent catalog
- * and be the owner of the function - Have the **USE_CATALOG** privilege on the function's parent
- * catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the **EXECUTE**
- * privilege on the function itself
+ * must satisfy one of the following requirements:
+ *
+ *
+ *
*/
public FunctionInfo get(GetFunctionRequest request) {
return impl.get(request);
@@ -82,15 +96,15 @@ public Iterable
+ *
*/
public FunctionInfo update(UpdateFunction request) {
return impl.update(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionsService.java
index cd255e14b..c5d57c1ab 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionsService.java
@@ -9,7 +9,7 @@
*
+ *
*/
FunctionInfo create(CreateFunctionRequest createFunctionRequest);
/**
* Deletes the function that matches the supplied name. For the deletion to succeed, the user must
- * satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is
- * the owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent
- * catalog - Is the owner of the function itself and have both the **USE_CATALOG** privilege on
- * its parent catalog and the **USE_SCHEMA** privilege on its parent schema
+ * satisfy one of the following conditions:
+ *
+ *
+ *
*/
void delete(DeleteFunctionRequest deleteFunctionRequest);
/**
* Gets a function from within a parent catalog and schema. For the fetch to succeed, the user
- * must satisfy one of the following requirements: - Is a metastore admin - Is an owner of the
- * function's parent catalog - Have the **USE_CATALOG** privilege on the function's parent catalog
- * and be the owner of the function - Have the **USE_CATALOG** privilege on the function's parent
- * catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the **EXECUTE**
- * privilege on the function itself
+ * must satisfy one of the following requirements:
+ *
+ *
+ *
*/
FunctionInfo get(GetFunctionRequest getFunctionRequest);
/**
* List functions within the specified parent catalog and schema. If the user is a metastore
* admin, all functions are returned in the output list. Otherwise, the user must have the
- * **USE_CATALOG** privilege on the catalog and the **USE_SCHEMA** privilege on the schema, and
- * the output list contains only functions for which either the user has the **EXECUTE** privilege
- * or the user is the owner. There is no guarantee of a specific ordering of the elements in the
- * array.
+ * USE_CATALOG privilege on the catalog and the USE_SCHEMA privilege on the schema,
+ * and the output list contains only functions for which either the user has the EXECUTE
+ * privilege or the user is the owner. There is no guarantee of a specific ordering of the
+ * elements in the array.
*
*
+ *
*/
FunctionInfo update(UpdateFunction updateFunction);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetBindingsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetBindingsRequest.java
index b35492f54..e0ec78340 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetBindingsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetBindingsRequest.java
@@ -11,11 +11,15 @@
@Generated
public class GetBindingsRequest {
/**
- * Maximum number of workspace bindings to return. - When set to 0, the page length is set to a
- * server configured value (recommended); - When set to a value greater than 0, the page length is
- * the minimum of this value and a server configured value; - When set to a value less than 0, an
- * invalid parameter error is returned; - If not set, all the workspace bindings are returned (not
- * recommended).
+ * Maximum number of workspace bindings to return.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetEffectiveRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetEffectiveRequest.java
index 01b5ed191..fc199f93e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetEffectiveRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetEffectiveRequest.java
@@ -19,11 +19,17 @@ public class GetEffectiveRequest {
* effective privileges granted on (or inherited by) the requested Securable for the respective
* principal.
*
- *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetFunctionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetFunctionRequest.java
index b635d3ab3..440fbcaa8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetFunctionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetFunctionRequest.java
@@ -20,7 +20,7 @@ public class GetFunctionRequest {
/**
* The fully-qualified name of the function (of the form
- * __catalog_name__.__schema_name__.__function__name__).
+ * catalog_name.schema_name.function__name).
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetGrantRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetGrantRequest.java
index 59e2565c2..b9a2be5cc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetGrantRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetGrantRequest.java
@@ -18,11 +18,17 @@ public class GetGrantRequest {
* present in a single page response is guaranteed to contain all the privileges granted on the
* requested Securable for the respective principal.
*
- *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetMetastoreSummaryResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetMetastoreSummaryResponse.java
index f30d70fe7..cdf85ddbd 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetMetastoreSummaryResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetMetastoreSummaryResponse.java
@@ -9,7 +9,7 @@
@Generated
public class GetMetastoreSummaryResponse {
- /** Cloud vendor of the metastore home shard (e.g., `aws`, `azure`, `gcp`). */
+ /** Cloud vendor of the metastore home shard (e.g., {@code aws}, {@code azure}, {@code gcp}). */
@JsonProperty("cloud")
private String cloud;
@@ -45,8 +45,8 @@ public class GetMetastoreSummaryResponse {
private Boolean externalAccessEnabled;
/**
- * Globally unique metastore ID across clouds and regions, of the form
- * `cloud:region:metastore_id`.
+ * Globally unique metastore ID across clouds and regions, of the form {@code
+ * cloud:region:metastore_id}.
*/
@JsonProperty("global_metastore_id")
private String globalMetastoreId;
@@ -63,11 +63,13 @@ public class GetMetastoreSummaryResponse {
@JsonProperty("owner")
private String owner;
- /** Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`). */
+ /**
+ * Privilege model version of the metastore, of the form {@code major.minor} (e.g., {@code 1.0}).
+ */
@JsonProperty("privilege_model_version")
private String privilegeModelVersion;
- /** Cloud region which the metastore serves (e.g., `us-west-2`, `westus`). */
+ /** Cloud region which the metastore serves (e.g., {@code us-west-2}, {@code westus}). */
@JsonProperty("region")
private String region;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetPermissionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetPermissionsResponse.java
index f0375ba39..c5ffad42f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetPermissionsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetPermissionsResponse.java
@@ -12,7 +12,8 @@
public class GetPermissionsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetQualityMonitorRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetQualityMonitorRequest.java
index eef7a1533..558ffbd39 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetQualityMonitorRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetQualityMonitorRequest.java
@@ -10,7 +10,7 @@
@Generated
public class GetQualityMonitorRequest {
/**
- * UC table name in format `catalog.schema.table_name`. This field corresponds to the
+ * UC table name in format {@code catalog.schema.table_name}. This field corresponds to the
* {full_table_name_arg} arg in the endpoint path.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSecretRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSecretRequest.java
index 2e520e4c5..4afa98316 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSecretRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSecretRequest.java
@@ -12,12 +12,12 @@
public class GetSecretRequest {
/**
* The three-level (fully qualified) name of the secret (for example,
- * **catalog_name.schema_name.secret_name**).
+ * catalog_name.schema_name.secret_name).
*/
@JsonIgnore private String fullName;
/**
- * Whether to include secrets in the response for which you only have the **BROWSE** privilege,
+ * Whether to include secrets in the response for which you only have the BROWSE privilege,
* which limits access to metadata.
*/
@JsonIgnore
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetWorkspaceBindingsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetWorkspaceBindingsResponse.java
index 7052a938b..a05a5a00a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetWorkspaceBindingsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetWorkspaceBindingsResponse.java
@@ -16,7 +16,8 @@ public class GetWorkspaceBindingsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsAPI.java
index ccffa0aaf..87ccf19f6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GrantsAPI.java
@@ -43,7 +43,7 @@ public GetPermissionsResponse get(String securableType, String fullName) {
*
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsResponse.java
index 314b99cbd..391f3fdd3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsResponse.java
@@ -16,7 +16,8 @@ public class ListCatalogsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsRequest.java
index 4aae35586..1b2c76533 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsRequest.java
@@ -11,11 +11,15 @@
@Generated
public class ListConnectionsRequest {
/**
- * Maximum number of connections to return. - If not set, all connections are returned (not
- * recommended). - when set to a value greater than 0, the page length is the minimum of this
- * value and a server configured value; - when set to 0, the page length is set to a server
- * configured value (recommended); - when set to a value less than 0, an invalid parameter error
- * is returned;
+ * Maximum number of connections to return.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsResponse.java
index 51088a406..2e6e328c3 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListConnectionsResponse.java
@@ -16,7 +16,8 @@ public class ListConnectionsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsRequest.java
index c9b2c2dc2..5a550ecc1 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsRequest.java
@@ -19,10 +19,15 @@ public class ListCredentialsRequest {
private Boolean includeUnbound;
/**
- * Maximum number of credentials to return. - If not set, the default max page size is used. -
- * When set to a value greater than 0, the page length is the minimum of this value and a
- * server-configured value. - When set to 0, the page length is set to a server-configured value
- * (recommended). - When set to a value less than 0, an invalid parameter error is returned.
+ * Maximum number of credentials to return.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsResponse.java
index 79ebd1904..02f5250e5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCredentialsResponse.java
@@ -16,7 +16,8 @@ public class ListCredentialsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java
index 37261ec39..2c3d71638 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java
@@ -18,7 +18,7 @@ public class ListExternalLineageRelationshipsRequest {
/**
* The object to query external lineage relationships for. Since this field is a query parameter,
* please flatten the nested fields. For example, if the object is a table, the query parameter
- * should look like: `object_info.table.name=main.sales.customers`
+ * should look like: {@code object_info.table.name=main.sales.customers}
*/
@JsonIgnore
@QueryParam("object_info")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java
index 71bfa3314..aad84de10 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java
@@ -28,10 +28,14 @@ public class ListExternalLocationsRequest {
/**
* Maximum number of external locations to return. If not set, all the external locations are
- * returned (not recommended). - when set to a value greater than 0, the page length is the
- * minimum of this value and a server configured value; - when set to 0, the page length is set to
- * a server configured value (recommended); - when set to a value less than 0, an invalid
- * parameter error is returned;
+ * returned (not recommended).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsResponse.java
index f43f138f4..8a0577e4d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsResponse.java
@@ -16,7 +16,8 @@ public class ListExternalLocationsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsRequest.java
index 4e7cf6ea1..6bf4a79d9 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsRequest.java
@@ -25,10 +25,14 @@ public class ListFunctionsRequest {
/**
* Maximum number of functions to return. If not set, all the functions are returned (not
- * recommended). - when set to a value greater than 0, the page length is the minimum of this
- * value and a server configured value; - when set to 0, the page length is set to a server
- * configured value (recommended); - when set to a value less than 0, an invalid parameter error
- * is returned;
+ * recommended).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsResponse.java
index b88b18e14..af4824d2c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListFunctionsResponse.java
@@ -16,7 +16,8 @@ public class ListFunctionsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresRequest.java
index 94e5514e1..b96321570 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresRequest.java
@@ -11,13 +11,18 @@
@Generated
public class ListMetastoresRequest {
/**
- * Maximum number of metastores to return. - when set to a value greater than 0, the page length
- * is the minimum of this value and a server configured value; - when set to 0, the page length is
- * set to a server configured value (recommended); - when set to a value less than 0, an invalid
- * parameter error is returned; - If not set, all the metastores are returned (not recommended). -
- * Note: The number of returned metastores might be less than the specified max_results size, even
- * zero. The only definitive indication that no further metastores can be fetched is when the
- * next_page_token is unset from the response.
+ * Maximum number of metastores to return.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresResponse.java
index e906c400f..c42781645 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListMetastoresResponse.java
@@ -16,7 +16,8 @@ public class ListMetastoresResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsRequest.java
index 5c7f3ccf0..c44ac9242 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsRequest.java
@@ -23,10 +23,15 @@ public class ListModelVersionsRequest {
/**
* Maximum number of model versions to return. If not set, the page length is set to a server
- * configured value (100, as of 1/3/2024). - when set to a value greater than 0, the page length
- * is the minimum of this value and a server configured value(1000, as of 1/3/2024); - when set to
- * 0, the page length is set to a server configured value (100, as of 1/3/2024) (recommended); -
- * when set to a value less than 0, an invalid parameter error is returned;
+ * configured value (100, as of 1/3/2024).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsResponse.java
index 33959df88..c9f494ae5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListModelVersionsResponse.java
@@ -16,7 +16,8 @@ public class ListModelVersionsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesRequest.java
index 444155d59..af0f85f50 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesRequest.java
@@ -19,10 +19,14 @@ public class ListPoliciesRequest {
private Boolean includeInherited;
/**
- * Optional. Maximum number of policies to return on a single page (page length). - When not set
- * or set to 0, the page length is set to a server configured value (recommended); - When set to a
- * value greater than 0, the page length is the minimum of this value and a server configured
- * value;
+ * Optional. Maximum number of policies to return on a single page (page length).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesResponse.java
index 7a2218723..6c8562a03 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListPoliciesResponse.java
@@ -11,8 +11,8 @@
@Generated
public class ListPoliciesResponse {
/**
- * Optional opaque token for continuing pagination. `page_token` should be set to this value for
- * the next request to retrieve the next page of results.
+ * Optional opaque token for continuing pagination. {@code page_token} should be set to this value
+ * for the next request to retrieve the next page of results.
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListQuotasResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListQuotasResponse.java
index 42a68e3a9..5936bcb1b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListQuotasResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListQuotasResponse.java
@@ -12,7 +12,7 @@
public class ListQuotasResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request.
+ * page_token should be set to this value for the next request.
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRefreshesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRefreshesRequest.java
index 8f0c31114..c36761df8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRefreshesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRefreshesRequest.java
@@ -10,8 +10,8 @@
@Generated
public class ListRefreshesRequest {
/**
- * UC table name in format `catalog.schema.table_name`. table_name is case insensitive and spaces
- * are disallowed.
+ * UC table name in format {@code catalog.schema.table_name}. table_name is case insensitive and
+ * spaces are disallowed.
*/
@JsonIgnore private String tableName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRegisteredModelsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRegisteredModelsRequest.java
index 1d5411f69..2f2fadc5d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRegisteredModelsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListRegisteredModelsRequest.java
@@ -29,18 +29,28 @@ public class ListRegisteredModelsRequest {
/**
* Max number of registered models to return.
*
- *
+ *
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
index 5fe266596..d29bad0df 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
@@ -25,10 +25,14 @@ public class ListSchemasRequest {
/**
* Maximum number of schemas to return. If not set, all the schemas are returned (not
- * recommended). - when set to a value greater than 0, the page length is the minimum of this
- * value and a server configured value; - when set to 0, the page length is set to a server
- * configured value (recommended); - when set to a value less than 0, an invalid parameter error
- * is returned;
+ * recommended).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasResponse.java
index 23021dcba..ae93e2b93 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasResponse.java
@@ -12,7 +12,8 @@
public class ListSchemasResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsRequest.java
index 723c6f626..f94db0366 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsRequest.java
@@ -11,15 +11,15 @@
@Generated
public class ListSecretsRequest {
/**
- * The name of the catalog under which to list secrets. Both **catalog_name** and **schema_name**
- * must be specified together.
+ * The name of the catalog under which to list secrets. Both catalog_name and
+ * schema_name must be specified together.
*/
@JsonIgnore
@QueryParam("catalog_name")
private String catalogName;
/**
- * Whether to include secrets in the response for which you only have the **BROWSE** privilege,
+ * Whether to include secrets in the response for which you only have the BROWSE privilege,
* which limits access to metadata.
*/
@JsonIgnore
@@ -29,9 +29,12 @@ public class ListSecretsRequest {
/**
* Maximum number of secrets to return.
*
- *
+ *
*/
@JsonIgnore
@QueryParam("page_size")
@@ -46,8 +49,8 @@ public class ListSecretsRequest {
private String pageToken;
/**
- * The name of the schema under which to list secrets. Both **catalog_name** and **schema_name**
- * must be specified together.
+ * The name of the schema under which to list secrets. Both catalog_name and
+ * schema_name must be specified together.
*/
@JsonIgnore
@QueryParam("schema_name")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsResponse.java
index 96b81a1e6..7517c2050 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSecretsResponse.java
@@ -13,7 +13,7 @@
public class ListSecretsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * **page_token** should be set to this value for the next request.
+ * page_token should be set to this value for the next request.
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsRequest.java
index 9f1f82035..4fea6eda0 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsRequest.java
@@ -20,10 +20,14 @@ public class ListStorageCredentialsRequest {
/**
* Maximum number of storage credentials to return. If not set, all the storage credentials are
- * returned (not recommended). - when set to a value greater than 0, the page length is the
- * minimum of this value and a server configured value; - when set to 0, the page length is set to
- * a server configured value (recommended); - when set to a value less than 0, an invalid
- * parameter error is returned;
+ * returned (not recommended).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsResponse.java
index 25ef95015..0d2073ced 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListStorageCredentialsResponse.java
@@ -12,7 +12,8 @@
public class ListStorageCredentialsResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSummariesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSummariesRequest.java
index 774820505..c100e840f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSummariesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSummariesRequest.java
@@ -22,10 +22,15 @@ public class ListSummariesRequest {
/**
* Maximum number of summaries for tables to return. If not set, the page length is set to a
- * server configured value (10000, as of 1/5/2024). - when set to a value greater than 0, the page
- * length is the minimum of this value and a server configured value (10000, as of 1/5/2024); -
- * when set to 0, the page length is set to a server configured value (10000, as of 1/5/2024)
- * (recommended); - when set to a value less than 0, an invalid parameter error is returned;
+ * server configured value (10000, as of 1/5/2024).
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasRequest.java
index bba8bfa7c..00e209688 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasRequest.java
@@ -11,11 +11,15 @@
@Generated
public class ListSystemSchemasRequest {
/**
- * Maximum number of schemas to return. - When set to 0, the page length is set to a server
- * configured value (recommended); - When set to a value greater than 0, the page length is the
- * minimum of this value and a server configured value; - When set to a value less than 0, an
- * invalid parameter error is returned; - If not set, all the schemas are returned (not
- * recommended).
+ * Maximum number of schemas to return.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasResponse.java
index ac970407e..7373a3efa 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSystemSchemasResponse.java
@@ -12,7 +12,8 @@
public class ListSystemSchemasResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTableSummariesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTableSummariesResponse.java
index bfe514e7b..735e4de74 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTableSummariesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTableSummariesResponse.java
@@ -12,7 +12,8 @@
public class ListTableSummariesResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesRequest.java
index f63d165d6..6d5cba945 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesRequest.java
@@ -30,9 +30,13 @@ public class ListTablesRequest {
/**
* Maximum number of tables to return. If not set, all the tables are returned (not recommended).
- * - when set to a value greater than 0, the page length is the minimum of this value and a server
- * configured value; - when set to 0, the page length is set to a server configured value
- * (recommended); - when set to a value less than 0, an invalid parameter error is returned;
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("max_results")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesResponse.java
index 429103c82..67356f0f6 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListTablesResponse.java
@@ -12,7 +12,8 @@
public class ListTablesResponse {
/**
* Opaque token to retrieve the next page of results. Absent if there are no more pages.
- * __page_token__ should be set to this value for the next request (for the next page of results).
+ * page_token should be set to this value for the next request (for the next page of
+ * results).
*/
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java
index 5c2502a3a..3bec33e05 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java
@@ -26,11 +26,15 @@ public class ListVolumesRequest {
/**
* Maximum number of volumes to return (page length).
*
- *
+ *
*
*
+ *
*/
@JsonProperty("type")
private MonitorMetricType typeValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorMetricType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorMetricType.java
index bfce08e24..4a9b6e695 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorMetricType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorMetricType.java
@@ -5,13 +5,17 @@
import com.databricks.sdk.support.Generated;
/**
- * Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or
- * ``\"CUSTOM_METRIC_TYPE_DRIFT\"``. The ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and
- * ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics are computed on a single table, whereas the
- * ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across baseline and input table, or across the
- * two consecutive time windows. - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns
- * in your table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics -
- * CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics
+ * Can only be one of {@code \"CUSTOM_METRIC_TYPE_AGGREGATE\"}, {@code
+ * \"CUSTOM_METRIC_TYPE_DERIVED\"}, or {@code \"CUSTOM_METRIC_TYPE_DRIFT\"}. The {@code
+ * \"CUSTOM_METRIC_TYPE_AGGREGATE\"} and {@code \"CUSTOM_METRIC_TYPE_DERIVED\"} metrics are computed
+ * on a single table, whereas the {@code \"CUSTOM_METRIC_TYPE_DRIFT\"} compare metrics across
+ * baseline and input table, or across the two consecutive time windows.
+ *
+ *
+ *
*/
@Generated
public enum MonitorMetricType {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorTimeSeries.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorTimeSeries.java
index f43299aec..a06a78dad 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorTimeSeries.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/MonitorTimeSeries.java
@@ -13,8 +13,9 @@
public class MonitorTimeSeries {
/**
* Granularities for aggregating data into time windows based on their timestamp. Currently the
- * following static granularities are supported: {``\"5 minutes\"``, ``\"30 minutes\"``, ``\"1
- * hour\"``, ``\"1 day\"``, ``\"\u003cn\u003e week(s)\"``, ``\"1 month\"``, ``\"1 year\"``}.
+ * following static granularities are supported: {{@code \"5 minutes\"}, {@code \"30 minutes\"},
+ * {@code \"1 hour\"}, {@code \"1 day\"}, {@code \"\u003cn\u003e week(s)\"}, {@code \"1 month\"},
+ * {@code \"1 year\"}}.
*/
@JsonProperty("granularities")
private Collection
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
+ *
+ *
+ *
*
*
+ *
*
*
+ *
*/
public RegisteredModelInfo create(CreateRegisteredModelRequest request) {
return impl.create(request);
@@ -74,8 +82,8 @@ public void delete(String fullName) {
* schema.
*
*
+ *
*
*
+ *
*/
RegisteredModelInfo create(CreateRegisteredModelRequest createRegisteredModelRequest);
@@ -54,8 +62,8 @@ public interface RegisteredModelsService {
* schema.
*
*
+ *
*/
public TableConstraint create(CreateTableConstraint request) {
return impl.create(request);
@@ -56,11 +61,15 @@ public void delete(String fullName) {
* Deletes a table constraint.
*
*
+ *
*/
public void delete(DeleteTableConstraintRequest request) {
impl.delete(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsService.java
index 9fb50719c..c658a41e5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableConstraintsService.java
@@ -25,11 +25,16 @@ public interface TableConstraintsService {
* Creates a new table constraint.
*
*
+ *
*/
TableConstraint create(CreateTableConstraint createTableConstraint);
@@ -37,11 +42,15 @@ public interface TableConstraintsService {
* Deletes a table constraint.
*
*
+ *
*/
void delete(DeleteTableConstraintRequest deleteTableConstraintRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableDependency.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableDependency.java
index 6826680c6..8f5ea4be2 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableDependency.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableDependency.java
@@ -12,7 +12,7 @@
public class TableDependency {
/**
* Full name of the dependent table, in the form of
- * __catalog_name__.__schema_name__.__table_name__.
+ * catalog_name.schema_name.table_name.
*/
@JsonProperty("table_full_name")
private String tableFullName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
index cbe5577c2..5f960b581 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
@@ -26,7 +26,7 @@ public class TableInfo {
@JsonProperty("catalog_name")
private String catalogName;
- /** The array of __ColumnInfo__ definitions of the table's columns. */
+ /** The array of ColumnInfo definitions of the table's columns. */
@JsonProperty("columns")
private Collection
+ *
*/
@JsonProperty("view_dependencies")
private DependencyList viewDependencies;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TablesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TablesAPI.java
index 11114153c..fc26a2553 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TablesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TablesAPI.java
@@ -14,8 +14,8 @@
* have the SELECT permission on the table, and they must have the USE_CATALOG permission on its
* parent catalog and the USE_SCHEMA permission on its parent schema.
*
- *
+ *
*/
public TableExistsResponse exists(ExistsRequest request) {
return impl.exists(request);
@@ -97,10 +105,17 @@ public TableInfo get(String fullName) {
/**
* Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one
- * of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be
- * the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog *
- * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on
- * the parent schema, and either be the table owner or have the **SELECT** privilege on the table.
+ * of the following requirements:
+ *
+ *
+ *
*/
public TableInfo get(GetTableRequest request) {
return impl.get(request);
@@ -112,18 +127,18 @@ public Iterable
+ *
*
*
+ *
*/
TableExistsResponse exists(ExistsRequest existsRequest);
/**
* Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one
- * of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be
- * the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog *
- * Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on
- * the parent schema, and either be the table owner or have the **SELECT** privilege on the table.
+ * of the following requirements:
+ *
+ *
+ *
*/
TableInfo get(GetTableRequest getTableRequest);
/**
* Gets an array of all tables for the current metastore under the parent catalog and schema. The
- * caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the
- * table. For the latter case, the caller must also be the owner or have the **USE_CATALOG**
- * privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. There is
- * no guarantee of a specific ordering of the elements in the array.
+ * caller must be a metastore admin or an owner of (or have the SELECT privilege on) the
+ * table. For the latter case, the caller must also be the owner or have the USE_CATALOG
+ * privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema. There
+ * is no guarantee of a specific ordering of the elements in the array.
*
- *
+ *
*
*
+ *
*/
@JsonProperty("policy_info")
private PolicyInfo policyInfo;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSecretRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSecretRequest.java
index 0e7298448..f11af504c 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSecretRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSecretRequest.java
@@ -14,20 +14,20 @@
public class UpdateSecretRequest {
/**
* The three-level (fully qualified) name of the secret (for example,
- * **catalog_name.schema_name.secret_name**).
+ * catalog_name.schema_name.secret_name).
*/
@JsonIgnore private String fullName;
/**
- * The secret object containing the fields to update. Only fields specified in **update_mask**
+ * The secret object containing the fields to update. Only fields specified in update_mask
* will be updated.
*/
@JsonProperty("secret")
private Secret secret;
/**
- * The field mask specifying which fields of the secret to update. Supported fields: **value**,
- * **comment**, **owner**, **expire_time**.
+ * The field mask specifying which fields of the secret to update. Supported fields: value,
+ * comment, owner, expire_time.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateStorageCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateStorageCredential.java
index 4829c49ae..042ba44c8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateStorageCredential.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateStorageCredential.java
@@ -58,7 +58,7 @@ public class UpdateStorageCredential {
/**
* Whether the credential is usable only for read operations. Only applicable when purpose is
- * **STORAGE**.
+ * STORAGE.
*/
@JsonProperty("read_only")
private Boolean readOnly;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialRequest.java
index dd405f9c3..9707f3a1e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialRequest.java
@@ -28,7 +28,7 @@ public class ValidateCredentialRequest {
/**
* The name of an existing external location to validate. Only applicable for storage credentials
- * (purpose is **STORAGE**.)
+ * (purpose is STORAGE.)
*/
@JsonProperty("external_location_name")
private String externalLocationName;
@@ -39,12 +39,12 @@ public class ValidateCredentialRequest {
/**
* Whether the credential is only usable for read operations. Only applicable for storage
- * credentials (purpose is **STORAGE**.)
+ * credentials (purpose is STORAGE.)
*/
@JsonProperty("read_only")
private Boolean readOnly;
- /** The external location url to validate. Only applicable when purpose is **STORAGE**. */
+ /** The external location url to validate. Only applicable when purpose is STORAGE. */
@JsonProperty("url")
private String url;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialResponse.java
index bded52047..852b86d0f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidateCredentialResponse.java
@@ -12,7 +12,7 @@
public class ValidateCredentialResponse {
/**
* Whether the tested location is a directory in cloud storage. Only applicable for when purpose
- * is **STORAGE**.
+ * is STORAGE.
*/
@JsonProperty("isDir")
private Boolean isDir;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidationResult.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidationResult.java
index 628e2b373..5b5273287 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidationResult.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ValidationResult.java
@@ -9,7 +9,7 @@
@Generated
public class ValidationResult {
- /** Error message would exist when the result does not equal to **PASS**. */
+ /** Error message would exist when the result does not equal to PASS. */
@JsonProperty("message")
private String message;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java
index 3f74f8647..92e400786 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java
@@ -79,9 +79,8 @@ public class VolumeInfo {
/**
* The type of the volume. An external volume is located in the specified external location. A
* managed volume is located in the default location which is specified by the parent schema, or
- * the parent catalog, or the Metastore. [Learn more]
- *
- *
+ *
+ *
+ *
+ *
*/
public VolumeInfo create(CreateVolumeRequestContent request) {
return impl.create(request);
@@ -62,8 +70,8 @@ public void delete(String name) {
* Deletes a volume from the specified parent catalog and schema.
*
*
+ *
+ *
+ *
+ *
*/
VolumeInfo create(CreateVolumeRequestContent createVolumeRequestContent);
@@ -42,8 +50,8 @@ public interface VolumesService {
* Deletes a volume from the specified parent catalog and schema.
*
*
+ *
*/
@Generated
public class WorkspaceBindingsAPI {
@@ -66,7 +73,7 @@ public Iterable
+ *
+ *
+ * This is the high-level interface, that contains generated methods.
*
*
+ *
*/
@JsonProperty("collaborators")
private Collection
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("default_tags")
private Map
+ *
*
*
+ *
*
*
+ *
*
*
+ *
*
*
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
public Wait
+ *
*/
void start(StartCluster startCluster);
@@ -174,13 +179,14 @@ GetClusterPermissionLevelsResponse getPermissionLevels(
/**
* Updates the configuration of a cluster to match the partial set of attributes and size. Denote
- * which fields to update using the `update_mask` field in the request body. A cluster can be
- * updated if it is in a `RUNNING` or `TERMINATED` state. If a cluster is updated while in a
- * `RUNNING` state, it will be restarted so that the new attributes can take effect. If a cluster
- * is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The updated attributes
- * will take effect the next time the cluster is started using the `clusters/start` API. Attempts
- * to update a cluster in any other state will be rejected with an `INVALID_STATE` error code.
- * Clusters created by the Databricks Jobs service cannot be updated.
+ * which fields to update using the {@code update_mask} field in the request body. A cluster can
+ * be updated if it is in a {@code RUNNING} or {@code TERMINATED} state. If a cluster is updated
+ * while in a {@code RUNNING} state, it will be restarted so that the new attributes can take
+ * effect. If a cluster is updated while in a {@code TERMINATED} state, it will remain {@code
+ * TERMINATED}. The updated attributes will take effect the next time the cluster is started using
+ * the {@code clusters/start} API. Attempts to update a cluster in any other state will be
+ * rejected with an {@code INVALID_STATE} error code. Clusters created by the Databricks Jobs
+ * service cannot be updated.
*/
void update(UpdateCluster updateCluster);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java
index cb3ff1831..8b5f2ef87 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java
@@ -208,7 +208,7 @@ public CommandStatusResponse waitCommandStatusCommandExecutionFinishedOrError(
/**
* Cancels a currently running command within an execution context.
*
- *
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("key")
private String key;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DataSecurityMode.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DataSecurityMode.java
index 3d18e87d3..0368f3edb 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DataSecurityMode.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DataSecurityMode.java
@@ -7,27 +7,37 @@
/**
* Data security mode decides what data governance model to use when accessing data from a cluster.
*
- *
+ *
*
*
+ *
*
*
+ *
*/
@Generated
public enum DataSecurityMode {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DbfsStorageInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DbfsStorageInfo.java
index a41d4b921..e74e94a4a 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DbfsStorageInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DbfsStorageInfo.java
@@ -10,7 +10,7 @@
/** A storage location in DBFS */
@Generated
public class DbfsStorageInfo {
- /** dbfs destination, e.g. `dbfs:/my/path` */
+ /** dbfs destination, e.g. {@code dbfs:/my/path} */
@JsonProperty("destination")
private String destination;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DiskSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DiskSpec.java
index e9dbb915e..f2a3ec146 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DiskSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DiskSpec.java
@@ -15,20 +15,28 @@
@Generated
public class DiskSpec {
/**
- * The number of disks launched for each instance: - This feature is only enabled for supported
- * node types. - Users can choose up to the limit of the disks supported by the node type. - For
- * node types with no OS disk, at least one disk must be specified; otherwise, cluster creation
- * will fail.
+ * The number of disks launched for each instance:
+ *
+ *
+ *
*
*
+ *
*/
@JsonProperty("disk_count")
private Long diskCount;
@@ -41,9 +49,19 @@ public class DiskSpec {
* The size of each disk (in GiB) launched for each instance. Values must fall into the supported
* range for a particular instance type.
*
- *
+ *
+ *
+ *
+ *
*/
@JsonProperty("disk_size")
private Long diskSize;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
index cbf9d6aaf..fa98449d5 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
@@ -56,8 +56,8 @@ public class EditCluster {
* The configuration for delivering spark logs to a long-term storage destination. Three kinds of
* destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be
* specified for one cluster. If the conf is given, the logs will be delivered to the destination
- * every `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while the
- * destination of executor logs is `$destination/$clusterId/executor`.
+ * every {@code 5 mins}. The destination of driver logs is {@code $destination/$clusterId/driver},
+ * while the destination of executor logs is {@code $destination/$clusterId/executor}.
*/
@JsonProperty("cluster_log_conf")
private ClusterLogConf clusterLogConf;
@@ -72,12 +72,13 @@ public class EditCluster {
/**
* Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * instances and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- *
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("attributes")
private ClusterAttributes attributes;
@@ -63,8 +67,11 @@ public class EventDetails {
private String instanceId;
/**
- * Unique identifier of the specific job run associated with this cluster event * For clusters
- * created for jobs, this will be the same as the cluster name
+ * Unique identifier of the specific job run associated with this cluster event
+ *
+ *
+ *
*/
@JsonProperty("job_run_name")
private String jobRunName;
@@ -82,8 +89,13 @@ public class EventDetails {
private Long previousDiskSize;
/**
- * A termination reason: * On a TERMINATED event, this is the reason of the termination. * On a
- * RESIZE_COMPLETE event, this indicates the reason that we failed to acquire some nodes.
+ * A termination reason:
+ *
+ *
+ *
*/
@JsonProperty("reason")
private TerminationReason reason;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcpAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcpAttributes.java
index 33acb0da6..f05a7b851 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcpAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcpAttributes.java
@@ -30,13 +30,13 @@ public class GcpAttributes {
private ConfidentialComputeType confidentialComputeType;
/**
- * The first `first_on_demand` nodes of the cluster will be placed on on-demand instances. This
- * value should be greater than 0, to make sure the cluster driver node is placed on an on-demand
- * instance. If this value is greater than or equal to the current cluster size, all nodes will be
- * placed on on-demand instances. If this value is less than the current cluster size,
- * `first_on_demand` nodes will be placed on on-demand instances and the remainder will be placed
- * on `availability` instances. Note that this value does not affect cluster size and cannot
- * currently be mutated over the lifetime of a cluster.
+ * The first {@code first_on_demand} nodes of the cluster will be placed on on-demand instances.
+ * This value should be greater than 0, to make sure the cluster driver node is placed on an
+ * on-demand instance. If this value is greater than or equal to the current cluster size, all
+ * nodes will be placed on on-demand instances. If this value is less than the current cluster
+ * size, {@code first_on_demand} nodes will be placed on on-demand instances and the remainder
+ * will be placed on {@code availability} instances. Note that this value does not affect cluster
+ * size and cannot currently be mutated over the lifetime of a cluster.
*/
@JsonProperty("first_on_demand")
private Long firstOnDemand;
@@ -51,11 +51,9 @@ public class GcpAttributes {
/**
* If provided, each node (workers and driver) in the cluster will have this number of local SSDs
- * attached. Each local SSD is 375GB in size. Refer to [GCP documentation] for the supported
- * number of local SSDs for each instance type.
- *
- *
+ *
*/
@JsonProperty("zone_id")
private String zoneId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcsStorageInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcsStorageInfo.java
index 819a421ef..392111219 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcsStorageInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GcsStorageInfo.java
@@ -10,7 +10,7 @@
/** A storage location in Google Cloud Platform's GCS */
@Generated
public class GcsStorageInfo {
- /** GCS destination/URI, e.g. `gs://my-bucket/some-prefix` */
+ /** GCS destination/URI, e.g. {@code gs://my-bucket/some-prefix} */
@JsonProperty("destination")
private String destination;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
index 815a259cf..7777a3eb7 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
@@ -27,23 +27,24 @@ public class GetInstancePool {
/**
* Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS instances
- * and EBS volumes) with these tags in addition to `default_tags`. Notes:
+ * and EBS volumes) with these tags in addition to {@code default_tags}. Notes:
*
- *
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("default_tags")
private Map
+ *
*/
@JsonProperty("custom_tags")
private Map
+ *
*/
@JsonProperty("default_tags")
private Map
+ *
*
*
+ *
*/
@Generated
public enum InstancePoolState {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfile.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfile.java
index 4c2efe75b..fd3ed128e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfile.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstanceProfile.java
@@ -12,11 +12,10 @@ public class InstanceProfile {
/**
* The AWS IAM role ARN of the role associated with the instance profile. This field is required
* if your role name and instance profile name do not match and you want to use the instance
- * profile with [Databricks SQL Serverless].
+ * profile with Databricks SQL
+ * Serverless.
*
*
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*/
public Iterable
+ *
*/
ClusterLibraryStatuses clusterStatus(ClusterStatus clusterStatus);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
index f1be94bae..ad8535028 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
@@ -22,39 +22,43 @@ public class Library {
/**
* URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog
- * Volumes paths, and S3 URIs. For example: `{ "jar": "/Workspace/path/to/library.jar" }`, `{
- * "jar" : "/Volumes/path/to/library.jar" }` or `{ "jar": "s3://my-bucket/library.jar" }`. If S3
- * is used, please make sure the cluster has read access on the library. You may need to launch
- * the cluster with an IAM role to access the S3 URI.
+ * Volumes paths, and S3 URIs. For example: {@code { "jar": "/Workspace/path/to/library.jar" }},
+ * {@code { "jar" : "/Volumes/path/to/library.jar" }} or {@code { "jar":
+ * "s3://my-bucket/library.jar" }}. If S3 is used, please make sure the cluster has read access on
+ * the library. You may need to launch the cluster with an IAM role to access the S3 URI.
*/
@JsonProperty("jar")
private String jar;
/**
- * Specification of a maven library to be installed. For example: `{ "coordinates":
- * "org.jsoup:jsoup:1.7.2" }`
+ * Specification of a maven library to be installed. For example: {@code { "coordinates":
+ * "org.jsoup:jsoup:1.7.2" }}
*/
@JsonProperty("maven")
private MavenLibrary maven;
- /** Specification of a PyPi library to be installed. For example: `{ "package": "simplejson" }` */
+ /**
+ * Specification of a PyPi library to be installed. For example: {@code { "package": "simplejson"
+ * }}
+ */
@JsonProperty("pypi")
private PythonPyPiLibrary pypi;
/**
* URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes
- * paths are supported. For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }`
- * or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`
+ * paths are supported. For example: {@code { "requirements":
+ * "/Workspace/path/to/requirements.txt" }} or {@code { "requirements" :
+ * "/Volumes/path/to/requirements.txt" }}
*/
@JsonProperty("requirements")
private String requirements;
/**
* URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog
- * Volumes paths, and S3 URIs. For example: `{ "whl": "/Workspace/path/to/library.whl" }`, `{
- * "whl" : "/Volumes/path/to/library.whl" }` or `{ "whl": "s3://my-bucket/library.whl" }`. If S3
- * is used, please make sure the cluster has read access on the library. You may need to launch
- * the cluster with an IAM role to access the S3 URI.
+ * Volumes paths, and S3 URIs. For example: {@code { "whl": "/Workspace/path/to/library.whl" }},
+ * {@code { "whl" : "/Volumes/path/to/library.whl" }} or {@code { "whl":
+ * "s3://my-bucket/library.whl" }}. If S3 is used, please make sure the cluster has read access on
+ * the library. You may need to launch the cluster with an IAM role to access the S3 URI.
*/
@JsonProperty("whl")
private String whl;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListAvailableZonesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListAvailableZonesResponse.java
index aa7b0a6dd..687cac78e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListAvailableZonesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListAvailableZonesResponse.java
@@ -10,7 +10,7 @@
@Generated
public class ListAvailableZonesResponse {
- /** The availability zone if no ``zone_id`` is provided in the cluster creation request. */
+ /** The availability zone if no {@code zone_id} is provided in the cluster creation request. */
@JsonProperty("default_zone")
private String defaultZone;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterCompliancesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterCompliancesRequest.java
index 33e7f38f8..dac9f7dfc 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterCompliancesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterCompliancesRequest.java
@@ -20,7 +20,7 @@ public class ListClusterCompliancesRequest {
/**
* A page token that can be used to navigate to the next page or previous page as returned by
- * `next_page_token` or `prev_page_token`.
+ * {@code next_page_token} or {@code prev_page_token}.
*/
@JsonIgnore
@QueryParam("page_token")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterPoliciesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterPoliciesRequest.java
index ee797f3c2..41eb45d1e 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterPoliciesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ListClusterPoliciesRequest.java
@@ -11,16 +11,24 @@
@Generated
public class ListClusterPoliciesRequest {
/**
- * The cluster policy attribute to sort by. * `POLICY_CREATION_TIME` - Sort result list by policy
- * creation time. * `POLICY_NAME` - Sort result list by policy name.
+ * The cluster policy attribute to sort by.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("sort_column")
private ListSortColumn sortColumn;
/**
- * The order in which the policies get listed. * `DESC` - Sort result list in descending order. *
- * `ASC` - Sort result list in ascending order.
+ * The order in which the policies get listed.
+ *
+ *
+ *
*/
@JsonIgnore
@QueryParam("sort_order")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LocalFileInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LocalFileInfo.java
index 1e5531b5f..f44c317ba 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LocalFileInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LocalFileInfo.java
@@ -9,7 +9,7 @@
@Generated
public class LocalFileInfo {
- /** local file destination, e.g. `file:/my/local/file.sh` */
+ /** local file destination, e.g. {@code file:/my/local/file.sh} */
@JsonProperty("destination")
private String destination;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogSyncStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogSyncStatus.java
index 9bd528bc4..cd31c3f8b 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogSyncStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogSyncStatus.java
@@ -11,8 +11,8 @@
@Generated
public class LogSyncStatus {
/**
- * The timestamp of last attempt. If the last attempt fails, `last_exception` will contain the
- * exception in the last attempt.
+ * The timestamp of last attempt. If the last attempt fails, {@code last_exception} will contain
+ * the exception in the last attempt.
*/
@JsonProperty("last_attempted")
private Long lastAttempted;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
index a33b0e227..b98721e6f 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
@@ -15,7 +15,7 @@ public class MavenLibrary {
private String coordinates;
/**
- * List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`.
+ * List of dependences to exclude. For example: {@code ["slf4j:slf4j", "*:hadoop-client"]}.
*
*
+ *
*/
@JsonProperty("fileName")
private String fileName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/S3StorageInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/S3StorageInfo.java
index de453f1ca..0f2950701 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/S3StorageInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/S3StorageInfo.java
@@ -11,52 +11,52 @@
@Generated
public class S3StorageInfo {
/**
- * (Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`. If
- * `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on
- * the destination bucket and prefix. The full list of possible canned acl can be found at
- * http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl. Please also note
- * that by default only the object owner gets full controls. If you are using cross account role
- * for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to
- * read the logs.
+ * (Optional) Set canned access control list for the logs, e.g. {@code bucket-owner-full-control}.
+ * If {@code canned_cal} is set, please make sure the cluster iam role has {@code s3:PutObjectAcl}
+ * permission on the destination bucket and prefix. The full list of possible canned acl can be
+ * found at http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl. Please
+ * also note that by default only the object owner gets full controls. If you are using cross
+ * account role for writing data, you may want to set {@code bucket-owner-full-control} to make
+ * bucket owner able to read the logs.
*/
@JsonProperty("canned_acl")
private String cannedAcl;
/**
- * S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using
+ * S3 destination, e.g. {@code s3://my-bucket/some-prefix} Note that logs will be delivered using
* cluster iam role, please make sure you set cluster iam role and the role has write access to
* the destination. Please also note that you cannot use AWS keys to deliver logs.
*/
@JsonProperty("destination")
private String destination;
- /** (Optional) Flag to enable server side encryption, `false` by default. */
+ /** (Optional) Flag to enable server side encryption, {@code false} by default. */
@JsonProperty("enable_encryption")
private Boolean enableEncryption;
/**
- * (Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when
- * encryption is enabled and the default type is `sse-s3`.
+ * (Optional) The encryption type, it could be {@code sse-s3} or {@code sse-kms}. It will be used
+ * only when encryption is enabled and the default type is {@code sse-s3}.
*/
@JsonProperty("encryption_type")
private String encryptionType;
/**
- * S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be
- * set. If both are set, endpoint will be used.
+ * S3 endpoint, e.g. {@code https://s3-us-west-2.amazonaws.com}. Either region or endpoint needs
+ * to be set. If both are set, endpoint will be used.
*/
@JsonProperty("endpoint")
private String endpoint;
/**
* (Optional) Kms key which will be used if encryption is enabled and encryption type is set to
- * `sse-kms`.
+ * {@code sse-kms}.
*/
@JsonProperty("kms_key")
private String kmsKey;
/**
- * S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,
+ * S3 region, e.g. {@code us-west-2}. Either region or endpoint needs to be set. If both are set,
* endpoint will be used.
*/
@JsonProperty("region")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/State.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/State.java
index a7714ef95..423f6d04d 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/State.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/State.java
@@ -7,10 +7,18 @@
/**
* The state of a Cluster. The current allowable state transitions are as follows:
*
- *
+ *
*/
@Generated
public enum State {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateCluster.java
index 9d4ea8132..3436d9bc8 100755
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateCluster.java
@@ -22,14 +22,14 @@ public class UpdateCluster {
* https://google.aip.dev/161 for more details.
*
*
+ *
*/
@JsonProperty("custom_tags")
private Map