diff --git a/.codegen/_last_sha b/.codegen/_last_sha index 52897a67d..a9645feac 100644 --- a/.codegen/_last_sha +++ b/.codegen/_last_sha @@ -1 +1 @@ -afa880889a19caeb0dc0fddeca4613cfd803c334 \ No newline at end of file +874d8f1733df5029f169c35ed088d2f081eb6687 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index fb6672ce5..2872f3eb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Version changelog +## Release v0.184.0 (2026-11-19) + +### API Changes +* Add `deleteSoftwareArtifact()` and `deleteSoftwareArtifactVersion()` methods for `workspaceClient.softwareArtifacts()` service. +* Add `HIGH` enum value for `com.databricks.sdk.service.jobs.AiRuntimeTaskPriorityClass`. +* [Breaking] Remove `BEST_EFFORT` enum value for `com.databricks.sdk.service.jobs.AiRuntimeTaskPriorityClass`. + ## Release v0.183.0 (2026-11-18) ### API Changes diff --git a/databricks-sdk-java/lockfile.json b/databricks-sdk-java/lockfile.json index 61f3ed9e6..8c4cb75dc 100644 --- a/databricks-sdk-java/lockfile.json +++ b/databricks-sdk-java/lockfile.json @@ -1,7 +1,7 @@ { "artifactId": "databricks-sdk-java", "groupId": "com.databricks", - "version": "0.183.0", + "version": "0.184.0", "lockFileVersion": 1, "dependencies": [ { diff --git a/databricks-sdk-java/pom.xml b/databricks-sdk-java/pom.xml index 76e342636..2eb72b272 100644 --- a/databricks-sdk-java/pom.xml +++ b/databricks-sdk-java/pom.xml @@ -5,7 +5,7 @@ com.databricks databricks-sdk-parent - 0.183.0 + 0.184.0 databricks-sdk-java Databricks SDK for Java diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java index 49bbaa370..4bf7a3a06 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java @@ -36,7 +36,7 @@ public String getValue() { // TODO: check if reading from // /META-INF/maven/com.databricks/databrics-sdk-java/pom.properties // or getClass().getPackage().getImplementationVersion() is enough. - private static final String version = "0.183.0"; + private static final String version = "0.184.0"; public static void withProduct(String product, String productVersion) { UserAgent.product = product; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitAPI.java index ccc63b026..e3a26ea15 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitAPI.java @@ -42,7 +42,8 @@ public ClearSessionItemsResponse clearSessionItems(ClearSessionItemsRequest requ * service generates one when it is omitted. Returns `ALREADY_EXISTS` when an entry with the same * actor, session, and path already exists. Omitted `session_id` is its own uniqueness key: two * omitted-session entries with the same actor and path conflict, but an omitted-session entry - * does not conflict with a session-scoped entry at the same actor and path. + * does not conflict with a session-scoped entry at the same actor and path. `session_id` is + * deprecated: once it is ignored, the uniqueness key becomes actor and path. */ public ManagedMemoryEntry createMemory(CreateManagedMemoryEntryRequest request) { return impl.createMemory(request); @@ -220,8 +221,8 @@ public Iterable listMemories(String parent, String actorId) /** * Lists memory entries for one actor. An exact `path` filters entries across sessions, ignoring - * session metadata. Otherwise, `session_id` and `path_prefix` restrict the actor partition. - * `view` controls whether each returned entry includes memory content. + * session metadata. Otherwise, `path_prefix` and the deprecated `session_id` restrict the actor + * partition. `view` controls whether each returned entry includes memory content. */ public Iterable listMemories(ListManagedMemoryEntriesRequest request) { return Paginator.newTokenPagination( diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitService.java index 912ec532d..388ddcf8a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/AgentKitService.java @@ -25,7 +25,8 @@ AppendSessionItemsResponse appendSessionItems( * service generates one when it is omitted. Returns `ALREADY_EXISTS` when an entry with the same * actor, session, and path already exists. Omitted `session_id` is its own uniqueness key: two * omitted-session entries with the same actor and path conflict, but an omitted-session entry - * does not conflict with a session-scoped entry at the same actor and path. + * does not conflict with a session-scoped entry at the same actor and path. `session_id` is + * deprecated: once it is ignored, the uniqueness key becomes actor and path. */ ManagedMemoryEntry createMemory(CreateManagedMemoryEntryRequest createManagedMemoryEntryRequest); @@ -124,8 +125,8 @@ GrantSessionStorePermissionResponse grantSessionStorePermission( /** * Lists memory entries for one actor. An exact `path` filters entries across sessions, ignoring - * session metadata. Otherwise, `session_id` and `path_prefix` restrict the actor partition. - * `view` controls whether each returned entry includes memory content. + * session metadata. Otherwise, `path_prefix` and the deprecated `session_id` restrict the actor + * partition. `view` controls whether each returned entry includes memory content. */ ListManagedMemoryEntriesResponse listMemories( ListManagedMemoryEntriesRequest listManagedMemoryEntriesRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ListManagedMemoryEntriesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ListManagedMemoryEntriesRequest.java index 869ea29e9..c309bfd01 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ListManagedMemoryEntriesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ListManagedMemoryEntriesRequest.java @@ -39,8 +39,9 @@ public class ListManagedMemoryEntriesRequest { private String pathPrefix; /** - * Optional session identifier. When set, only entries with this exact `session_id` are returned. - * Omitted-session (cross-session) entries are not included. Ignored when path is set. + * Deprecated: the service will ignore this filter. Until then, when set, only entries with this + * exact `session_id` are returned, and omitted-session (cross-session) entries are not included. + * Ignored when path is set. */ @JsonIgnore @QueryParam("session_id") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ManagedMemoryEntry.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ManagedMemoryEntry.java index 7a9ecc275..152c22be1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ManagedMemoryEntry.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/ManagedMemoryEntry.java @@ -36,15 +36,17 @@ public class ManagedMemoryEntry { private String name; /** - * Absolute, case-sensitive path identifying the entry within its actor and optional session. - * Paths must begin with `/` and must not contain empty, `.` or `..` segments. + * Absolute, case-sensitive path identifying the entry within its actor and, until the deprecated + * `session_id` is ignored, its optional session. Paths must begin with `/` and must not contain + * empty, `.` or `..` segments. */ @JsonProperty("path") private String path; /** - * Optional identifier for the session associated with this memory entry. When omitted, the entry - * applies across the actor's sessions. + * Deprecated: memory entries will be identified by `(actor_id, path)`, and the service will + * ignore this field on writes and omit it from responses. Until then, an omitted value means the + * entry applies across the actor's sessions. */ @JsonProperty("session_id") private String sessionId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/SearchManagedMemoryEntriesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/SearchManagedMemoryEntriesRequest.java index 223105023..a913d9964 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/SearchManagedMemoryEntriesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/agentkit/SearchManagedMemoryEntriesRequest.java @@ -54,8 +54,8 @@ public class SearchManagedMemoryEntriesRequest { private String query; /** - * Optional session identifier. When set, only entries with this exact `session_id` are searched. - * Omitted-session (cross-session) entries are not included. + * Deprecated: the service will ignore this filter. Until then, when set, only entries with this + * exact `session_id` are searched, and omitted-session (cross-session) entries are not included. */ @JsonProperty("session_id") private String sessionId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiClassifyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiClassifyRequest.java index 911080e63..b18181e84 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiClassifyRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiClassifyRequest.java @@ -20,7 +20,8 @@ public class AiClassifyRequest { /** * The label set to classify as. Either a JSON array of label strings (e.g. ["spam", "not_spam"]), * or a JSON object mapping each label to a description (e.g. {"spam": "unsolicited bulk message", - * "not_spam": "a legitimate message"}). Accepts 2 to 500 labels, each 1 to 100 characters. + * "not_spam": "a legitimate message"}). Accepts 2 to 500 labels, each 1 to 100 characters. When + * multilabel is true, a single label is also accepted. */ @JsonProperty("labels") private JsonNode labels; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiDecideOptions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiDecideOptions.java index 2c1930ca3..84d9add93 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiDecideOptions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiDecideOptions.java @@ -10,7 +10,10 @@ /** ai_decide */ @Generated public class AiDecideOptions { - /** The function API version to invoke. Defaults to "1.0". Supported versions: ["1.0"]. */ + /** + * The function API version to invoke. If unset, the version is inferred per row. Supported + * versions: ["1.0"]. + */ @JsonProperty("version") private String version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsAPI.java index f5bd0673b..26fbbf780 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsAPI.java @@ -36,6 +36,8 @@ public AiClassifyResponse aiClassify(AiClassifyRequest request) { /** * Turn text and structured data into decisions your application can use. Define questions and * criteria to choose an option, estimate a probability, or assign a score given a provided state. + * For REST API requests, the default rate limit is 1,200 requests per minute per workspace. + * Contact your Databricks account team to request a higher limit. */ public AiDecideResponse aiDecide(AiDecideRequest request) { return impl.aiDecide(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsService.java index 3081a509b..97c5eba33 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/AiFunctionsService.java @@ -22,6 +22,8 @@ public interface AiFunctionsService { /** * Turn text and structured data into decisions your application can use. Define questions and * criteria to choose an option, estimate a probability, or assign a score given a provided state. + * For REST API requests, the default rate limit is 1,200 requests per minute per workspace. + * Contact your Databricks account team to request a higher limit. */ AiDecideResponse aiDecide(AiDecideRequest aiDecideRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardRequest.java index 329e8b7a8..aa130a357 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardRequest.java @@ -11,16 +11,23 @@ public class CreateBillingUsageDashboardRequest { /** * Workspace level usage dashboard shows usage data for the specified workspace ID. Global level - * usage dashboard shows usage data for all workspaces in the account. + * usage dashboard shows usage data for all workspaces in the account. The request fails if the + * type is not set. */ @JsonProperty("dashboard_type") private UsageDashboardType dashboardType; - /** The major version of the usage dashboard template to use. Defaults to VERSION_1. */ + /** + * The major version of the usage dashboard template to import. Version 2 adds cost forecasting + * and object-level cost drill-down. + */ @JsonProperty("major_version") private UsageDashboardMajorVersion majorVersion; - /** The workspace ID of the workspace in which the usage dashboard is created. */ + /** + * The ID of the workspace to import the usage dashboard into. The workspace must be running, + * belong to the account, and not be a disaster recovery secondary. + */ @JsonProperty("workspace_id") private Long workspaceId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardResponse.java index f70b18fb1..b46ff2bf8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBillingUsageDashboardResponse.java @@ -9,7 +9,7 @@ @Generated public class CreateBillingUsageDashboardResponse { - /** The unique id of the usage dashboard. */ + /** The ID of the AI/BI dashboard that was created. */ @JsonProperty("dashboard_id") private String dashboardId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardRequest.java index 67b8f9d66..f039b4e62 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardRequest.java @@ -12,13 +12,17 @@ public class GetBillingUsageDashboardRequest { /** * Workspace level usage dashboard shows usage data for the specified workspace ID. Global level - * usage dashboard shows usage data for all workspaces in the account. + * usage dashboard shows usage data for all workspaces in the account. The request fails if the + * type is not set. */ @JsonIgnore @QueryParam("dashboard_type") private UsageDashboardType dashboardType; - /** The workspace ID of the workspace in which the usage dashboard is created. */ + /** + * The ID of the workspace that contains the usage dashboard. If omitted, the most recently + * created dashboard of the given type across all workspaces in the account is returned. + */ @JsonIgnore @QueryParam("workspace_id") private Long workspaceId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardResponse.java index 5030e3c6f..7d00f9e3a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBillingUsageDashboardResponse.java @@ -9,11 +9,13 @@ @Generated public class GetBillingUsageDashboardResponse { - /** The unique id of the usage dashboard. */ + /** The ID of the AI/BI dashboard. The ID is empty if no matching dashboard is found. */ @JsonProperty("dashboard_id") private String dashboardId; - /** The URL of the usage dashboard. */ + /** + * The URL of the dashboard in its workspace. The URL is empty if no matching dashboard is found. + */ @JsonProperty("dashboard_url") private String dashboardUrl; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsAPI.java index ca830d2a1..650b0212d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsAPI.java @@ -27,12 +27,21 @@ public UsageDashboardsAPI(UsageDashboardsService mock) { impl = mock; } - /** Create a usage dashboard specified by workspaceId, accountId, and dashboard type. */ + /** + * Imports a pre-built usage dashboard of the given type into a workspace. Each call imports a new + * dashboard, even if the caller already created one of the same type in that workspace. The + * caller must be an account admin and a user of the target workspace. See + * https://docs.databricks.com/admin/account-settings/usage.html. + */ public CreateBillingUsageDashboardResponse create(CreateBillingUsageDashboardRequest request) { return impl.create(request); } - /** Get a usage dashboard specified by workspaceId, accountId, and dashboard type. */ + /** + * Gets the most recent usage dashboard of the given type that the caller created. The response is + * empty if no such dashboard exists, if it has been deleted, or if the caller can no longer + * access its workspace. + */ public GetBillingUsageDashboardResponse get(GetBillingUsageDashboardRequest request) { return impl.get(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsService.java index 832cfbc1a..857ac1328 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UsageDashboardsService.java @@ -14,11 +14,20 @@ */ @Generated public interface UsageDashboardsService { - /** Create a usage dashboard specified by workspaceId, accountId, and dashboard type. */ + /** + * Imports a pre-built usage dashboard of the given type into a workspace. Each call imports a new + * dashboard, even if the caller already created one of the same type in that workspace. The + * caller must be an account admin and a user of the target workspace. See + * https://docs.databricks.com/admin/account-settings/usage.html. + */ CreateBillingUsageDashboardResponse create( CreateBillingUsageDashboardRequest createBillingUsageDashboardRequest); - /** Get a usage dashboard specified by workspaceId, accountId, and dashboard type. */ + /** + * Gets the most recent usage dashboard of the given type that the caller created. The response is + * empty if no such dashboard exists, if it has been deleted, or if the caller can no longer + * access its workspace. + */ GetBillingUsageDashboardResponse get( GetBillingUsageDashboardRequest getBillingUsageDashboardRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionInfo.java index 25e31a687..a98ffbdb5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ConnectionInfo.java @@ -18,7 +18,10 @@ public class ConnectionInfo { @JsonProperty("connection_id") private String connectionId; - /** The type of connection. */ + /** + * The type of external data source or service that the connection reaches. The connection type + * determines which keys are required in options and cannot be changed after creation. + */ @JsonProperty("connection_type") private ConnectionType connectionType; @@ -30,11 +33,17 @@ public class ConnectionInfo { @JsonProperty("created_by") private String createdBy; - /** The type of credential. */ + /** + * The type of credential that is used to authenticate to the external data source. The server + * derives it from the connection type and the keys present in options. + */ @JsonProperty("credential_type") private CredentialType credentialType; - /** [Create,Update:OPT] Connection environment settings as EnvironmentSettings object. */ + /** + * Environment settings for the connection, such as the Java libraries that it needs and the + * environment version. + */ @JsonProperty("environment_settings") private EnvironmentSettings environmentSettings; @@ -54,7 +63,10 @@ public class ConnectionInfo { @JsonProperty("options") private Map options; - /** Username of current owner of the connection. */ + /** + * Username of the current owner of the connection. The creator becomes the owner at creation, and + * ownership can be transferred on update. + */ @JsonProperty("owner") private String owner; @@ -62,11 +74,14 @@ public class ConnectionInfo { @JsonProperty("properties") private Map properties; - /** */ + /** Provisioning status of the connection. */ @JsonProperty("provisioning_info") private ProvisioningInfo provisioningInfo; - /** If the connection is read only. */ + /** + * Whether the connection is read only. All connections are currently read only, so a value set on + * create or update is ignored. + */ @JsonProperty("read_only") private Boolean readOnly; @@ -77,7 +92,7 @@ public class ConnectionInfo { @JsonProperty("secrets") private Map secrets; - /** */ + /** The type of Unity Catalog securable. This is always CONNECTION. */ @JsonProperty("securable_type") private SecurableType securableType; @@ -89,7 +104,7 @@ public class ConnectionInfo { @JsonProperty("updated_by") private String updatedBy; - /** URL of the remote data source, extracted from options. */ + /** URL of the remote data source. The server derives it from the host, port and path options. */ @JsonProperty("url") private String url; 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 117f5f140..7fb0466c4 100644 --- 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 @@ -56,7 +56,7 @@ public ConnectionInfo get(String name) { return get(new GetConnectionRequest().setName(name)); } - /** Gets a connection from it's name. */ + /** Gets a connection from its name. */ public ConnectionInfo get(GetConnectionRequest request) { return impl.get(request); } @@ -90,7 +90,10 @@ public Iterable list(ListConnectionsRequest request) { }); } - /** Updates the connection that matches the supplied name. */ + /** + * Updates the connection that matches the supplied name. When options are provided, they replace + * the existing options of the connection, so include every key that the connection type requires. + */ public ConnectionInfo update(UpdateConnection request) { return impl.update(request); } 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 b130072e5..0b3754080 100644 --- 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 @@ -30,7 +30,7 @@ public interface ConnectionsService { /** Deletes the connection that matches the supplied name. */ void delete(DeleteConnectionRequest deleteConnectionRequest); - /** Gets a connection from it's name. */ + /** Gets a connection from its name. */ ConnectionInfo get(GetConnectionRequest getConnectionRequest); /** @@ -46,6 +46,9 @@ public interface ConnectionsService { */ ListConnectionsResponse list(ListConnectionsRequest listConnectionsRequest); - /** Updates the connection that matches the supplied name. */ + /** + * Updates the connection that matches the supplied name. When options are provided, they replace + * the existing options of the connection, so include every key that the connection type requires. + */ ConnectionInfo update(UpdateConnection updateConnection); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateConnection.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateConnection.java index c8e4bb602..6e4e648e7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateConnection.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateConnection.java @@ -14,11 +14,17 @@ public class CreateConnection { @JsonProperty("comment") private String comment; - /** The type of connection. */ + /** + * The type of external data source or service that the connection reaches. The connection type + * determines which keys are required in options and cannot be changed after creation. + */ @JsonProperty("connection_type") private ConnectionType connectionType; - /** [Create,Update:OPT] Connection environment settings as EnvironmentSettings object. */ + /** + * Environment settings for the connection, such as the Java libraries that it needs and the + * environment version. + */ @JsonProperty("environment_settings") private EnvironmentSettings environmentSettings; @@ -41,7 +47,10 @@ public class CreateConnection { @JsonProperty("properties") private Map properties; - /** If the connection is read only. */ + /** + * Whether the connection is read only. All connections are currently read only, so a value set on + * create or update is ignored. + */ @JsonProperty("read_only") private Boolean readOnly; 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 41520e074..208060839 100644 --- 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 @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A user-defined function (UDF) registered in Unity Catalog. A function belongs to a schema and is + * referenced as catalog_name.schema_name.function_name. Its body is either a SQL expression or + * query, or source code in an external language such as Python. See + * https://docs.databricks.com/aws/en/udf/unity-catalog for an overview. + */ @Generated public class CreateFunction { /** Name of parent Catalog. */ @@ -17,31 +23,50 @@ public class CreateFunction { @JsonProperty("comment") private String comment; - /** Scalar function return data type. */ + /** + * Data type of the value the function returns. A table function uses TABLE_TYPE and describes its + * result columns in return_params, except for a polymorphic Python UDTF, which omits them. + */ @JsonProperty("data_type") private ColumnTypeName dataType; - /** External function language. */ + /** + * Language of the function body for an EXTERNAL function. It is required when routine_body is + * EXTERNAL. + */ @JsonProperty("external_language") private String externalLanguage; - /** External function name. */ + /** Name of the function in its external language. It is reserved for future use. */ @JsonProperty("external_name") private String externalName; - /** Pretty printed function data type. */ + /** + * Return data type of the function in SQL syntax, including any type parameters such as precision + * and scale. + */ @JsonProperty("full_data_type") private String fullDataType; - /** Function input parameters. */ + /** + * Input parameters of the function. When it is set, parameters must contain at least one entry. A + * function that takes no arguments omits input_params, even though the Create request schema + * marks it as required. + */ @JsonProperty("input_params") private FunctionParameterInfos inputParams; - /** Whether the function is deterministic. */ + /** + * Whether the function returns the same result for the same arguments. It corresponds to the + * DETERMINISTIC characteristic of CREATE FUNCTION. + */ @JsonProperty("is_deterministic") private Boolean isDeterministic; - /** Function null call. */ + /** + * Whether the function is a null-call function in the sense of the SQL standard, which returns + * NULL whenever any argument is NULL. + */ @JsonProperty("is_null_call") private Boolean isNullCall; @@ -49,7 +74,10 @@ public class CreateFunction { @JsonProperty("name") private String name; - /** Function parameter style. **S** is the value for SQL. */ + /** + * How arguments are passed to the function body. S means that each argument is passed as a single + * scalar value. + */ @JsonProperty("parameter_style") private CreateFunctionParameterStyle parameterStyle; @@ -57,20 +85,27 @@ public class CreateFunction { @JsonProperty("properties") private String properties; - /** Table function return parameters. */ + /** + * Result columns of a table function. Set it when data_type is TABLE_TYPE, except for a + * polymorphic Python UDTF (an EXTERNAL Python function with full_data_type "()"), which must not + * set it. + */ @JsonProperty("return_params") 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**. + * Language of the function body. SQL means that routine_definition holds a SQL expression or + * query. EXTERNAL means that it holds source code in the language named by external_language, and + * sql_data_access must then be NO_SQL. */ @JsonProperty("routine_body") private CreateFunctionRoutineBody routineBody; - /** Function body. */ + /** + * Body of the function. For a SQL function it is the expression or query that computes the + * result; for an EXTERNAL function it is the source code of the function. It is omitted when the + * caller can only browse the function. + */ @JsonProperty("routine_definition") private String routineDefinition; @@ -85,19 +120,26 @@ public class CreateFunction { @JsonProperty("schema_name") private String schemaName; - /** Function security type. */ + /** + * Whose privileges the function body runs with. DEFINER runs it with the privileges of the + * function owner. + */ @JsonProperty("security_type") private CreateFunctionSecurityType securityType; - /** Specific name of the function; Reserved for future use. */ + /** Specific name of the function. Set it to the same value as name. */ @JsonProperty("specific_name") private String specificName; - /** Function SQL data access. */ + /** + * How the function body interacts with SQL data. CONTAINS_SQL means that the body contains SQL + * but reads no table or view, READS_SQL_DATA means that it reads a table or view, and NO_SQL is + * required for EXTERNAL functions. + */ @JsonProperty("sql_data_access") private CreateFunctionSqlDataAccess sqlDataAccess; - /** List of schemes whose objects can be referenced without qualification. */ + /** List of schemas whose objects can be referenced without qualification. */ @JsonProperty("sql_path") private String sqlPath; 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 137032b91..7bf26d2ed 100644 --- 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 @@ -58,8 +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 - * credential. + * caller must be a metastore admin or have the **ACCESS** privilege on the service credential. */ public TemporaryCredentials generateTemporaryServiceCredential( GenerateTemporaryServiceCredentialRequest 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 8b1c71a97..c2f8f3252 100644 --- 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 @@ -36,8 +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 - * credential. + * caller must be a metastore admin or have the **ACCESS** privilege on the service credential. */ TemporaryCredentials generateTemporaryServiceCredential( GenerateTemporaryServiceCredentialRequest generateTemporaryServiceCredentialRequest); 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..abba69dd8 100644 --- 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 @@ -10,14 +10,14 @@ @Generated public class DeleteFunctionRequest { - /** Force deletion even if the function is notempty. */ + /** Force deletion even if the function is not empty. */ @JsonIgnore @QueryParam("force") private Boolean force; /** * 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/FunctionInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionInfo.java index 61c9ec17f..f8e415d64 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionInfo.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A user-defined function (UDF) registered in Unity Catalog. A function belongs to a schema and is + * referenced as catalog_name.schema_name.function_name. Its body is either a SQL expression or + * query, or source code in an external language such as Python. See + * https://docs.databricks.com/aws/en/udf/unity-catalog for an overview. + */ @Generated public class FunctionInfo { /** @@ -32,19 +38,28 @@ public class FunctionInfo { @JsonProperty("created_by") private String createdBy; - /** Scalar function return data type. */ + /** + * Data type of the value the function returns. A table function uses TABLE_TYPE and describes its + * result columns in return_params, except for a polymorphic Python UDTF, which omits them. + */ @JsonProperty("data_type") private ColumnTypeName dataType; - /** External function language. */ + /** + * Language of the function body for an EXTERNAL function. It is required when routine_body is + * EXTERNAL. + */ @JsonProperty("external_language") private String externalLanguage; - /** External function name. */ + /** Name of the function in its external language. It is reserved for future use. */ @JsonProperty("external_name") private String externalName; - /** Pretty printed function data type. */ + /** + * Return data type of the function in SQL syntax, including any type parameters such as precision + * and scale. + */ @JsonProperty("full_data_type") private String fullDataType; @@ -56,15 +71,25 @@ public class FunctionInfo { @JsonProperty("function_id") private String functionId; - /** Function input parameters. */ + /** + * Input parameters of the function. When it is set, parameters must contain at least one entry. A + * function that takes no arguments omits input_params, even though the Create request schema + * marks it as required. + */ @JsonProperty("input_params") private FunctionParameterInfos inputParams; - /** Whether the function is deterministic. */ + /** + * Whether the function returns the same result for the same arguments. It corresponds to the + * DETERMINISTIC characteristic of CREATE FUNCTION. + */ @JsonProperty("is_deterministic") private Boolean isDeterministic; - /** Function null call. */ + /** + * Whether the function is a null-call function in the sense of the SQL standard, which returns + * NULL whenever any argument is NULL. + */ @JsonProperty("is_null_call") private Boolean isNullCall; @@ -80,7 +105,10 @@ public class FunctionInfo { @JsonProperty("owner") private String owner; - /** Function parameter style. **S** is the value for SQL. */ + /** + * How arguments are passed to the function body. S means that each argument is passed as a single + * scalar value. + */ @JsonProperty("parameter_style") private FunctionInfoParameterStyle parameterStyle; @@ -88,20 +116,27 @@ public class FunctionInfo { @JsonProperty("properties") private String properties; - /** Table function return parameters. */ + /** + * Result columns of a table function. Set it when data_type is TABLE_TYPE, except for a + * polymorphic Python UDTF (an EXTERNAL Python function with full_data_type "()"), which must not + * set it. + */ @JsonProperty("return_params") 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**. + * Language of the function body. SQL means that routine_definition holds a SQL expression or + * query. EXTERNAL means that it holds source code in the language named by external_language, and + * sql_data_access must then be NO_SQL. */ @JsonProperty("routine_body") private FunctionInfoRoutineBody routineBody; - /** Function body. */ + /** + * Body of the function. For a SQL function it is the expression or query that computes the + * result; for an EXTERNAL function it is the source code of the function. It is omitted when the + * caller can only browse the function. + */ @JsonProperty("routine_definition") private String routineDefinition; @@ -116,19 +151,26 @@ public class FunctionInfo { @JsonProperty("schema_name") private String schemaName; - /** Function security type. */ + /** + * Whose privileges the function body runs with. DEFINER runs it with the privileges of the + * function owner. + */ @JsonProperty("security_type") private FunctionInfoSecurityType securityType; - /** Specific name of the function; Reserved for future use. */ + /** Specific name of the function. Set it to the same value as name. */ @JsonProperty("specific_name") private String specificName; - /** Function SQL data access. */ + /** + * How the function body interacts with SQL data. CONTAINS_SQL means that the body contains SQL + * but reads no table or view, READS_SQL_DATA means that it reads a table or view, and NO_SQL is + * required for EXTERNAL functions. + */ @JsonProperty("sql_data_access") private FunctionInfoSqlDataAccess sqlDataAccess; - /** List of schemes whose objects can be referenced without qualification. */ + /** List of schemas whose objects can be referenced without qualification. */ @JsonProperty("sql_path") private String sqlPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfo.java index ce5724ef9..0175bb480 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfo.java @@ -17,27 +17,39 @@ public class FunctionParameterInfo { @JsonProperty("name") private String name; - /** Default value of the parameter. */ + /** Default value of the parameter as a SQL expression, used when a call omits the argument. */ @JsonProperty("parameter_default") private String parameterDefault; - /** Function parameter mode. */ + /** + * Direction of the parameter. Only IN parameters, which pass a value into the function, are + * supported. + */ @JsonProperty("parameter_mode") private FunctionParameterMode parameterMode; - /** Function parameter type. */ + /** + * Whether the entry is an input parameter (PARAM) or a result column of a table function + * (COLUMN). + */ @JsonProperty("parameter_type") private FunctionParameterType parameterType; - /** Ordinal position of column (starting at position 0). */ + /** + * Zero-based position of the parameter in the parameter list. Positions must be unique and + * consecutive. + */ @JsonProperty("position") private Long position; - /** Format of IntervalType. */ + /** Unit range of the data type for INTERVAL parameters. It is unset for other types. */ @JsonProperty("type_interval_type") private String typeIntervalType; - /** Full data type spec, JSON-serialized. */ + /** + * Data type of the parameter as the JSON representation of a Spark SQL struct field, with name, + * type, nullable and metadata keys. + */ @JsonProperty("type_json") private String typeJson; @@ -53,7 +65,10 @@ public class FunctionParameterInfo { @JsonProperty("type_scale") private Long typeScale; - /** Full data type spec, SQL/catalogString text. */ + /** + * Data type of the parameter in SQL syntax, including any type parameters such as precision and + * scale. + */ @JsonProperty("type_text") private String typeText; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfos.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfos.java index f2941005c..7d6e2ef6b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfos.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/FunctionParameterInfos.java @@ -10,7 +10,7 @@ @Generated public class FunctionParameterInfos { - /** */ + /** The parameters that make up the list, ordered by position. */ @JsonProperty("parameters") private Collection parameters; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpOauthToken.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpOauthToken.java index 6955e7a2c..2fcb01e81 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpOauthToken.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpOauthToken.java @@ -13,7 +13,7 @@ */ @Generated public class GcpOauthToken { - /** */ + /** The OAuth 2.0 access token to pass as a bearer token to Google Cloud APIs. */ @JsonProperty("oauth_token") private String oauthToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryPathCredentialResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryPathCredentialResponse.java index add0089ea..b07da0590 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryPathCredentialResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryPathCredentialResponse.java @@ -9,15 +9,21 @@ @Generated public class GenerateTemporaryPathCredentialResponse { - /** */ + /** Temporary AWS credentials that can be used to sign AWS API requests. */ @JsonProperty("aws_temp_credentials") private AwsCredentials awsTempCredentials; - /** */ + /** + * A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the + * credential's identity. + */ @JsonProperty("azure_aad") private AzureActiveDirectoryToken azureAad; - /** */ + /** + * An Azure user delegation shared access signature (SAS) that grants access to the requested + * storage path. + */ @JsonProperty("azure_user_delegation_sas") private AzureUserDelegationSas azureUserDelegationSas; @@ -28,11 +34,11 @@ public class GenerateTemporaryPathCredentialResponse { @JsonProperty("expiration_time") private Long expirationTime; - /** */ + /** A GCP OAuth 2.0 access token that is issued for the credential's service account. */ @JsonProperty("gcp_oauth_token") private GcpOauthToken gcpOauthToken; - /** */ + /** Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API. */ @JsonProperty("r2_temp_credentials") private R2Credentials r2TempCredentials; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialAzureOptions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialAzureOptions.java index 7ca999107..19834087f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialAzureOptions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialAzureOptions.java @@ -14,7 +14,8 @@ public class GenerateTemporaryServiceCredentialAzureOptions { /** * The resources to which the temporary Azure credential should apply. These resources are the * scopes that are passed to the token provider (see - * https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python) + * https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python). + * Exactly one resource is supported, and its URL must end with the `.default` scope. */ @JsonProperty("resources") private Collection resources; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialGcpOptions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialGcpOptions.java index b1739a0a9..a48eb514b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialGcpOptions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialGcpOptions.java @@ -14,7 +14,9 @@ public class GenerateTemporaryServiceCredentialGcpOptions { /** * The scopes to which the temporary GCP credential should apply. These resources are the scopes * that are passed to the token provider (see - * https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials) + * https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials). + * Each scope must be a Google OAuth 2.0 scope URL on the `googleapis.com` or `www.googleapis.com` + * host. */ @JsonProperty("scopes") private Collection scopes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialRequest.java index 3a67980a0..ba13585d4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryServiceCredentialRequest.java @@ -9,7 +9,10 @@ @Generated public class GenerateTemporaryServiceCredentialRequest { - /** */ + /** + * Options for an Azure service credential. They are required when the service credential uses an + * Azure managed identity. + */ @JsonProperty("azure_options") private GenerateTemporaryServiceCredentialAzureOptions azureOptions; @@ -17,7 +20,10 @@ public class GenerateTemporaryServiceCredentialRequest { @JsonProperty("credential_name") private String credentialName; - /** */ + /** + * Options for a GCP service credential. They are required when the service credential uses a + * Databricks-managed GCP service account. + */ @JsonProperty("gcp_options") private GenerateTemporaryServiceCredentialGcpOptions gcpOptions; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryTableCredentialResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryTableCredentialResponse.java index 3f1f2cc48..e6190a1f1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryTableCredentialResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryTableCredentialResponse.java @@ -9,15 +9,21 @@ @Generated public class GenerateTemporaryTableCredentialResponse { - /** */ + /** Temporary AWS credentials that can be used to sign AWS API requests. */ @JsonProperty("aws_temp_credentials") private AwsCredentials awsTempCredentials; - /** */ + /** + * A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the + * credential's identity. + */ @JsonProperty("azure_aad") private AzureActiveDirectoryToken azureAad; - /** */ + /** + * An Azure user delegation shared access signature (SAS) that grants access to the requested + * storage path. + */ @JsonProperty("azure_user_delegation_sas") private AzureUserDelegationSas azureUserDelegationSas; @@ -28,11 +34,11 @@ public class GenerateTemporaryTableCredentialResponse { @JsonProperty("expiration_time") private Long expirationTime; - /** */ + /** A GCP OAuth 2.0 access token that is issued for the credential's service account. */ @JsonProperty("gcp_oauth_token") private GcpOauthToken gcpOauthToken; - /** */ + /** Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API. */ @JsonProperty("r2_temp_credentials") private R2Credentials r2TempCredentials; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryVolumeCredentialResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryVolumeCredentialResponse.java index 4b35d5b16..60e253c0f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryVolumeCredentialResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GenerateTemporaryVolumeCredentialResponse.java @@ -9,15 +9,21 @@ @Generated public class GenerateTemporaryVolumeCredentialResponse { - /** */ + /** Temporary AWS credentials that can be used to sign AWS API requests. */ @JsonProperty("aws_temp_credentials") private AwsCredentials awsTempCredentials; - /** */ + /** + * A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the + * credential's identity. + */ @JsonProperty("azure_aad") private AzureActiveDirectoryToken azureAad; - /** */ + /** + * An Azure user delegation shared access signature (SAS) that grants access to the requested + * storage path. + */ @JsonProperty("azure_user_delegation_sas") private AzureUserDelegationSas azureUserDelegationSas; @@ -28,11 +34,11 @@ public class GenerateTemporaryVolumeCredentialResponse { @JsonProperty("expiration_time") private Long expirationTime; - /** */ + /** A GCP OAuth 2.0 access token that is issued for the credential's service account. */ @JsonProperty("gcp_oauth_token") private GcpOauthToken gcpOauthToken; - /** */ + /** Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API. */ @JsonProperty("r2_temp_credentials") private R2Credentials r2TempCredentials; 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..7a1b7afda 100644 --- 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/TemporaryCredentials.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryCredentials.java index 7d2e8803a..2e0d50567 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryCredentials.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TemporaryCredentials.java @@ -9,11 +9,14 @@ @Generated public class TemporaryCredentials { - /** */ + /** Temporary AWS credentials that can be used to sign AWS API requests. */ @JsonProperty("aws_temp_credentials") private AwsCredentials awsTempCredentials; - /** */ + /** + * A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the + * credential's identity. + */ @JsonProperty("azure_aad") private AzureActiveDirectoryToken azureAad; @@ -24,11 +27,11 @@ public class TemporaryCredentials { @JsonProperty("expiration_time") private Long expirationTime; - /** */ + /** A GCP OAuth 2.0 access token that is issued for the credential's service account. */ @JsonProperty("gcp_oauth_token") private GcpOauthToken gcpOauthToken; - /** */ + /** Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API. */ @JsonProperty("r2_temp_credentials") private R2Credentials r2TempCredentials; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateConnection.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateConnection.java index e7e142a30..db3f46bee 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateConnection.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateConnection.java @@ -11,7 +11,10 @@ @Generated public class UpdateConnection { - /** [Create,Update:OPT] Connection environment settings as EnvironmentSettings object. */ + /** + * Environment settings for the connection, such as the Java libraries that it needs and the + * environment version. + */ @JsonProperty("environment_settings") private EnvironmentSettings environmentSettings; @@ -26,7 +29,10 @@ public class UpdateConnection { @JsonProperty("options") private Map options; - /** Username of current owner of the connection. */ + /** + * Username of the current owner of the connection. The creator becomes the owner at creation, and + * ownership can be transferred on update. + */ @JsonProperty("owner") private String owner; 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..796a151f5 100644 --- 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/cleanrooms/CleanRoomAsset.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAsset.java index e9c242a21..2955c884a 100644 --- 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 @@ -33,7 +33,7 @@ public class CleanRoomAsset { private CleanRoomAssetForeignTable foreignTable; /** - * Local details for a foreign that are only available to its owner. Present if and only if + * Local details for a foreign table that are only available to its owner. Present if and only if * **asset_type** is **FOREIGN_TABLE** */ @JsonProperty("foreign_table_local_details") @@ -71,7 +71,11 @@ public class CleanRoomAsset { @JsonProperty("owner_collaborator_alias") private String ownerCollaboratorAlias; - /** Status of the asset */ + /** + * The sharing status of the asset. `PERMISSION_DENIED` means the clean room owner no longer has + * the privileges needed on the underlying Unity Catalog object, so the asset is not shared into + * the clean room. + */ @JsonProperty("status") private CleanRoomAssetStatusEnum status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsAPI.java index 823c0bceb..dcdb748e5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsAPI.java @@ -74,7 +74,10 @@ public Iterable list(String cleanRoomName) { return list(new ListCleanRoomAssetsRequest().setCleanRoomName(cleanRoomName)); } - /** List assets. */ + /** + * List the assets in a clean room. Listed assets do not include their asset-type specific + * details, such as table columns or notebook content; use the get method to retrieve them. + */ public Iterable list(ListCleanRoomAssetsRequest request) { return Paginator.newTokenPagination( request, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsService.java index e1513e38d..1dba47933 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomAssetsService.java @@ -32,7 +32,10 @@ CreateCleanRoomAssetReviewResponse createCleanRoomAssetReview( /** Get the details of a clean room asset by its type and full name. */ CleanRoomAsset get(GetCleanRoomAssetRequest getCleanRoomAssetRequest); - /** List assets. */ + /** + * List the assets in a clean room. Listed assets do not include their asset-type specific + * details, such as table columns or notebook content; use the get method to retrieve them. + */ ListCleanRoomAssetsResponse list(ListCleanRoomAssetsRequest listCleanRoomAssetsRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java index b217767d8..2ab008cf4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java @@ -216,7 +216,12 @@ public GenieMessage genieCancelResponse(GenieCancelResponseRequest request) { return impl.genieCancelResponse(request); } - /** Creates and runs chat-mode evaluations for multiple benchmark questions in a Genie space. */ + /** + * Starts a benchmark evaluation run that asks Genie each selected benchmark question in a Genie + * space and compares every response with the benchmark SQL. The run executes asynchronously: the + * response is the new run with its current status. If it is still running, poll with the get + * method until the status is terminal. + */ public GenieEvalRunResponse genieCreateEvalRun(GenieCreateEvalRunRequest request) { return impl.genieCreateEvalRun(request); } @@ -230,7 +235,11 @@ public GenieEvalResultDetails genieGetEvalResultDetails( .setResultId(resultId)); } - /** Get details for evaluation results. */ + /** + * Gets the full result for one benchmark question in an evaluation run: its assessment and the + * reasons for it, Genie's response with the SQL execution result, and the expected response from + * the benchmark. The result must belong to the given run. + */ public GenieEvalResultDetails genieGetEvalResultDetails( GenieGetEvalResultDetailsRequest request) { return impl.genieGetEvalResultDetails(request); @@ -241,7 +250,10 @@ public GenieEvalRunResponse genieGetEvalRun(String spaceId, String evalRunId) { new GenieGetEvalRunRequest().setSpaceId(spaceId).setEvalRunId(evalRunId)); } - /** Get evaluation run details. */ + /** + * Gets the current status and summary counts of a benchmark evaluation run. Poll this method + * until `eval_run_status` is terminal: DONE, EVALUATION_CANCELLED or EVALUATION_TIMEOUT. + */ public GenieEvalRunResponse genieGetEvalRun(GenieGetEvalRunRequest request) { return impl.genieGetEvalRun(request); } @@ -251,7 +263,11 @@ public GenieListEvalResultsResponse genieListEvalResults(String spaceId, String new GenieListEvalResultsRequest().setSpaceId(spaceId).setEvalRunId(evalRunId)); } - /** List evaluation results for a specific evaluation run. */ + /** + * Lists the results of a benchmark evaluation run, one per benchmark question. Each entry carries + * the result status and a snapshot of the question and benchmark answer; the assessment and + * Genie's response are available through the result details method. + */ public GenieListEvalResultsResponse genieListEvalResults(GenieListEvalResultsRequest request) { return impl.genieListEvalResults(request); } @@ -260,7 +276,10 @@ public GenieListEvalRunsResponse genieListEvalRuns(String spaceId) { return genieListEvalRuns(new GenieListEvalRunsRequest().setSpaceId(spaceId)); } - /** Lists all evaluation runs in a space. */ + /** + * Lists the benchmark evaluation runs in a Genie space with the current status and summary counts + * of each run. + */ public GenieListEvalRunsResponse genieListEvalRuns(GenieListEvalRunsRequest request) { return impl.genieListEvalRuns(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResponse.java index f76f3bc24..c1721777c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResponse.java @@ -9,15 +9,24 @@ @Generated public class GenieEvalResponse { - /** The response content (either text or SQL query). */ + /** + * The content of this entry is the SQL statement when `response_type` is SQL, or Genie's text + * answer when it is TEXT. + */ @JsonProperty("response") private String response; - /** Type of response */ + /** Whether this entry is a SQL statement or a text answer. */ @JsonProperty("response_type") private GenieEvalResponseType responseType; - /** SQL Statement Execution response. */ + /** + * Result of executing the SQL statement, only set when `response_type` is SQL. The value has the + * structure of a [Statement Execution API response]. + * + *

[Statement Execution API response]: + * https://docs.databricks.com/api/statement-execution/v1/get-statement-result + */ @JsonProperty("sql_execution_result") private com.databricks.sdk.service.sql.StatementResponse sqlExecutionResult; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResult.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResult.java index c192150e6..5d999690d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResult.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResult.java @@ -14,7 +14,7 @@ */ @Generated public class GenieEvalResult { - /** Stored snapshot of original benchmark answer text. */ + /** Benchmark SQL statement that defines the expected answer, as it was when the run started. */ @JsonProperty("benchmark_answer") private String benchmarkAnswer; @@ -22,11 +22,14 @@ public class GenieEvalResult { @JsonProperty("benchmark_question_id") private String benchmarkQuestionId; - /** User ID who created evaluation result. */ + /** ID of the user who started the evaluation run. */ @JsonProperty("created_by_user") private Long createdByUser; - /** Stored snapshot of original benchmark question text. */ + /** + * Text of the benchmark question as it was when the run started. Later edits to the question do + * not change it. + */ @JsonProperty("question") private String question; @@ -38,7 +41,13 @@ public class GenieEvalResult { @JsonProperty("space_id") private String spaceId; - /** Current status of this evaluation result. */ + /** + * Current status of this result. NOT_STARTED and RUNNING mean the question has not finished. DONE + * means Genie answered and the response was assessed. EVALUATION_FAILED means Genie could not + * answer the question or the benchmark SQL could not run. EVALUATION_CANCELLED and + * EVALUATION_TIMEOUT mean the run was cancelled or its background job stopped before this + * question finished. + */ @JsonProperty("status") private EvaluationStatusType status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResultDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResultDetails.java index df49b4607..92416c59b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResultDetails.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalResultDetails.java @@ -11,11 +11,19 @@ /** Shows detailed information for an evaluation result. */ @Generated public class GenieEvalResultDetails { - /** The actual response generated by Genie. */ + /** + * Genie's response to the benchmark question. A SQL entry carries the generated statement and its + * execution result, and a TEXT entry carries Genie's text answer. The list is empty when Genie + * produced no response. + */ @JsonProperty("actual_response") private Collection actualResponse; - /** Assessment of the evaluation result: good, bad, or needs review */ + /** + * Outcome of comparing Genie's response with the benchmark. GOOD means the results matched, BAD + * means they differed, and NEEDS_REVIEW means the comparison was inconclusive and a person should + * review the result. The value is only meaningful once the result status is DONE. + */ @JsonProperty("assessment") private GenieEvalAssessment assessment; @@ -69,15 +77,25 @@ public class GenieEvalResultDetails { @JsonProperty("benchmark_question_id") private String benchmarkQuestionId; - /** Current status of the evaluation run. */ + /** + * Current status of this evaluation result, not of the whole run. Once the status is DONE, the + * response and automatic assessment are complete. A user can still change the assessment + * manually. + */ @JsonProperty("eval_run_status") private EvaluationStatusType evalRunStatus; - /** The expected responses from the benchmark. */ + /** + * The expected answer from the benchmark question: one SQL entry with the benchmark SQL statement + * and its execution result. + */ @JsonProperty("expected_response") private Collection expectedResponse; - /** Whether this evaluation was manually assessed. */ + /** + * Whether a user set the assessment manually after reviewing the result. A manual assessment + * replaces the automatic one and clears `assessment_reasons`. + */ @JsonProperty("manual_assessment") private Boolean manualAssessment; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalRunResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalRunResponse.java index 053668c4b..e271dadfe 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalRunResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieEvalRunResponse.java @@ -7,7 +7,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A benchmark evaluation run. The public benchmark API currently evaluates chat-mode responses. */ +/** + * A benchmark evaluation run. A run asks Genie each selected benchmark question in a Genie space, + * compares every response with the benchmark SQL, and records one evaluation result per question. + * Runs execute asynchronously; poll the run until its status is terminal, then list its results. + * All evaluation run methods require CAN EDIT permission on the space. The public benchmark API + * currently evaluates chat-mode responses. + */ @Generated public class GenieEvalRunResponse { /** Timestamp when the evaluation run was created (milliseconds since epoch). */ @@ -18,7 +24,15 @@ public class GenieEvalRunResponse { @JsonProperty("eval_run_id") private String evalRunId; - /** Current status of the evaluation run. */ + /** + * Current status of the run, derived from the statuses of its results. Unless a result has timed + * out or the run has been cancelled, the run is RUNNING while any question has not finished. It + * is DONE once every question has finished, whether it was scored or failed. EVALUATION_CANCELLED + * means the run was cancelled before all questions finished, and EVALUATION_TIMEOUT means the + * background evaluation job stopped before they did. DONE, EVALUATION_CANCELLED and + * EVALUATION_TIMEOUT are terminal run statuses. NOT_STARTED and EVALUATION_FAILED appear only on + * individual results. + */ @JsonProperty("eval_run_status") private EvaluationStatusType evalRunStatus; @@ -26,15 +40,21 @@ public class GenieEvalRunResponse { @JsonProperty("last_updated_timestamp") private Long lastUpdatedTimestamp; - /** Number of questions answered correctly. */ + /** Number of questions whose result is assessed GOOD, including results assessed manually. */ @JsonProperty("num_correct") private Long numCorrect; - /** Number of questions that have been completed. */ + /** + * Number of questions that have finished, either scored (DONE) or failed (EVALUATION_FAILED). + * Cancelled and timed-out questions are not counted. + */ @JsonProperty("num_done") private Long numDone; - /** Number of questions that need manual review. */ + /** + * Number of finished questions whose result is assessed NEEDS_REVIEW and has not been reviewed + * manually yet. + */ @JsonProperty("num_needs_review") private Long numNeedsReview; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetEvalRunRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetEvalRunRequest.java index 945d5200e..9eebc7c51 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetEvalRunRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetEvalRunRequest.java @@ -9,7 +9,7 @@ @Generated public class GenieGetEvalRunRequest { - /** */ + /** The ID of the evaluation run, as returned when the run was created. */ @JsonIgnore private String evalRunId; /** The ID associated with the Genie space where the evaluation run is located. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java index b72654e8f..043442d2d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java @@ -93,21 +93,40 @@ GenieGenerateDownloadFullQueryResultResponse generateDownloadFullQueryResult( */ GenieMessage genieCancelResponse(GenieCancelResponseRequest genieCancelResponseRequest); - /** Creates and runs chat-mode evaluations for multiple benchmark questions in a Genie space. */ + /** + * Starts a benchmark evaluation run that asks Genie each selected benchmark question in a Genie + * space and compares every response with the benchmark SQL. The run executes asynchronously: the + * response is the new run with its current status. If it is still running, poll with the get + * method until the status is terminal. + */ GenieEvalRunResponse genieCreateEvalRun(GenieCreateEvalRunRequest genieCreateEvalRunRequest); - /** Get details for evaluation results. */ + /** + * Gets the full result for one benchmark question in an evaluation run: its assessment and the + * reasons for it, Genie's response with the SQL execution result, and the expected response from + * the benchmark. The result must belong to the given run. + */ GenieEvalResultDetails genieGetEvalResultDetails( GenieGetEvalResultDetailsRequest genieGetEvalResultDetailsRequest); - /** Get evaluation run details. */ + /** + * Gets the current status and summary counts of a benchmark evaluation run. Poll this method + * until `eval_run_status` is terminal: DONE, EVALUATION_CANCELLED or EVALUATION_TIMEOUT. + */ GenieEvalRunResponse genieGetEvalRun(GenieGetEvalRunRequest genieGetEvalRunRequest); - /** List evaluation results for a specific evaluation run. */ + /** + * Lists the results of a benchmark evaluation run, one per benchmark question. Each entry carries + * the result status and a snapshot of the question and benchmark answer; the assessment and + * Genie's response are available through the result details method. + */ GenieListEvalResultsResponse genieListEvalResults( GenieListEvalResultsRequest genieListEvalResultsRequest); - /** Lists all evaluation runs in a space. */ + /** + * Lists the benchmark evaluation runs in a Genie space with the current status and summary counts + * of each run. + */ GenieListEvalRunsResponse genieListEvalRuns(GenieListEvalRunsRequest genieListEvalRunsRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/AutoTaggingConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/AutoTaggingConfig.java index f504b188a..3ab5b01bb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/AutoTaggingConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/AutoTaggingConfig.java @@ -19,7 +19,9 @@ public class AutoTaggingConfig { /** * The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", - * "class.location"); for custom classes it is a user-defined governance tag key. + * "class.location"); for custom classes it is a user-defined governance tag key. The built-in + * tags are listed at + * https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags. */ @JsonProperty("classification_tag") private String classificationTag; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CatalogConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CatalogConfig.java index ab62c2dcd..91498f1e9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CatalogConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CatalogConfig.java @@ -17,26 +17,27 @@ @Generated public class CatalogConfig { /** - * List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is - * enabled. + * Auto-tagging configurations that apply to this catalog. Each entry overrides the + * metastore-level auto-tagging setting for its classification tag; tags without an entry inherit + * the metastore-level setting. */ @JsonProperty("auto_tag_configs") private Collection autoTagConfigs; /** * Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all - * schemas except the specified ones will be scanned. Mutually exclusive with `included_schemas`: - * only one may be set per request. If neither `included_schemas` nor `excluded_schemas` is set, - * all schemas are scanned. + * schemas except the specified ones will be scanned, including schemas created later. Mutually + * exclusive with `included_schemas`: only one may be set per request. If neither + * `included_schemas` nor `excluded_schemas` is set, all schemas are scanned. */ @JsonProperty("excluded_schemas") private CatalogConfigSchemaNames excludedSchemas; /** * Schemas to include in the scan, each named relative to the parent catalog. If specified, only - * listed schemas will be scanned. Mutually exclusive with `excluded_schemas`: only one may be set - * per request. If neither `included_schemas` nor `excluded_schemas` is set, all schemas are - * scanned. + * listed schemas will be scanned. Schemas created later are not scanned until you add them to the + * list. Mutually exclusive with `excluded_schemas`: only one may be set per request. If neither + * `included_schemas` nor `excluded_schemas` is set, all schemas are scanned. */ @JsonProperty("included_schemas") private CatalogConfigSchemaNames includedSchemas; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CreateCatalogConfigRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CreateCatalogConfigRequest.java index b1dc67f4b..9dc0b9735 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CreateCatalogConfigRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/CreateCatalogConfigRequest.java @@ -14,7 +14,7 @@ public class CreateCatalogConfigRequest { @JsonProperty("catalog_config") private CatalogConfig catalogConfig; - /** Parent resource in the format: catalogs/{catalog_name} */ + /** Name of the catalog to enable, in the format catalogs/{catalog_name}. */ @JsonIgnore private String parent; public CreateCatalogConfigRequest setCatalogConfig(CatalogConfig catalogConfig) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationAPI.java index 57fdea246..23126ee4f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationAPI.java @@ -31,7 +31,8 @@ public DataClassificationAPI(DataClassificationService mock) { * Create Data Classification configuration for a catalog. * *

Creates a new config resource, which enables Data Classification for the specified catalog. - * - The config must not already exist for the catalog. + * The catalog must not already have a config. Creating the config starts a scan of the selected + * schemas and schedules recurring scans. */ public CatalogConfig createCatalogConfig(CreateCatalogConfigRequest request) { return impl.createCatalogConfig(request); @@ -41,7 +42,13 @@ public void deleteCatalogConfig(String name) { deleteCatalogConfig(new DeleteCatalogConfigRequest().setName(name)); } - /** Delete Data Classification configuration for a catalog. */ + /** + * Delete Data Classification configuration for a catalog. + * + *

Deleting the config disables Data Classification for the catalog and stops its scheduled + * scans. Tags that auto-tagging already applied to columns are not removed. Deleting a config + * that does not exist succeeds. + */ public void deleteCatalogConfig(DeleteCatalogConfigRequest request) { impl.deleteCatalogConfig(request); } @@ -56,9 +63,10 @@ public CatalogConfig getCatalogConfig(GetCatalogConfigRequest request) { } /** - * Update the Data Classification configuration for a catalog. - The config must already exist for - * the catalog. - Updates fields specified in the update_mask. Use update_mask field to perform - * partial updates of the configuration. + * Update the Data Classification configuration for a catalog. + * + *

The config must already exist for the catalog. Only the fields named in `update_mask` + * change; the other fields keep their current values. */ public CatalogConfig updateCatalogConfig(UpdateCatalogConfigRequest request) { return impl.updateCatalogConfig(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationService.java index 3b8773790..43b0b95bb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DataClassificationService.java @@ -18,20 +18,28 @@ public interface DataClassificationService { * Create Data Classification configuration for a catalog. * *

Creates a new config resource, which enables Data Classification for the specified catalog. - * - The config must not already exist for the catalog. + * The catalog must not already have a config. Creating the config starts a scan of the selected + * schemas and schedules recurring scans. */ CatalogConfig createCatalogConfig(CreateCatalogConfigRequest createCatalogConfigRequest); - /** Delete Data Classification configuration for a catalog. */ + /** + * Delete Data Classification configuration for a catalog. + * + *

Deleting the config disables Data Classification for the catalog and stops its scheduled + * scans. Tags that auto-tagging already applied to columns are not removed. Deleting a config + * that does not exist succeeds. + */ void deleteCatalogConfig(DeleteCatalogConfigRequest deleteCatalogConfigRequest); /** Get the Data Classification configuration for a catalog. */ CatalogConfig getCatalogConfig(GetCatalogConfigRequest getCatalogConfigRequest); /** - * Update the Data Classification configuration for a catalog. - The config must already exist for - * the catalog. - Updates fields specified in the update_mask. Use update_mask field to perform - * partial updates of the configuration. + * Update the Data Classification configuration for a catalog. + * + *

The config must already exist for the catalog. Only the fields named in `update_mask` + * change; the other fields keep their current values. */ CatalogConfig updateCatalogConfig(UpdateCatalogConfigRequest updateCatalogConfigRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DeleteCatalogConfigRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DeleteCatalogConfigRequest.java index 944b05988..e00588eab 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DeleteCatalogConfigRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/DeleteCatalogConfigRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteCatalogConfigRequest { - /** Resource name in the format: catalogs/{catalog_name}/config */ + /** Resource name of the config, in the format catalogs/{catalog_name}/config. */ @JsonIgnore private String name; public DeleteCatalogConfigRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/GetCatalogConfigRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/GetCatalogConfigRequest.java index f227185cd..5b2e83651 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/GetCatalogConfigRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/GetCatalogConfigRequest.java @@ -9,7 +9,7 @@ @Generated public class GetCatalogConfigRequest { - /** Resource name in the format: catalogs/{catalog_name}/config */ + /** Resource name of the config, in the format catalogs/{catalog_name}/config. */ @JsonIgnore private String name; public GetCatalogConfigRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/UpdateCatalogConfigRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/UpdateCatalogConfigRequest.java index 943125a92..1f7566ae6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/UpdateCatalogConfigRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataclassification/UpdateCatalogConfigRequest.java @@ -22,7 +22,10 @@ public class UpdateCatalogConfigRequest { /** Resource name in the format: catalogs/{catalog_name}/config. */ @JsonIgnore private String name; - /** Field mask specifying which fields to update. */ + /** + * Comma-separated list of the fields of catalog_config to update, for example `included_schemas` + * or `auto_tag_configs`. + */ @JsonIgnore @QueryParam("update_mask") private FieldMask updateMask; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/AnomalyDetectionConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/AnomalyDetectionConfig.java index 0ab5ded78..3aa774741 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/AnomalyDetectionConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/AnomalyDetectionConfig.java @@ -11,7 +11,10 @@ /** Anomaly Detection Configurations. */ @Generated public class AnomalyDetectionConfig { - /** List of fully qualified table names to exclude from anomaly detection. */ + /** + * List of fully qualified table names to exclude from anomaly detection. Format: + * `catalog.schema.table_name`. + */ @JsonProperty("excluded_table_full_names") private Collection excludedTableFullNames; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/CronSchedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/CronSchedule.java index 72f07e684..a95593621 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/CronSchedule.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/CronSchedule.java @@ -24,10 +24,10 @@ public class CronSchedule { private String quartzCronExpression; /** - * A Java timezone id. The schedule for a job will be resolved with respect to this timezone. See - * `Java TimeZone `_ for - * details. The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz - * expression. + * The Java timezone ID in which the cron expression is evaluated. See [Java TimeZone] for the + * supported IDs. + * + *

[Java TimeZone]: https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html */ @JsonProperty("timezone_id") private String timezoneId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingConfig.java index 0442dfb8b..6d3078f13 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingConfig.java @@ -12,26 +12,33 @@ @Generated public class DataProfilingConfig { /** - * Field for specifying the absolute path to a custom directory to store data-monitoring assets. - * Normally prepopulated to a default user location via UI and Python APIs. + * The absolute workspace path of the directory where the monitor's assets, such as the dashboard, + * are stored. The UI and the Python APIs normally prepopulate a default user location. */ @JsonProperty("assets_dir") private String assetsDir; /** - * 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. + * The fully qualified name of a baseline table. Format: `catalog.schema.table_name`. Drift + * metrics compare the monitored table against the baseline data, so the two tables must have the + * same schema. */ @JsonProperty("baseline_table_name") private String baselineTableName; - /** Custom metrics. */ + /** + * Custom metrics to compute in addition to the built-in ones. See [custom metrics]. + * + *

[custom metrics]: + * https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics + */ @JsonProperty("custom_metrics") private Collection customMetrics; /** - * Id of dashboard that visualizes the computed metrics. This can be empty if the monitor is in - * PENDING state. + * The ID of the dashboard that visualizes the computed metrics. It is empty while the monitor is + * pending, when the dashboard was skipped with `skip_builtin_dashboard`, or when the caller is in + * a different workspace from the one where the monitor was created. */ @JsonProperty("dashboard_id") private String dashboardId; @@ -44,7 +51,10 @@ public class DataProfilingConfig { @JsonProperty("effective_warehouse_id") private String effectiveWarehouseId; - /** `Analysis Configuration` for monitoring inference log tables. */ + /** + * Profiles an inference log table, which stores the requests and predictions of a model. Metrics + * are computed per time window and include model quality metrics. + */ @JsonProperty("inference_log") private InferenceLogConfig inferenceLog; @@ -60,15 +70,20 @@ public class DataProfilingConfig { @JsonProperty("monitor_version") private Long monitorVersion; - /** Unity Catalog table to monitor. Format: `catalog.schema.table_name` */ + /** The fully qualified name of the monitored table. Format: `catalog.schema.table_name`. */ @JsonProperty("monitored_table_name") private String monitoredTableName; - /** Field for specifying notification settings. */ + /** + * Who to notify about this monitor's refreshes. Only `on_failure` with `email_addresses` is + * supported here. + */ @JsonProperty("notification_settings") private NotificationSettings notificationSettings; - /** ID of the schema where output tables are created. */ + /** + * The UUID of the Unity Catalog schema where the profile and drift metrics tables are created. + */ @JsonProperty("output_schema_id") private String outputSchemaId; @@ -76,7 +91,10 @@ public class DataProfilingConfig { @JsonProperty("profile_metrics_table_name") private String profileMetricsTableName; - /** The cron schedule. */ + /** + * The schedule on which the monitor refreshes its metrics. Refreshes can also be triggered on + * demand through the Refresh resource. + */ @JsonProperty("schedule") private CronSchedule schedule; @@ -87,28 +105,40 @@ public class DataProfilingConfig { /** * 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. + * 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 + * `col_1`. For high-cardinality columns, only the top 100 unique values by frequency will + * generate slices. */ @JsonProperty("slicing_exprs") private Collection slicingExprs; - /** `Analysis Configuration` for monitoring snapshot tables. */ + /** + * Profiles the full contents of the table. Metrics are computed over all rows at each refresh. + */ @JsonProperty("snapshot") private SnapshotConfig snapshot; - /** The data profiling monitor status. */ + /** + * The status of the monitor. `DATA_PROFILING_STATUS_PENDING` means the monitor's assets are being + * created or updated. `DATA_PROFILING_STATUS_ACTIVE` means the monitor is ready and can be + * refreshed. `DATA_PROFILING_STATUS_FAILED` and `DATA_PROFILING_STATUS_ERROR` mean the monitor is + * not operational, and `latest_monitor_failure_message` describes the cause when one was + * recorded. `DATA_PROFILING_STATUS_DELETE_PENDING` means the monitor is being deleted. + */ @JsonProperty("status") private DataProfilingStatus status; - /** `Analysis Configuration` for monitoring time series tables. */ + /** + * Profiles a time series table. Metrics are computed per time window, as defined by + * `timestamp_column` and `granularities`. + */ @JsonProperty("time_series") private TimeSeriesConfig timeSeries; /** - * Optional argument to specify the warehouse for dashboard creation. If not specified, the first - * running warehouse will be used. + * The ID of the SQL warehouse used to create the dashboard. If not specified, the first running + * warehouse the caller can access is used. */ @JsonProperty("warehouse_id") private String warehouseId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingCustomMetric.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingCustomMetric.java index 0fd468a79..39591ef55 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingCustomMetric.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataProfilingCustomMetric.java @@ -22,8 +22,8 @@ public class DataProfilingCustomMetric { 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 `":table"` + * to indicate that the metric needs information from multiple columns. */ @JsonProperty("input_columns") private Collection inputColumns; @@ -32,11 +32,20 @@ public class DataProfilingCustomMetric { @JsonProperty("name") private String name; - /** The output type of the custom metric. */ + /** + * Specifies the Spark SQL data type of the metric value, either as a plain type name or as a + * JSON-encoded StructField. + */ @JsonProperty("output_data_type") private String outputDataType; - /** The type of the custom metric. */ + /** + * The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` metrics depend + * only on the columns of the input table, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics + * depend only on previously computed aggregate metrics, and + * `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` metrics depend on previously computed aggregate or + * derived metrics. + */ @JsonProperty("type") private DataProfilingCustomMetricType typeValue; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityAPI.java index 2f0b7076c..4bd550ea3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityAPI.java @@ -80,13 +80,13 @@ public void deleteMonitor(String objectType, String objectId) { } /** - * Delete a data quality monitor on Unity Catalog object. + * Delete a data quality monitor on a Unity Catalog object. * *

For the `table` `object_type`, the caller must have either of the following sets of - * permissions: **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on - * the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. - * **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and - * **MANAGE** on the table. + * permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. + * **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's + * parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's + * parent schema, and **MANAGE** on the table. * *

Note that the metric tables and dashboard will not be deleted as part of this call; those * assets must be manually cleaned up (if desired). @@ -212,7 +212,8 @@ public Iterable listRefresh(ListRefreshRequest request) { } /** - * Update a data quality monitor on Unity Catalog object. + * Update a data quality monitor on a Unity Catalog object. Only the fields named in `update_mask` + * are changed. * *

For the `table` `object_type`, the caller must have either of the following sets of * permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityService.java index b460c692f..52bcd9f6e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/DataQualityService.java @@ -58,13 +58,13 @@ public interface DataQualityService { Refresh createRefresh(CreateRefreshRequest createRefreshRequest); /** - * Delete a data quality monitor on Unity Catalog object. + * Delete a data quality monitor on a Unity Catalog object. * *

For the `table` `object_type`, the caller must have either of the following sets of - * permissions: **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on - * the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. - * **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and - * **MANAGE** on the table. + * permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. + * **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's + * parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's + * parent schema, and **MANAGE** on the table. * *

Note that the metric tables and dashboard will not be deleted as part of this call; those * assets must be manually cleaned up (if desired). @@ -134,7 +134,8 @@ public interface DataQualityService { ListRefreshResponse listRefresh(ListRefreshRequest listRefreshRequest); /** - * Update a data quality monitor on Unity Catalog object. + * Update a data quality monitor on a Unity Catalog object. Only the fields named in `update_mask` + * are changed. * *

For the `table` `object_type`, the caller must have either of the following sets of * permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/InferenceLogConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/InferenceLogConfig.java index f576433ae..cdfc54f7e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/InferenceLogConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/InferenceLogConfig.java @@ -17,23 +17,31 @@ public class InferenceLogConfig { @JsonProperty("granularities") private Collection granularities; - /** Column for the label. */ + /** Column containing the ground truth for the model's predictions. */ @JsonProperty("label_column") private String labelColumn; - /** Column for the model identifier. */ + /** + * Column containing the ID of the model that produced each prediction. A slice is created + * automatically for each distinct model ID. + */ @JsonProperty("model_id_column") private String modelIdColumn; - /** Column for the prediction. */ + /** Column containing the model's predicted values. */ @JsonProperty("prediction_column") private String predictionColumn; - /** Problem type the model aims to solve. */ + /** + * The type of problem the model solves. It determines which model quality metrics are computed. + */ @JsonProperty("problem_type") private InferenceProblemType problemType; - /** Column for the timestamp. */ + /** + * Column containing the timestamp of each inference request. Its type must be TIMESTAMP or + * convertible to a timestamp. + */ @JsonProperty("timestamp_column") private String timestampColumn; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorRequest.java index 5a7cc3b3a..7dc19404e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorRequest.java @@ -10,12 +10,12 @@ @Generated public class ListMonitorRequest { - /** */ + /** The maximum number of monitors to return in one page. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** Pagination token from a previous response, used to fetch the next page. */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorResponse.java index ad6f2650b..d8c26e2db 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/ListMonitorResponse.java @@ -11,11 +11,11 @@ /** Response for listing Monitors. */ @Generated public class ListMonitorResponse { - /** */ + /** The monitors on this page. */ @JsonProperty("monitors") private Collection monitors; - /** */ + /** Pagination token to pass as `page_token` to fetch the next page. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/Monitor.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/Monitor.java index c4b94c1fe..b354c8465 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/Monitor.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/Monitor.java @@ -7,16 +7,23 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** Monitor for the data quality of unity catalog entities such as schema or table. */ +/** + * A data quality monitor on a Unity Catalog object. A `schema` monitor runs anomaly detection on + * the tables in the schema and is configured through `anomaly_detection_config`. A `table` monitor + * profiles a single table and is configured through `data_profiling_config`. + */ @Generated public class Monitor { - /** Anomaly Detection Configuration, applicable to `schema` object types. */ + /** + * Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` + * monitor, this holds the settings of the parent schema's monitor if the schema has one. + */ @JsonProperty("anomaly_detection_config") private AnomalyDetectionConfig anomalyDetectionConfig; /** - * Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis - * Configuration` must be present. + * Data profiling settings. Required when `object_type` is `table`. Exactly one of + * `inference_log`, `time_series` or `snapshot` must be set. */ @JsonProperty("data_profiling_config") private DataProfilingConfig dataProfilingConfig; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationDestination.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationDestination.java index fb2d7b5d1..4c150cf45 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationDestination.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationDestination.java @@ -29,7 +29,8 @@ public class NotificationDestination { /** * The list of email addresses to send the notification to. A maximum of 5 email addresses is - * supported. + * supported. Only supported on table monitors, via `data_profiling_config`; rejected on schema + * monitors. */ @JsonProperty("email_addresses") private Collection emailAddresses; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationSettings.java index fc28153ef..d4551ade7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationSettings.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/NotificationSettings.java @@ -10,7 +10,10 @@ /** Settings for sending notifications on the data quality monitoring. */ @Generated public class NotificationSettings { - /** Destinations to send notifications on failure/timeout. */ + /** + * Recipients to notify when a refresh of the monitor fails or times out. Only supported on table + * monitors, via `data_profiling_config`, and only `email_addresses` is accepted there. + */ @JsonProperty("on_failure") private NotificationDestination onFailure; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/TimeSeriesConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/TimeSeriesConfig.java index eb7d0402e..f76f79d70 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/TimeSeriesConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/TimeSeriesConfig.java @@ -17,7 +17,10 @@ public class TimeSeriesConfig { @JsonProperty("granularities") private Collection granularities; - /** Column for the timestamp. */ + /** + * Column containing the timestamp of each row. Its type must be TIMESTAMP or convertible to a + * timestamp. + */ @JsonProperty("timestamp_column") private String timestampColumn; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/UpdateMonitorRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/UpdateMonitorRequest.java index 8331e7d3f..f47c22490 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/UpdateMonitorRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dataquality/UpdateMonitorRequest.java @@ -11,7 +11,7 @@ @Generated public class UpdateMonitorRequest { - /** The monitor to update. */ + /** The new values for the monitor. Only the fields named in `update_mask` are applied. */ @JsonProperty("monitor") private Monitor monitor; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/DefaultWorkspaceBaseEnvironment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/DefaultWorkspaceBaseEnvironment.java index 57cecf59a..1f3dfe7be 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/DefaultWorkspaceBaseEnvironment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/DefaultWorkspaceBaseEnvironment.java @@ -11,18 +11,25 @@ * A singleton resource representing the default workspace base environment configuration. This * resource contains the workspace base environments that are used as defaults for serverless * notebooks and jobs in the workspace, for both CPU and GPU compute types. + * + *

When cpu_workspace_base_environment or gpu_workspace_base_environment is unset, new serverless + * notebooks for that compute type use the Databricks Standard base environment: the latest stable + * standard environment version provided by Databricks, with no workspace base environment applied. + * The workspace settings page shows this as Standard Latest. */ @Generated public class DefaultWorkspaceBaseEnvironment { /** - * The default workspace base environment for CPU compute. Format: + * The default workspace base environment for CPU compute. If unset, CPU compute defaults to the + * Databricks Standard base environment (Standard Latest). Format: * workspace-base-environments/{workspace_base_environment} */ @JsonProperty("cpu_workspace_base_environment") private String cpuWorkspaceBaseEnvironment; /** - * The default workspace base environment for GPU compute. Format: + * The default workspace base environment for GPU compute. If unset, GPU compute defaults to the + * Databricks Standard base environment (Standard Latest). Format: * workspace-base-environments/{workspace_base_environment} */ @JsonProperty("gpu_workspace_base_environment") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsAPI.java index bf9370768..cef11e2a0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsAPI.java @@ -62,7 +62,8 @@ public DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment(String /** * Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current - * default base environment settings for both CPU and GPU compute. + * default base environment settings for both CPU and GPU compute. An unset CPU or GPU field means + * that compute type uses the Databricks Standard base environment. */ public DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment( GetDefaultWorkspaceBaseEnvironmentRequest request) { @@ -141,7 +142,9 @@ public RefreshWorkspaceBaseEnvironmentOperation refreshWorkspaceBaseEnvironment( /** * Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the - * specified base environments as the workspace defaults for CPU and/or GPU compute. + * specified base environments as the workspace defaults for CPU and/or GPU compute. Unsetting a + * default makes that compute type use the Databricks Standard base environment. The Standard base + * environment has no resource name, so unsetting the field is the only way to select it. */ public DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment( UpdateDefaultWorkspaceBaseEnvironmentRequest request) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsService.java index f60448941..bbe08ea4d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/EnvironmentsService.java @@ -35,7 +35,8 @@ void deleteWorkspaceBaseEnvironment( /** * Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current - * default base environment settings for both CPU and GPU compute. + * default base environment settings for both CPU and GPU compute. An unset CPU or GPU field means + * that compute type uses the Databricks Standard base environment. */ DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment( GetDefaultWorkspaceBaseEnvironmentRequest getDefaultWorkspaceBaseEnvironmentRequest); @@ -85,7 +86,9 @@ Operation refreshWorkspaceBaseEnvironment( /** * Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the - * specified base environments as the workspace defaults for CPU and/or GPU compute. + * specified base environments as the workspace defaults for CPU and/or GPU compute. Unsetting a + * default makes that compute type use the Databricks Standard base environment. The Standard base + * environment has no resource name, so unsetting the field is the only way to select it. */ DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment( UpdateDefaultWorkspaceBaseEnvironmentRequest updateDefaultWorkspaceBaseEnvironmentRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateDefaultWorkspaceBaseEnvironmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateDefaultWorkspaceBaseEnvironmentRequest.java index 20ea3edd2..7862c6308 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateDefaultWorkspaceBaseEnvironmentRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateDefaultWorkspaceBaseEnvironmentRequest.java @@ -26,7 +26,9 @@ public class UpdateDefaultWorkspaceBaseEnvironmentRequest { * *

To unset one or both defaults, include the field path(s) in the mask and omit them from the * request body. To unset both, you must list both paths explicitly — the wildcard '*' cannot be - * used to unset fields. + * used to unset fields. Unsetting a default makes that compute type use the Databricks Standard + * base environment. The Standard base environment has no resource name, so unsetting the field is + * the only way to select it. */ @JsonIgnore @QueryParam("update_mask") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/genieagents/GenieAgentDataSources.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/genieagents/GenieAgentDataSources.java index a3960c7a1..9715d6339 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/genieagents/GenieAgentDataSources.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/genieagents/GenieAgentDataSources.java @@ -15,11 +15,11 @@ public class GenieAgentDataSources { @JsonProperty("mcp_connections") private Collection mcpConnections; - /** Unity Catalog tables, views, and metric views, in the order they were added. */ + /** Unity Catalog tables, views, and metric views, sorted by `identifier`. */ @JsonProperty("tables") private Collection tables; - /** Unity Catalog volumes, in the order they were added. */ + /** Unity Catalog volumes, sorted by `path`. */ @JsonProperty("volumes") private Collection volumes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlRequest.java index c2f789ddb..1ff6b7ca7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlRequest.java @@ -9,19 +9,19 @@ @Generated public class AccessControlRequest { - /** name of the group */ + /** Display name of the group. */ @JsonProperty("group_name") private String groupName; - /** */ + /** Permission level to grant to the principal. */ @JsonProperty("permission_level") private PermissionLevel permissionLevel; - /** application ID of a service principal */ + /** Application ID of the service principal. */ @JsonProperty("service_principal_name") private String servicePrincipalName; - /** name of the user */ + /** Username of the user, which is the user's email address. */ @JsonProperty("user_name") private String userName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlResponse.java index 23cb047f6..b828d73e9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccessControlResponse.java @@ -10,7 +10,7 @@ @Generated public class AccessControlResponse { - /** All permissions. */ + /** Permission levels the principal holds on the object, both granted directly and inherited. */ @JsonProperty("all_permissions") private Collection allPermissions; @@ -18,15 +18,15 @@ public class AccessControlResponse { @JsonProperty("display_name") private String displayName; - /** name of the group */ + /** Display name of the group. */ @JsonProperty("group_name") private String groupName; - /** Name of the service principal. */ + /** Application ID of the service principal. */ @JsonProperty("service_principal_name") private String servicePrincipalName; - /** name of the user */ + /** Username of the user, which is the user's email address. */ @JsonProperty("user_name") private String userName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsRequest.java index a58d213e4..331577810 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsRequest.java @@ -9,7 +9,11 @@ @Generated public class GetPermissionLevelsRequest { - /** */ + /** + * The id of the object. It is the id that the object's own API uses, for example the cluster id + * for clusters, the job id for jobs, and the workspace object id for notebooks and directories. + * For the `authorization` object type, use `tokens` to manage token permissions. + */ @JsonIgnore private String requestObjectId; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsResponse.java index e055b5fe0..1eba62f59 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionLevelsResponse.java @@ -10,7 +10,7 @@ @Generated public class GetPermissionLevelsResponse { - /** Specific permission levels */ + /** Permission levels that can be granted on objects of the requested type. */ @JsonProperty("permission_levels") private Collection permissionLevels; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionRequest.java index efdb44f52..f87271d92 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/GetPermissionRequest.java @@ -9,7 +9,11 @@ @Generated public class GetPermissionRequest { - /** The id of the request object. */ + /** + * The id of the object. It is the id that the object's own API uses, for example the cluster id + * for clusters, the job id for jobs, and the workspace object id for notebooks and directories. + * For the `authorization` object type, use `tokens` to manage token permissions. + */ @JsonIgnore private String requestObjectId; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ObjectPermissions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ObjectPermissions.java index 7b8952be7..ad75e6f2b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ObjectPermissions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ObjectPermissions.java @@ -8,17 +8,27 @@ import java.util.Collection; import java.util.Objects; +/** The permissions set on an object, with one entry per principal that holds a permission on it. */ @Generated public class ObjectPermissions { - /** */ + /** + * Permissions on the object, with one entry per principal. Each entry lists the principal's + * direct and inherited permission levels. + */ @JsonProperty("access_control_list") private Collection accessControlList; - /** */ + /** + * Path that identifies the object in the access control list, built from the object type and the + * object id. + */ @JsonProperty("object_id") private String objectId; - /** */ + /** + * Type of the object, as recorded in the access control list. It can differ from the + * `request_object_type` path segment, for example a request for `clusters` returns `cluster`. + */ @JsonProperty("object_type") private String objectType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/Permission.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/Permission.java index 0fdb59942..ab1146d68 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/Permission.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/Permission.java @@ -10,15 +10,20 @@ @Generated public class Permission { - /** */ + /** + * Whether the permission is inherited from a parent object or the root object instead of being + * granted directly on the object. + */ @JsonProperty("inherited") private Boolean inherited; - /** */ + /** + * Paths of the objects the permission is inherited from. It is only set when `inherited` is true. + */ @JsonProperty("inherited_from_object") private Collection inheritedFromObject; - /** */ + /** Permission level the principal holds on the object. */ @JsonProperty("permission_level") private PermissionLevel permissionLevel; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsAPI.java index 38defe3f1..ca54aabed 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsAPI.java @@ -77,17 +77,19 @@ public GetPermissionLevelsResponse getPermissionLevels(GetPermissionLevelsReques } /** - * Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct - * permissions if none are specified. Objects can inherit permissions from their parent objects or - * root object. + * Sets permissions on an object, replacing all direct permissions with the ones in the request. + * Principals that are not in the request lose their direct permissions on the object, and all + * direct permissions are deleted if none are specified. Objects can inherit permissions from + * their parent objects or root object. */ public ObjectPermissions set(SetObjectPermissions request) { return impl.set(request); } /** - * Updates the permissions on an object. Objects can inherit permissions from their parent objects - * or root object. + * Updates the permissions on an object by adding or changing the permissions of the principals in + * the request. Principals that are not in the request keep their existing permissions. Objects + * can inherit permissions from their parent objects or root object. */ public ObjectPermissions update(UpdateObjectPermissions request) { return impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsDescription.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsDescription.java index f394a3043..76a7e5b12 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsDescription.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsDescription.java @@ -9,11 +9,11 @@ @Generated public class PermissionsDescription { - /** */ + /** Human-readable description of the permission level. */ @JsonProperty("description") private String description; - /** */ + /** Permission level that can be granted on the object. */ @JsonProperty("permission_level") private PermissionLevel permissionLevel; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsService.java index 4b3a00859..d329976f5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PermissionsService.java @@ -46,15 +46,17 @@ GetPermissionLevelsResponse getPermissionLevels( GetPermissionLevelsRequest getPermissionLevelsRequest); /** - * Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct - * permissions if none are specified. Objects can inherit permissions from their parent objects or - * root object. + * Sets permissions on an object, replacing all direct permissions with the ones in the request. + * Principals that are not in the request lose their direct permissions on the object, and all + * direct permissions are deleted if none are specified. Objects can inherit permissions from + * their parent objects or root object. */ ObjectPermissions set(SetObjectPermissions setObjectPermissions); /** - * Updates the permissions on an object. Objects can inherit permissions from their parent objects - * or root object. + * Updates the permissions on an object by adding or changing the permissions of the principals in + * the request. Principals that are not in the request keep their existing permissions. Objects + * can inherit permissions from their parent objects or root object. */ ObjectPermissions update(UpdateObjectPermissions updateObjectPermissions); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/SetObjectPermissions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/SetObjectPermissions.java index c5e2c687b..e64d2820e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/SetObjectPermissions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/SetObjectPermissions.java @@ -11,11 +11,19 @@ @Generated public class SetObjectPermissions { - /** */ + /** + * Permissions to apply to the object, with one entry per principal. Each entry names exactly one + * principal through `user_name`, `group_name` or `service_principal_name` and the + * `permission_level` for that principal. + */ @JsonProperty("access_control_list") private Collection accessControlList; - /** The id of the request object. */ + /** + * The id of the object. It is the id that the object's own API uses, for example the cluster id + * for clusters, the job id for jobs, and the workspace object id for notebooks and directories. + * For the `authorization` object type, use `tokens` to manage token permissions. + */ @JsonIgnore private String requestObjectId; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateObjectPermissions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateObjectPermissions.java index 913884bf7..b4c74531c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateObjectPermissions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateObjectPermissions.java @@ -11,11 +11,19 @@ @Generated public class UpdateObjectPermissions { - /** */ + /** + * Permissions to apply to the object, with one entry per principal. Each entry names exactly one + * principal through `user_name`, `group_name` or `service_principal_name` and the + * `permission_level` for that principal. + */ @JsonProperty("access_control_list") private Collection accessControlList; - /** The id of the request object. */ + /** + * The id of the object. It is the id that the object's own API uses, for example the cluster id + * for clusters, the job id for jobs, and the workspace object id for notebooks and directories. + * For the `authorization` object type, use `tokens` to manage token permissions. + */ @JsonIgnore private String requestObjectId; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/DirectGroupMember.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/DirectGroupMember.java index 2d6cf33dd..6e7787550 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/DirectGroupMember.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/DirectGroupMember.java @@ -7,7 +7,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A user, service principal, or group that's a direct member of a group. */ +/** + * A user, service principal, or group that's a direct member of a group. To address a membership, + * put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}` in + * account APIs, or `GET /api/2.0/identity/groups/{group_id}/direct-members/{principal_id}` in + * workspace APIs. + */ @Generated public class DirectGroupMember { /** The member's display name. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalGroup.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalGroup.java index f50cf2eb9..97f4f4a4a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalGroup.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalGroup.java @@ -11,7 +11,9 @@ * A group from your identity provider (IdP), identified by its ID in your IdP. This resource is * read-only. Getting an external group syncs its name and parent groups from your IdP, and adds it * to your account if it isn't already there. If your account has group visibility filters, the - * group must match them. + * group must match them. To address an external group, put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/external-groups/{external_group_id}` in account APIs, or + * `GET /api/2.0/identity/external-groups/{external_group_id}` in workspace APIs. */ @Generated public class ExternalGroup { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalServicePrincipal.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalServicePrincipal.java index c54123429..53583bbd3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalServicePrincipal.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalServicePrincipal.java @@ -11,7 +11,11 @@ * A service principal from your identity provider (IdP), identified by its ID in your IdP. This * resource is read-only and requires Microsoft Entra ID as your IdP. Getting an external service * principal syncs its details and group memberships from your IdP, and adds it to your account if - * it isn't already there. + * it isn't already there. To address an external service principal, put its resource name in the + * URL: `GET + * /api/2.0/identity/accounts/{account_id}/external-service-principals/{external_service_principal_id}` + * in account APIs, or `GET + * /api/2.0/identity/external-service-principals/{external_service_principal_id}` in workspace APIs. */ @Generated public class ExternalServicePrincipal { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalUser.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalUser.java index 180628056..631d56230 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalUser.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ExternalUser.java @@ -10,7 +10,10 @@ /** * A user from your identity provider (IdP), identified by their ID in your IdP. This resource is * read-only. Getting an external user syncs the user's details and group memberships from your IdP, - * and adds the user to your account if they aren't already there. + * and adds the user to your account if they aren't already there. To address an external user, put + * its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/external-users/{external_user_id}` in account APIs, or + * `GET /api/2.0/identity/external-users/{external_user_id}` in workspace APIs. */ @Generated public class ExternalUser { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/Group.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/Group.java index 60cbf32da..ac221d899 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/Group.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/Group.java @@ -7,7 +7,11 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A group in your Databricks account. */ +/** + * A group in your Databricks account. To address a group, put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/groups/{group_id}` in account APIs, or `GET + * /api/2.0/identity/groups/{group_id}` in workspace APIs. + */ @Generated public class Group { /** The ID of the account that contains the group. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/IdentityVisibilityFilter.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/IdentityVisibilityFilter.java index 9ab8361b9..7d321e65c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/IdentityVisibilityFilter.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/IdentityVisibilityFilter.java @@ -18,6 +18,9 @@ * *

You can only create group filters. Filters don't affect provisioning or sign-in for users and * service principals. You can't change a filter: to change a rule, delete it and create a new one. + * + *

To address a filter, put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`. */ @Generated public class IdentityVisibilityFilter { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ServicePrincipal.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ServicePrincipal.java index 345e67195..50a684da3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ServicePrincipal.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/ServicePrincipal.java @@ -7,7 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A service principal in your Databricks account. */ +/** + * A service principal in your Databricks account. To address a service principal, put its resource + * name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/service-principals/{service_principal_id}` in account + * APIs, or `GET /api/2.0/identity/service-principals/{service_principal_id}` in workspace APIs. + */ @Generated public class ServicePrincipal { /** The ID of the account that contains the service principal. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/TransitiveParentGroup.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/TransitiveParentGroup.java index 117c6bd10..4fccb24df 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/TransitiveParentGroup.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/TransitiveParentGroup.java @@ -7,7 +7,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A group that a principal belongs to, either directly or through another group. */ +/** + * A group that a principal belongs to, either directly or through another group. To list a + * principal's parent groups, put the principal's resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/principals/{principal_id}/transitive-parent-groups` in + * account APIs, or `GET /api/2.0/identity/principals/{principal_id}/transitive-parent-groups` in + * workspace APIs. + */ @Generated public class TransitiveParentGroup { /** The ID of the account that contains the group. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/User.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/User.java index 60b3b0990..97685d3ab 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/User.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/User.java @@ -7,7 +7,11 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** A user in your Databricks account. */ +/** + * A user in your Databricks account. To address a user, put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/users/{user_id}` in account APIs, or `GET + * /api/2.0/identity/users/{user_id}` in workspace APIs. + */ @Generated public class User { /** The ID of the account that contains the user. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceAssignment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceAssignment.java index 1b3896b38..32a1c0da8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceAssignment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceAssignment.java @@ -21,6 +21,11 @@ *

`entitlements` is the only field you set. `effective_entitlements` also includes the * entitlements the principal gets through its groups. An assignment must grant at least one * entitlement. To remove a principal's direct access, delete the assignment. + * + *

To address an assignment, put its resource name in the URL: `GET + * /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}` + * in account APIs, or `GET /api/2.0/identity/workspace-assignments/{principal_id}` in workspace + * APIs. */ @Generated public class WorkspaceAssignment { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceIdentityDetail.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceIdentityDetail.java index 3990202b7..c7aecad5d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceIdentityDetail.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iamv2/WorkspaceIdentityDetail.java @@ -10,7 +10,8 @@ /** * A user, service principal, or group's status in a workspace, and whether it has access to the * workspace directly or through a group. Update it to activate or deactivate a user or service - * principal in the workspace. + * principal in the workspace. To address it, put its resource name in the URL: `GET + * /api/2.0/identity/principals/{principal_id}/workspace-identity-detail`. */ @Generated public class WorkspaceIdentityDetail { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTaskPriorityClass.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTaskPriorityClass.java index 0e2408698..e48124f76 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTaskPriorityClass.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTaskPriorityClass.java @@ -10,6 +10,6 @@ */ @Generated public enum AiRuntimeTaskPriorityClass { - BEST_EFFORT, + HIGH, NORMAL, } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java index a9ad3b914..606707fdc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java @@ -154,8 +154,10 @@ public class CreateJob { private Collection parameters; /** - * Path of the job parent folder in workspace file tree. If absent, the job doesn't have a - * workspace object. + * Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent + * folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java index d97071f1e..1ce1a7d47 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java @@ -150,8 +150,10 @@ public class JobSettings { private Collection parameters; /** - * Path of the job parent folder in workspace file tree. If absent, the job doesn't have a - * workspace object. + * Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent + * folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Datasource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Datasource.java index 245934834..c137e4002 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Datasource.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Datasource.java @@ -160,7 +160,9 @@ public class Datasource { /** * Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a * request that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not - * supported for Unity Catalog connection datasources. + * supported for Unity Catalog connection datasources. For an existing-table datasource, runs must + * be no further apart than the shorter of the source table's `delta.deletedFileRetentionDuration` + * and `delta.logRetentionDuration`. */ @JsonProperty("schedule") private Schedule schedule; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Schedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Schedule.java index 3af217570..f57bd506a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Schedule.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Schedule.java @@ -10,9 +10,9 @@ /** * Defines when a recurring job executes. * - *

Exactly one of the timing modes (`at_least_every`, `cron_expression`, `continuous`) must be - * set; combining them or setting none is rejected by the server. `compute_group` and `enabled` are - * orthogonal to the timing. + *

Exactly one of the timing modes (`at_least_every`, `cron_expression`, `continuous`, + * `file_arrival`) must be set; combining them or setting none is rejected by the server. + * `compute_group` and `enabled` are orthogonal to the timing. */ @Generated public class Schedule { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ContactInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ContactInfo.java index e0e4135e6..890b035e9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ContactInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ContactInfo.java @@ -10,19 +10,19 @@ /** contact info for the consumer requesting data or performing a listing installation */ @Generated public class ContactInfo { - /** */ + /** Company of the consumer contact. */ @JsonProperty("company") private String company; - /** */ + /** Email address of the consumer contact. */ @JsonProperty("email") private String email; - /** */ + /** First name of the consumer contact. */ @JsonProperty("first_name") private String firstName; - /** */ + /** Last name of the consumer contact. */ @JsonProperty("last_name") private String lastName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileRequest.java index 886bbdefc..ee503713b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileRequest.java @@ -9,19 +9,25 @@ @Generated public class CreateFileRequest { - /** */ + /** Name shown to consumers for the file, for example a notebook title. At most 255 characters. */ @JsonProperty("display_name") private String displayName; - /** */ + /** Provider profile or listing to attach the file to. */ @JsonProperty("file_parent") private FileParent fileParent; - /** */ + /** + * Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a + * LISTING parent. + */ @JsonProperty("marketplace_file_type") private MarketplaceFileType marketplaceFileType; - /** */ + /** + * MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml + * for icons. + */ @JsonProperty("mime_type") private String mimeType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileResponse.java index a980c61d1..354b15d90 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateFileResponse.java @@ -9,11 +9,11 @@ @Generated public class CreateFileResponse { - /** */ + /** Metadata of the created file. */ @JsonProperty("file_info") private FileInfo fileInfo; - /** Pre-signed POST URL to blob storage */ + /** Short-lived URL for uploading the file content with an HTTP PUT request. */ @JsonProperty("upload_url") private String uploadUrl; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingRequest.java index 0f89c08ed..9da5e7424 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingRequest.java @@ -9,7 +9,7 @@ @Generated public class CreateListingRequest { - /** */ + /** Listing to create. */ @JsonProperty("listing") private Listing listing; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingResponse.java index 39814421b..4cdc583bf 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateListingResponse.java @@ -9,7 +9,7 @@ @Generated public class CreateListingResponse { - /** */ + /** ID of the created listing. */ @JsonProperty("listing_id") private String listingId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderRequest.java index ba00a9c20..8d6c17edd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderRequest.java @@ -9,7 +9,7 @@ @Generated public class CreateProviderRequest { - /** */ + /** Provider profile to create. */ @JsonProperty("provider") private ProviderInfo provider; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderResponse.java index 7308ff060..2a8a87733 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/CreateProviderResponse.java @@ -9,7 +9,7 @@ @Generated public class CreateProviderResponse { - /** */ + /** ID of the created provider profile. */ @JsonProperty("id") private String id; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DataRefreshInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DataRefreshInfo.java index cdb67a342..b44e7e65f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DataRefreshInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DataRefreshInfo.java @@ -9,11 +9,11 @@ @Generated public class DataRefreshInfo { - /** */ + /** Number of time units. Must be greater than zero. */ @JsonProperty("interval") private Long interval; - /** */ + /** Time unit that the interval is expressed in. */ @JsonProperty("unit") private DataRefresh unit; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteFileRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteFileRequest.java index c6f22c9c3..2a6c21dc1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteFileRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteFileRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteFileRequest { - /** */ + /** ID of the file to delete. */ @JsonIgnore private String fileId; public DeleteFileRequest setFileId(String fileId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteListingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteListingRequest.java index 03f79bf66..1d2f2ce7e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteListingRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteListingRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteListingRequest { - /** */ + /** ID of the listing to delete. */ @JsonIgnore private String id; public DeleteListingRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteProviderRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteProviderRequest.java index fcc74a991..f0ac8e5ed 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteProviderRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/DeleteProviderRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteProviderRequest { - /** */ + /** ID of the provider profile to delete. */ @JsonIgnore private String id; public DeleteProviderRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileInfo.java index 4c47c50e1..91efebc5e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileInfo.java @@ -9,7 +9,7 @@ @Generated public class FileInfo { - /** */ + /** Time the file was created, in epoch milliseconds. */ @JsonProperty("created_at") private Long createdAt; @@ -17,27 +17,30 @@ public class FileInfo { @JsonProperty("display_name") private String displayName; - /** */ + /** Short-lived URL for downloading the file content. */ @JsonProperty("download_link") private String downloadLink; - /** */ + /** Provider or listing that the file belongs to. */ @JsonProperty("file_parent") private FileParent fileParent; - /** */ + /** ID of the file. */ @JsonProperty("id") private String id; - /** */ + /** Purpose of the file, such as a provider icon or a notebook attached to a listing. */ @JsonProperty("marketplace_file_type") private MarketplaceFileType marketplaceFileType; - /** */ + /** MIME type of the file content, for example text/html for notebooks or image/png for icons. */ @JsonProperty("mime_type") private String mimeType; - /** */ + /** + * Processing status of the file. New files start in FILE_STATUS_STAGING and become + * FILE_STATUS_PUBLISHED after Databricks has sanitized them. + */ @JsonProperty("status") private FileStatus status; @@ -45,7 +48,7 @@ public class FileInfo { @JsonProperty("status_message") private String statusMessage; - /** */ + /** Time the file was last updated, in epoch milliseconds. */ @JsonProperty("updated_at") private Long updatedAt; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileParent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileParent.java index 506a76628..b3a629702 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileParent.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/FileParent.java @@ -10,12 +10,14 @@ @Generated public class FileParent { - /** */ + /** + * Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing. + */ @JsonProperty("file_parent_type") @QueryParam("file_parent_type") private FileParentType fileParentType; - /** */ + /** ID of the provider or listing that the file belongs to. */ @JsonProperty("parent_id") @QueryParam("parent_id") private String parentId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileRequest.java index 1f9f6c016..b2022b21e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileRequest.java @@ -9,7 +9,7 @@ @Generated public class GetFileRequest { - /** */ + /** ID of the file. */ @JsonIgnore private String fileId; public GetFileRequest setFileId(String fileId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileResponse.java index afcacadac..61e30260c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetFileResponse.java @@ -9,7 +9,7 @@ @Generated public class GetFileResponse { - /** */ + /** Metadata of the file. */ @JsonProperty("file_info") private FileInfo fileInfo; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetLatestVersionProviderAnalyticsDashboardResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetLatestVersionProviderAnalyticsDashboardResponse.java index 6ae01e89b..5d75b179c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetLatestVersionProviderAnalyticsDashboardResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetLatestVersionProviderAnalyticsDashboardResponse.java @@ -9,7 +9,7 @@ @Generated public class GetLatestVersionProviderAnalyticsDashboardResponse { - /** version here is latest logical version of the dashboard template */ + /** Latest available version of the dashboard template. */ @JsonProperty("version") private Long version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingResponse.java index 720e1f5dd..1fd851dcc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingResponse.java @@ -9,7 +9,7 @@ @Generated public class GetListingResponse { - /** */ + /** The requested listing. */ @JsonProperty("listing") private Listing listing; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsRequest.java index 7045ceaa9..06bcb7c47 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsRequest.java @@ -10,12 +10,12 @@ @Generated public class GetListingsRequest { - /** */ + /** Maximum number of results to return per page. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** Token from the next_page_token field of a previous response. Omit to get the first page. */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsResponse.java index d466edf57..4ce79a888 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetListingsResponse.java @@ -10,11 +10,11 @@ @Generated public class GetListingsResponse { - /** */ + /** Listings on this page. */ @JsonProperty("listings") private Collection

listings; - /** */ + /** Token for the next page. Not set when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetProviderResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetProviderResponse.java index 0330f3f34..eeee7587d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetProviderResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/GetProviderResponse.java @@ -9,7 +9,7 @@ @Generated public class GetProviderResponse { - /** */ + /** The requested provider profile. */ @JsonProperty("provider") private ProviderInfo provider; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListAllPersonalizationRequestsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListAllPersonalizationRequestsResponse.java index 6ab6333f1..49030ae70 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListAllPersonalizationRequestsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListAllPersonalizationRequestsResponse.java @@ -10,11 +10,11 @@ @Generated public class ListAllPersonalizationRequestsResponse { - /** */ + /** Token for the next page. Not set when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; - /** */ + /** Personalization requests on this page. */ @JsonProperty("personalization_requests") private Collection personalizationRequests; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesRequest.java index 509b6edee..8e24df153 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesRequest.java @@ -10,17 +10,17 @@ @Generated public class ListFilesRequest { - /** */ + /** Provider profile or listing whose files to list. */ @JsonIgnore @QueryParam("file_parent") private FileParent fileParent; - /** */ + /** Maximum number of results to return per page. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** Token from the next_page_token field of a previous response. Omit to get the first page. */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesResponse.java index cb90f3e58..b0acdd2b0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListFilesResponse.java @@ -10,11 +10,11 @@ @Generated public class ListFilesResponse { - /** */ + /** Files on this page. */ @JsonProperty("file_infos") private Collection fileInfos; - /** */ + /** Token for the next page. Not set when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProviderAnalyticsDashboardResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProviderAnalyticsDashboardResponse.java index 43dc6cef5..d8927637f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProviderAnalyticsDashboardResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProviderAnalyticsDashboardResponse.java @@ -9,15 +9,18 @@ @Generated public class ListProviderAnalyticsDashboardResponse { - /** dashboard_id will be used to open Lakeview dashboard. */ + /** ID of the AI/BI dashboard in the workspace. Use it to open the dashboard. */ @JsonProperty("dashboard_id") private String dashboardId; - /** */ + /** + * Marketplace-specific ID of the dashboard record. Use it as the `id` when updating the + * dashboard. + */ @JsonProperty("id") private String id; - /** */ + /** Version of the dashboard template that the dashboard was created or last updated from. */ @JsonProperty("version") private Long version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersRequest.java index 4eee78fbf..d7ed5c7a7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersRequest.java @@ -10,12 +10,12 @@ @Generated public class ListProvidersRequest { - /** */ + /** Maximum number of results to return per page. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** Token from the next_page_token field of a previous response. Omit to get the first page. */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersResponse.java index e91d16bd7..d661fac95 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListProvidersResponse.java @@ -10,11 +10,11 @@ @Generated public class ListProvidersResponse { - /** */ + /** Token for the next page. Not set when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; - /** */ + /** Provider profiles on this page. */ @JsonProperty("providers") private Collection providers; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/Listing.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/Listing.java index bf2edad5d..cb28eba4b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/Listing.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/Listing.java @@ -7,17 +7,25 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A Marketplace listing: a data product that a provider offers to consumers. The summary holds the + * listing's identity, status and sharing configuration, and the detail holds the descriptive + * content that consumers see on the listing page. + */ @Generated public class Listing { - /** */ + /** + * Descriptive content shown to consumers on the listing page, such as the description, links and + * data attributes. + */ @JsonProperty("detail") private ListingDetail detail; - /** */ + /** ID of the listing. Assigned by the server; not allowed in create requests. */ @JsonProperty("id") private String id; - /** */ + /** Identity, status and sharing configuration of the listing. */ @JsonProperty("summary") private ListingSummary summary; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingDetail.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingDetail.java index 5a80dbc00..9177f2a77 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingDetail.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingDetail.java @@ -10,7 +10,10 @@ @Generated public class ListingDetail { - /** Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK */ + /** + * Types of assets included in the listing. At least one is required unless the listing is a + * DRAFT. Duplicate values are ignored. + */ @JsonProperty("assets") private Collection assets; @@ -34,15 +37,21 @@ public class ListingDetail { @JsonProperty("data_source") private String dataSource; - /** */ + /** + * Detailed description of the data product. Supports basic Markdown formatting such as bold, + * italics and lists. + */ @JsonProperty("description") private String description; - /** */ + /** URL of documentation that helps consumers use the data product. */ @JsonProperty("documentation_link") private String documentationLink; - /** */ + /** + * Sample notebooks attached to the listing. Create each notebook with createFile, using the + * EMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here. + */ @JsonProperty("embedded_notebook_file_infos") private Collection embeddedNotebookFileInfos; @@ -54,10 +63,7 @@ public class ListingDetail { @JsonProperty("geographical_coverage") private String geographicalCoverage; - /** - * ID 20, 21 removed don't use License of the data asset - Required for listings with model based - * assets - */ + /** License of the data asset. Required for listings with model-based assets. */ @JsonProperty("license") private String license; @@ -68,7 +74,10 @@ public class ListingDetail { @JsonProperty("pricing_model") private String pricingModel; - /** */ + /** + * URL of the privacy policy for the listing. Defaults to the provider profile's privacy policy + * link when empty. + */ @JsonProperty("privacy_policy_link") private String privacyPolicyLink; @@ -76,22 +85,21 @@ public class ListingDetail { @JsonProperty("size") private Double size; - /** */ + /** URL where consumers can get support for the listing. */ @JsonProperty("support_link") private String supportLink; /** - * Listing tags - Simple key value pair to annotate listings. When should I use tags vs dedicated - * fields? Using tags avoids the need to add new columns in the database for new annotations. - * However, this should be used sparingly since tags are stored as key value pair. Use tags only: - * 1. If the field is optional and won't need to have NOT NULL integrity check 2. The value is - * fairly fixed, static and low cardinality (eg. enums). 3. The value won't be used in filters or - * joins with other tables. + * Tags that annotate the listing with fixed, low-cardinality values, such as supported languages + * or tasks. */ @JsonProperty("tags") private Collection tags; - /** */ + /** + * URL of the terms of service for the listing. Defaults to the provider profile's terms of + * service link when empty. + */ @JsonProperty("terms_of_service") private String termsOfService; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSetting.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSetting.java index 8013a0cc7..5dbc6ecdc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSetting.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSetting.java @@ -9,7 +9,10 @@ @Generated public class ListingSetting { - /** */ + /** + * PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible + * only to members of the private exchanges that they are shared in. + */ @JsonProperty("visibility") private Visibility visibility; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSummary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSummary.java index 93cacffed..90649ee92 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSummary.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ListingSummary.java @@ -10,46 +10,58 @@ @Generated public class ListingSummary { - /** */ + /** + * Categories that consumers can use to filter listings. They also appear as tags on the listing + * tile and detail page. + */ @JsonProperty("categories") private Collection categories; - /** */ + /** Time the listing was created, in epoch milliseconds. */ @JsonProperty("created_at") private Long createdAt; - /** */ + /** Name of the user who created the listing. */ @JsonProperty("created_by") private String createdBy; - /** */ + /** ID of the user who created the listing. */ @JsonProperty("created_by_id") private Long createdById; - /** */ + /** + * IDs of the private exchanges that the listing is shared in. A listing can be linked to at most + * 10 exchanges. + */ @JsonProperty("exchange_ids") private Collection exchangeIds; /** - * if a git repo is being created, a listing will be initialized with this field as opposed to a - * share + * Git repository that holds the listing's assets, used instead of a share for notebook and Git + * repo listings. A listing cannot have both a share and a Git repo. */ @JsonProperty("git_repo") private RepoInfo gitRepo; - /** */ + /** + * How consumers get access to the listing. STANDARD listings are instantly available; + * PERSONALIZED listings require the provider to approve each consumer request. Cannot be changed + * after the listing is created. + */ @JsonProperty("listingType") private ListingType listingType; - /** */ + /** + * Display name of the listing. Must start with a letter or digit and be at most 100 characters. + */ @JsonProperty("name") private String name; - /** */ + /** ID of the provider profile that owns the listing. */ @JsonProperty("provider_id") private String providerId; - /** */ + /** Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests. */ @JsonProperty("provider_region") private RegionInfo providerRegion; @@ -61,31 +73,41 @@ public class ListingSummary { @JsonProperty("published_by") private String publishedBy; - /** */ + /** + * Listing settings, such as whether the listing is visible in the public Marketplace or only in + * private exchanges. + */ @JsonProperty("setting") private ListingSetting setting; - /** */ + /** + * Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD + * listing, except for app and MCP server listings; notebook and Git repo listings can use + * git_repo instead. The caller must have access to the share. + */ @JsonProperty("share") private ShareInfo share; - /** */ + /** + * Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a + * listing as DRAFT and set the status to PUBLISHED when it is ready. + */ @JsonProperty("status") private ListingStatus status; - /** */ + /** One-line subtitle shown with the listing name. */ @JsonProperty("subtitle") private String subtitle; - /** */ + /** Time the listing was last updated, in epoch milliseconds. */ @JsonProperty("updated_at") private Long updatedAt; - /** */ + /** Name of the user who last updated the listing. */ @JsonProperty("updated_by") private String updatedBy; - /** */ + /** ID of the user who last updated the listing. */ @JsonProperty("updated_by_id") private Long updatedById; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/PersonalizationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/PersonalizationRequest.java index 202ae79fb..83d8ec4e4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/PersonalizationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/PersonalizationRequest.java @@ -9,27 +9,27 @@ @Generated public class PersonalizationRequest { - /** */ + /** Comment that the consumer entered with the request. */ @JsonProperty("comment") private String comment; - /** */ + /** Cloud and region of the consumer's Unity Catalog metastore. */ @JsonProperty("consumer_region") private RegionInfo consumerRegion; - /** */ + /** Contact details that the consumer entered with the request. */ @JsonProperty("contact_info") private ContactInfo contactInfo; - /** */ + /** Time the request was created, in epoch milliseconds. */ @JsonProperty("created_at") private Long createdAt; - /** */ + /** ID of the personalization request. */ @JsonProperty("id") private String id; - /** */ + /** How the consumer intends to use the data product, as entered with the request. */ @JsonProperty("intended_use") private String intendedUse; @@ -37,23 +37,27 @@ public class PersonalizationRequest { @JsonProperty("is_from_lighthouse") private Boolean isFromLighthouse; - /** */ + /** ID of the listing that the request was made for. */ @JsonProperty("listing_id") private String listingId; - /** */ + /** Name of the listing that the request was made for. */ @JsonProperty("listing_name") private String listingName; - /** */ + /** ID of the consumer's Unity Catalog metastore. */ @JsonProperty("metastore_id") private String metastoreId; - /** */ + /** ID of the provider profile that owns the listing. */ @JsonProperty("provider_id") private String providerId; - /** */ + /** + * How the consumer receives the shared data: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS for a + * consumer on a Databricks workspace, DELTA_SHARING_RECIPIENT_TYPE_OPEN for a consumer on another + * platform who uses a credential file. + */ @JsonProperty("recipient_type") private DeltaSharingRecipientType recipientType; @@ -64,15 +68,15 @@ public class PersonalizationRequest { @JsonProperty("share") private ShareInfo share; - /** */ + /** Current status of the request. */ @JsonProperty("status") private PersonalizationRequestStatus status; - /** */ + /** Reason that the provider gave in the most recent status update. */ @JsonProperty("status_message") private String statusMessage; - /** */ + /** Time the request was last updated, in epoch milliseconds. */ @JsonProperty("updated_at") private Long updatedAt; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderAnalyticsDashboard.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderAnalyticsDashboard.java index a44796fae..e61e4299a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderAnalyticsDashboard.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderAnalyticsDashboard.java @@ -9,7 +9,7 @@ @Generated public class ProviderAnalyticsDashboard { - /** */ + /** Marketplace-specific ID of the dashboard record, distinct from the AI/BI dashboard ID. */ @JsonProperty("id") private String id; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesAPI.java index 7142f599f..840d93a00 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesAPI.java @@ -27,7 +27,11 @@ public ProviderFilesAPI(ProviderFilesService mock) { impl = mock; } - /** Create a file. Currently, only provider icons and attached notebooks are supported. */ + /** + * Creates a file and returns a short-lived URL for uploading its content with an HTTP PUT + * request. Only provider icons (PROVIDER_ICON files on a PROVIDER parent) and sample notebooks + * (EMBEDDED_NOTEBOOK files on a LISTING parent) are supported. + */ public CreateFileResponse create(CreateFileRequest request) { return impl.create(request); } @@ -36,7 +40,7 @@ public void delete(String fileId) { delete(new DeleteFileRequest().setFileId(fileId)); } - /** Delete a file */ + /** Deletes a file. Fails if the file is still in use. */ public void delete(DeleteFileRequest request) { impl.delete(request); } @@ -45,7 +49,7 @@ public GetFileResponse get(String fileId) { return get(new GetFileRequest().setFileId(fileId)); } - /** Get a file */ + /** Gets a file's metadata, including a short-lived download URL. */ public GetFileResponse get(GetFileRequest request) { return impl.get(request); } @@ -54,7 +58,7 @@ public Iterable list(FileParent fileParent) { return list(new ListFilesRequest().setFileParent(fileParent)); } - /** List files attached to a parent entity. */ + /** Lists the files attached to a provider profile or a listing. */ public Iterable list(ListFilesRequest request) { return Paginator.newTokenPagination( request, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesService.java index a8aa9b0de..3765daa78 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderFilesService.java @@ -13,15 +13,19 @@ */ @Generated public interface ProviderFilesService { - /** Create a file. Currently, only provider icons and attached notebooks are supported. */ + /** + * Creates a file and returns a short-lived URL for uploading its content with an HTTP PUT + * request. Only provider icons (PROVIDER_ICON files on a PROVIDER parent) and sample notebooks + * (EMBEDDED_NOTEBOOK files on a LISTING parent) are supported. + */ CreateFileResponse create(CreateFileRequest createFileRequest); - /** Delete a file */ + /** Deletes a file. Fails if the file is still in use. */ void delete(DeleteFileRequest deleteFileRequest); - /** Get a file */ + /** Gets a file's metadata, including a short-lived download URL. */ GetFileResponse get(GetFileRequest getFileRequest); - /** List files attached to a parent entity. */ + /** Lists the files attached to a provider profile or a listing. */ ListFilesResponse list(ListFilesRequest listFilesRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderInfo.java index 4db7dd65e..f1e7d8800 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderInfo.java @@ -9,47 +9,64 @@ @Generated public class ProviderInfo { - /** */ + /** Email address that Databricks uses to contact the provider. Not shown to consumers. */ @JsonProperty("business_contact_email") private String businessContactEmail; - /** */ + /** URL of the provider's website. Shown on all of the provider's listings. */ @JsonProperty("company_website_link") private String companyWebsiteLink; - /** */ + /** + * ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON + * file type. + */ @JsonProperty("dark_mode_icon_file_id") private String darkModeIconFileId; - /** */ + /** + * URL for downloading the dark mode provider icon. Populated by the server from + * dark_mode_icon_file_id. + */ @JsonProperty("dark_mode_icon_file_path") private String darkModeIconFilePath; - /** */ + /** + * Description of the provider organization, shown on the provider profile and on all of its + * listings. + */ @JsonProperty("description") private String description; - /** */ + /** ID of the provider icon file, created with createFile using the PROVIDER_ICON file type. */ @JsonProperty("icon_file_id") private String iconFileId; - /** */ + /** URL for downloading the provider icon. Populated by the server from icon_file_id. */ @JsonProperty("icon_file_path") private String iconFilePath; - /** */ + /** + * ID of the provider profile. Assigned by the server; not allowed in create or update requests. + */ @JsonProperty("id") private String id; - /** is_featured is accessible by consumers only */ + /** + * Whether Databricks features the provider in the Marketplace. Set by Databricks; not allowed in + * create or update requests. + */ @JsonProperty("is_featured") private Boolean isFeatured; - /** */ + /** Display name of the provider. Consumers can filter listings by provider name. */ @JsonProperty("name") private String name; - /** */ + /** + * URL of the provider's privacy policy. Shown on all of the provider's listings unless a listing + * sets its own privacy policy. + */ @JsonProperty("privacy_policy_link") private String privacyPolicyLink; @@ -57,11 +74,17 @@ public class ProviderInfo { @JsonProperty("published_by") private String publishedBy; - /** */ + /** + * Email address that consumers can use to request support. Shown on all of the provider's + * listings. + */ @JsonProperty("support_contact_email") private String supportContactEmail; - /** */ + /** + * URL of the provider's terms of service. Shown on all of the provider's listings unless a + * listing sets its own terms of service. + */ @JsonProperty("term_of_service_link") private String termOfServiceLink; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsAPI.java index 3f5485840..17a794892 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsAPI.java @@ -27,7 +27,11 @@ public ProviderListingsAPI(ProviderListingsService mock) { impl = mock; } - /** Create a new listing */ + /** + * Creates a listing under one of the caller's provider profiles. The listing name, provider ID + * and visibility are required, and the caller must have access to any share that the listing + * references. Returns the ID of the new listing. + */ public CreateListingResponse create(CreateListingRequest request) { return impl.create(request); } @@ -36,7 +40,10 @@ public void delete(String id) { delete(new DeleteListingRequest().setId(id)); } - /** Delete a listing */ + /** + * Deletes a listing permanently. The underlying share is not deleted, and consumers who already + * have access to the share keep that access until it is revoked in Delta Sharing. + */ public void delete(DeleteListingRequest request) { impl.delete(request); } @@ -45,12 +52,12 @@ public GetListingResponse get(String id) { return get(new GetListingRequest().setId(id)); } - /** Get a listing */ + /** Gets a listing owned by one of the caller's provider profiles. */ public GetListingResponse get(GetListingRequest request) { return impl.get(request); } - /** List listings owned by this provider */ + /** Lists the listings owned by the provider profiles in the caller's account. */ public Iterable list(GetListingsRequest request) { return Paginator.newTokenPagination( request, @@ -65,7 +72,10 @@ public Iterable list(GetListingsRequest request) { }); } - /** Update a listing */ + /** + * Updates a listing. Send the full listing definition; the listing type cannot be changed after + * the listing is created, and changing the share re-links the listing to the new share. + */ public UpdateListingResponse update(UpdateListingRequest request) { return impl.update(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsService.java index 27d31a9d5..2c451e254 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderListingsService.java @@ -13,18 +13,28 @@ */ @Generated public interface ProviderListingsService { - /** Create a new listing */ + /** + * Creates a listing under one of the caller's provider profiles. The listing name, provider ID + * and visibility are required, and the caller must have access to any share that the listing + * references. Returns the ID of the new listing. + */ CreateListingResponse create(CreateListingRequest createListingRequest); - /** Delete a listing */ + /** + * Deletes a listing permanently. The underlying share is not deleted, and consumers who already + * have access to the share keep that access until it is revoked in Delta Sharing. + */ void delete(DeleteListingRequest deleteListingRequest); - /** Get a listing */ + /** Gets a listing owned by one of the caller's provider profiles. */ GetListingResponse get(GetListingRequest getListingRequest); - /** List listings owned by this provider */ + /** Lists the listings owned by the provider profiles in the caller's account. */ GetListingsResponse list(GetListingsRequest getListingsRequest); - /** Update a listing */ + /** + * Updates a listing. Send the full listing definition; the listing type cannot be changed after + * the listing is created, and changing the share re-links the listing to the new share. + */ UpdateListingResponse update(UpdateListingRequest updateListingRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsAPI.java index f7630b94a..2b29d2bb3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsAPI.java @@ -47,7 +47,9 @@ public Iterable list(ListAllPersonalizationRequestsReque } /** - * Update personalization request. This method only permits updating the status of the request. + * Updates the status of a personalization request; other properties of the request cannot be + * changed. Fulfilling a request grants the consumer access to the share, and denying a fulfilled + * request revokes that access. The listing must be published. */ public UpdatePersonalizationRequestResponse update(UpdatePersonalizationRequestRequest request) { return impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsService.java index 5552ef338..4cf16334c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderPersonalizationRequestsService.java @@ -21,7 +21,9 @@ ListAllPersonalizationRequestsResponse list( ListAllPersonalizationRequestsRequest listAllPersonalizationRequestsRequest); /** - * Update personalization request. This method only permits updating the status of the request. + * Updates the status of a personalization request; other properties of the request cannot be + * changed. Fulfilling a request grants the consumer access to the share, and denying a fulfilled + * request revokes that access. The listing must be published. */ UpdatePersonalizationRequestResponse update( UpdatePersonalizationRequestRequest updatePersonalizationRequestRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsAPI.java index e12a08777..5d0b98322 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsAPI.java @@ -25,24 +25,31 @@ public ProviderProviderAnalyticsDashboardsAPI(ProviderProviderAnalyticsDashboard } /** - * Create provider analytics dashboard. Returns Marketplace specific `id`. Not to be confused with - * the Lakeview dashboard id. + * Creates the Provider Analytics Dashboard in the caller's workspace from the latest template. + * Fails if the dashboard already exists. Returns the Marketplace-specific `id` of the dashboard + * record, which is distinct from the AI/BI dashboard ID. */ public ProviderAnalyticsDashboard create() { return impl.create(); } - /** Get provider analytics dashboard. */ + /** + * Gets the Provider Analytics Dashboard that was created for the caller's account. Returns an + * empty response if the dashboard has not been created yet. + */ public ListProviderAnalyticsDashboardResponse get() { return impl.get(); } - /** Get latest version of provider analytics dashboard. */ + /** Gets the latest available version of the Provider Analytics Dashboard template. */ public GetLatestVersionProviderAnalyticsDashboardResponse getLatestVersion() { return impl.getLatestVersion(); } - /** Update provider analytics dashboard. */ + /** + * Updates the Provider Analytics Dashboard to a newer version of the template. The requested + * version must be newer than the version that the dashboard currently uses. + */ public UpdateProviderAnalyticsDashboardResponse update( UpdateProviderAnalyticsDashboardRequest request) { return impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsService.java index 174f0e786..128783e33 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProviderAnalyticsDashboardsService.java @@ -13,18 +13,25 @@ @Generated public interface ProviderProviderAnalyticsDashboardsService { /** - * Create provider analytics dashboard. Returns Marketplace specific `id`. Not to be confused with - * the Lakeview dashboard id. + * Creates the Provider Analytics Dashboard in the caller's workspace from the latest template. + * Fails if the dashboard already exists. Returns the Marketplace-specific `id` of the dashboard + * record, which is distinct from the AI/BI dashboard ID. */ ProviderAnalyticsDashboard create(); - /** Get provider analytics dashboard. */ + /** + * Gets the Provider Analytics Dashboard that was created for the caller's account. Returns an + * empty response if the dashboard has not been created yet. + */ ListProviderAnalyticsDashboardResponse get(); - /** Get latest version of provider analytics dashboard. */ + /** Gets the latest available version of the Provider Analytics Dashboard template. */ GetLatestVersionProviderAnalyticsDashboardResponse getLatestVersion(); - /** Update provider analytics dashboard. */ + /** + * Updates the Provider Analytics Dashboard to a newer version of the template. The requested + * version must be newer than the version that the dashboard currently uses. + */ UpdateProviderAnalyticsDashboardResponse update( UpdateProviderAnalyticsDashboardRequest updateProviderAnalyticsDashboardRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersAPI.java index 451b5f97e..6d322048c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersAPI.java @@ -24,7 +24,7 @@ public ProviderProvidersAPI(ProviderProvidersService mock) { impl = mock; } - /** Create a provider */ + /** Creates a provider profile in the caller's account. Returns the ID of the new profile. */ public CreateProviderResponse create(CreateProviderRequest request) { return impl.create(request); } @@ -33,7 +33,7 @@ public void delete(String id) { delete(new DeleteProviderRequest().setId(id)); } - /** Delete provider */ + /** Deletes a provider profile and all of the listings that it owns. */ public void delete(DeleteProviderRequest request) { impl.delete(request); } @@ -42,12 +42,12 @@ public GetProviderResponse get(String id) { return get(new GetProviderRequest().setId(id)); } - /** Get provider profile */ + /** Gets a provider profile by ID. */ public GetProviderResponse get(GetProviderRequest request) { return impl.get(request); } - /** List provider profiles for account. */ + /** Lists the provider profiles in the caller's account. */ public Iterable list(ListProvidersRequest request) { return Paginator.newTokenPagination( request, @@ -62,7 +62,7 @@ public Iterable list(ListProvidersRequest request) { }); } - /** Update provider profile */ + /** Updates a provider profile. Send the full profile definition. */ public UpdateProviderResponse update(UpdateProviderRequest request) { return impl.update(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersService.java index f56e2f0c9..c71c1925e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ProviderProvidersService.java @@ -12,18 +12,18 @@ */ @Generated public interface ProviderProvidersService { - /** Create a provider */ + /** Creates a provider profile in the caller's account. Returns the ID of the new profile. */ CreateProviderResponse create(CreateProviderRequest createProviderRequest); - /** Delete provider */ + /** Deletes a provider profile and all of the listings that it owns. */ void delete(DeleteProviderRequest deleteProviderRequest); - /** Get provider profile */ + /** Gets a provider profile by ID. */ GetProviderResponse get(GetProviderRequest getProviderRequest); - /** List provider profiles for account. */ + /** Lists the provider profiles in the caller's account. */ ListProvidersResponse list(ListProvidersRequest listProvidersRequest); - /** Update provider profile */ + /** Updates a provider profile. Send the full profile definition. */ UpdateProviderResponse update(UpdateProviderRequest updateProviderRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/RegionInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/RegionInfo.java index 4e7cecaca..b1a8330f4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/RegionInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/RegionInfo.java @@ -9,11 +9,11 @@ @Generated public class RegionInfo { - /** */ + /** Cloud provider: aws, azure or gcp. */ @JsonProperty("cloud") private String cloud; - /** */ + /** Cloud region, for example us-west-2. */ @JsonProperty("region") private String region; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ShareInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ShareInfo.java index 5b656447a..dd71990e8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ShareInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/ShareInfo.java @@ -9,7 +9,7 @@ @Generated public class ShareInfo { - /** */ + /** Name of the Delta Sharing share in the provider's Unity Catalog metastore. */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingRequest.java index 8d0ca9f25..f29a235bc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingRequest.java @@ -10,10 +10,10 @@ @Generated public class UpdateListingRequest { - /** */ + /** ID of the listing to update. */ @JsonIgnore private String id; - /** */ + /** Full definition of the listing, including the fields that are not changing. */ @JsonProperty("listing") private Listing listing; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingResponse.java index 10c05956d..ab654d6e6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateListingResponse.java @@ -9,7 +9,7 @@ @Generated public class UpdateListingResponse { - /** */ + /** The updated listing. */ @JsonProperty("listing") private Listing listing; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestRequest.java index c0fa00f0c..e6c246569 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestRequest.java @@ -10,21 +10,27 @@ @Generated public class UpdatePersonalizationRequestRequest { - /** */ + /** ID of the listing that the request was made for. */ @JsonIgnore private String listingId; - /** */ + /** Message for the consumer that explains the status change, at most 255 characters. */ @JsonProperty("reason") private String reason; - /** */ + /** ID of the personalization request. */ @JsonIgnore private String requestId; - /** */ + /** + * Share to grant the consumer access to. Required when fulfilling a request for a listing with + * data assets and not allowed with other statuses. Ignored for app and MCP server listings. + */ @JsonProperty("share") private ShareInfo share; - /** */ + /** + * New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING, + * FULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING. + */ @JsonProperty("status") private PersonalizationRequestStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestResponse.java index 8a17caf4a..0b14a5f83 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdatePersonalizationRequestResponse.java @@ -9,7 +9,7 @@ @Generated public class UpdatePersonalizationRequestResponse { - /** */ + /** The updated personalization request. */ @JsonProperty("request") private PersonalizationRequest request; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardRequest.java index a82442990..d1c0e36ac 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardRequest.java @@ -10,12 +10,16 @@ @Generated public class UpdateProviderAnalyticsDashboardRequest { - /** id is immutable property and can't be updated. */ + /** + * Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or + * retrieved. + */ @JsonIgnore private String id; /** - * this is the version of the dashboard template we want to update our user to current expectation - * is that it should be equal to latest version of the dashboard template + * Version of the dashboard template to update to. Must be newer than the version that the + * dashboard currently uses; use the version returned by + * getLatestVersionProviderAnalyticsDashboard. */ @JsonProperty("version") private Long version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardResponse.java index e679a5aa9..801d7d76a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderAnalyticsDashboardResponse.java @@ -9,15 +9,15 @@ @Generated public class UpdateProviderAnalyticsDashboardResponse { - /** this is newly created Lakeview dashboard for the user */ + /** ID of the AI/BI dashboard that now contains the updated template. */ @JsonProperty("dashboard_id") private String dashboardId; - /** id & version should be the same as the request */ + /** Marketplace-specific ID of the dashboard record, the same as in the request. */ @JsonProperty("id") private String id; - /** */ + /** Version of the dashboard template that the dashboard now uses. */ @JsonProperty("version") private Long version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderRequest.java index 19bac59a2..6958e6de5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderRequest.java @@ -10,10 +10,10 @@ @Generated public class UpdateProviderRequest { - /** */ + /** ID of the provider profile to update. */ @JsonIgnore private String id; - /** */ + /** Full definition of the provider profile, including the fields that are not changing. */ @JsonProperty("provider") private ProviderInfo provider; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderResponse.java index 81323258a..a73c43125 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/marketplace/UpdateProviderResponse.java @@ -9,7 +9,7 @@ @Generated public class UpdateProviderResponse { - /** */ + /** The updated provider profile. */ @JsonProperty("provider") private ProviderInfo provider; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegration.java index d26b2c24e..1e06b040d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegration.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegration.java @@ -9,11 +9,19 @@ @Generated public class CreatePublishedAppIntegration { - /** App id of the OAuth published app integration. For example power-bi, tableau-deskop */ + /** + * ID of the published OAuth app to enable, as returned in app_id by the list of published OAuth + * apps. The short legacy IDs of the original published apps, such as power-bi and + * tableau-desktop, are also accepted. The request fails if the app is already enabled for the + * account. + */ @JsonProperty("app_id") private String appId; - /** Token access policy */ + /** + * Lifetimes of the tokens issued to the app. If omitted, the app's default token lifetimes apply. + * If set, both TTL fields are required. + */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegrationOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegrationOutput.java index 669a9d976..4092260e3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegrationOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreatePublishedAppIntegrationOutput.java @@ -9,7 +9,7 @@ @Generated public class CreatePublishedAppIntegrationOutput { - /** Unique integration id for the published OAuth app */ + /** ID of the published OAuth app integration. */ @JsonProperty("integration_id") private String integrationId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeletePublishedAppIntegrationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeletePublishedAppIntegrationRequest.java index 3281e4604..490b558e7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeletePublishedAppIntegrationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeletePublishedAppIntegrationRequest.java @@ -9,7 +9,7 @@ @Generated public class DeletePublishedAppIntegrationRequest { - /** */ + /** ID of the published OAuth app integration to delete. */ @JsonIgnore private String integrationId; public DeletePublishedAppIntegrationRequest setIntegrationId(String integrationId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationOutput.java index e9349c9b2..b59ba8cd8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationOutput.java @@ -7,29 +7,36 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A published OAuth app integration enables an OAuth app published by Databricks, such as Power BI + * or Tableau Desktop, for the account. Databricks manages the app's client ID, redirect URLs and + * scopes; the integration only sets the lifetimes of the tokens issued to the app. To register your + * own application, use a custom OAuth app integration instead. See + * https://docs.databricks.com/aws/en/integrations/enable-disable-oauth. + */ @Generated public class GetPublishedAppIntegrationOutput { - /** App-id of the published app integration */ + /** ID of the published OAuth app, as returned in app_id by the list of published OAuth apps. */ @JsonProperty("app_id") private String appId; - /** */ + /** Time the integration was created, as an ISO 8601 timestamp. */ @JsonProperty("create_time") private String createTime; - /** */ + /** ID of the user who created the integration. */ @JsonProperty("created_by") private Long createdBy; - /** Unique integration id for the published OAuth app */ + /** ID of the published OAuth app integration in the account. */ @JsonProperty("integration_id") private String integrationId; - /** Display name of the published OAuth app */ + /** Display name of the published OAuth app. */ @JsonProperty("name") private String name; - /** Token access policy */ + /** Lifetimes of the access and refresh tokens issued to the app. */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationRequest.java index b544e4f29..7f93a0a4d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationRequest.java @@ -9,7 +9,7 @@ @Generated public class GetPublishedAppIntegrationRequest { - /** */ + /** ID of the published OAuth app integration. */ @JsonIgnore private String integrationId; public GetPublishedAppIntegrationRequest setIntegrationId(String integrationId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationsOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationsOutput.java index 8b3da1890..e52cf3c4a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationsOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetPublishedAppIntegrationsOutput.java @@ -14,7 +14,7 @@ public class GetPublishedAppIntegrationsOutput { @JsonProperty("apps") private Collection apps; - /** */ + /** Token for the next page of results. If not present, there are no more results to show. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListPublishedAppIntegrationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListPublishedAppIntegrationsRequest.java index d49d4cbfa..f59e3ee8b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListPublishedAppIntegrationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListPublishedAppIntegrationsRequest.java @@ -10,12 +10,14 @@ @Generated public class ListPublishedAppIntegrationsRequest { - /** */ + /** Maximum number of integrations to return in one page, at most 1000. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** + * Token from the next_page_token field of a previous response. Omit it to request the first page. + */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationAPI.java index 330aa2a0d..4991fbdfc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationAPI.java @@ -45,11 +45,11 @@ public void delete(String integrationId) { } /** - * Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app - * integration via [PublishedAppIntegration/get]. + * Delete an existing Published OAuth App Integration. The app can no longer be used to sign in to + * the account until it is enabled again with [PublishedAppIntegration/create]. * - *

[PublishedAppIntegration/get]: - * https://docs.databricks.com/api/account/publishedappintegration/get + *

[PublishedAppIntegration/create]: + * https://docs.databricks.com/api/account/publishedappintegration/create */ public void delete(DeletePublishedAppIntegrationRequest request) { impl.delete(request); @@ -64,7 +64,7 @@ public GetPublishedAppIntegrationOutput get(GetPublishedAppIntegrationRequest re return impl.get(request); } - /** Get the list of published OAuth app integrations for the specified Databricks account */ + /** Get the list of published OAuth app integrations for the specified Databricks account. */ public Iterable list( ListPublishedAppIntegrationsRequest request) { return Paginator.newTokenPagination( diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationService.java index 12d182707..3a2e02a12 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppIntegrationService.java @@ -26,11 +26,11 @@ CreatePublishedAppIntegrationOutput create( CreatePublishedAppIntegration createPublishedAppIntegration); /** - * Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app - * integration via [PublishedAppIntegration/get]. + * Delete an existing Published OAuth App Integration. The app can no longer be used to sign in to + * the account until it is enabled again with [PublishedAppIntegration/create]. * - *

[PublishedAppIntegration/get]: - * https://docs.databricks.com/api/account/publishedappintegration/get + *

[PublishedAppIntegration/create]: + * https://docs.databricks.com/api/account/publishedappintegration/create */ void delete(DeletePublishedAppIntegrationRequest deletePublishedAppIntegrationRequest); @@ -38,7 +38,7 @@ CreatePublishedAppIntegrationOutput create( GetPublishedAppIntegrationOutput get( GetPublishedAppIntegrationRequest getPublishedAppIntegrationRequest); - /** Get the list of published OAuth app integrations for the specified Databricks account */ + /** Get the list of published OAuth app integrations for the specified Databricks account. */ GetPublishedAppIntegrationsOutput list( ListPublishedAppIntegrationsRequest listPublishedAppIntegrationsRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppOutput.java index 0777f1bf8..d4a070e5b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/PublishedAppOutput.java @@ -14,7 +14,7 @@ public class PublishedAppOutput { @JsonProperty("app_id") private String appId; - /** Client ID of the published OAuth app. It is the client_id in the OAuth flow */ + /** Client ID of the published OAuth app. The app sends it as client_id in the OAuth flow. */ @JsonProperty("client_id") private String clientId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdatePublishedAppIntegration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdatePublishedAppIntegration.java index 0ca00b1c1..ae973323d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdatePublishedAppIntegration.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdatePublishedAppIntegration.java @@ -10,10 +10,14 @@ @Generated public class UpdatePublishedAppIntegration { - /** */ + /** ID of the published OAuth app integration to update. */ @JsonIgnore private String integrationId; - /** Token access policy to be updated in the published OAuth app integration */ + /** + * New token lifetimes for the app. Both TTL fields are required when the policy is set; the + * single-use refresh token settings keep their current values when omitted. If the policy is + * omitted, the integration is left unchanged. + */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java index 26c344530..40439fe85 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java @@ -133,7 +133,9 @@ public class ClonePipelineRequest { /** * Path of the pipeline parent folder in workspace file tree. * - *

If absent, the pipeline doesn't have a workspace object. + *

If absent, the pipeline doesn't have a parent folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java index 6d6328af4..be23b9aa4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java @@ -11,7 +11,13 @@ @Generated public class CreatePipeline { - /** If false, deployment will fail if name conflicts with that of another pipeline. */ + /** + * If false, deployment will fail if name conflicts with that of another pipeline. + * + *

Ignored when `parent_path` is set. A pipeline in a workspace folder must have a name that is + * unique within that folder, and creation fails if the folder already contains an object with the + * same name. + */ @JsonProperty("allow_duplicate_names") private Boolean allowDuplicateNames; @@ -135,7 +141,9 @@ public class CreatePipeline { /** * Path of the pipeline parent folder in workspace file tree. * - *

If absent, the pipeline doesn't have a workspace object. + *

If absent, the pipeline doesn't have a parent folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java index 16b722160..e46f4ef0d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java @@ -13,7 +13,12 @@ @Generated public class EditPipeline { /** - * If false, deployment will fail if name has changed and conflicts the name of another pipeline. + * If false, deployment will fail if name has changed and conflicts with the name of another + * pipeline. + * + *

Ignored when the pipeline is in a workspace folder or the request sets `parent_path`. + * Renaming or moving such a pipeline fails if the target folder already contains an object with + * the same name. */ @JsonProperty("allow_duplicate_names") private Boolean allowDuplicateNames; @@ -138,7 +143,9 @@ public class EditPipeline { /** * Path of the pipeline parent folder in workspace file tree. * - *

If absent, the pipeline doesn't have a workspace object. + *

If absent, the pipeline doesn't have a parent folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java index dd68a08f6..a7b5ee1fc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java @@ -117,7 +117,9 @@ public class PipelineSpec { /** * Path of the pipeline parent folder in workspace file tree. * - *

If absent, the pipeline doesn't have a workspace object. + *

If absent, the pipeline doesn't have a parent folder. + * + *

Example: /Workspace/Projects/my_project */ @JsonProperty("parent_path") private String parentPath; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateRoleRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateRoleRequest.java index 18767f9ed..731b2faf4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateRoleRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateRoleRequest.java @@ -40,8 +40,8 @@ public class CreateRoleRequest { * The ID used to identify and manage the Role resource through the API. The Postgres role name is * specified in `spec.postgres_role`. * - *

This value should be 4-63 characters, and valid characters are lowercase letters, numbers, - * and hyphens, as defined by RFC 1123. + *

This value should be 3-63 characters, start with a lowercase letter, end with a lowercase + * letter or digit, and contain only lowercase letters, digits, and hyphens. * *

If role_id is not specified in the request, it is generated automatically. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteRoleRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteRoleRequest.java index 781072aa2..eb13fb4b2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteRoleRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteRoleRequest.java @@ -18,7 +18,8 @@ public class DeleteRoleRequest { /** * Reassign objects. If this is set, all objects owned by the role are reassigned to the role - * specified in this parameter. + * specified in this parameter. The role must already exist. Format: + * projects/{project_id}/branches/{branch_id}/roles/{role_id} * *

NOTE: setting this requires spinning up a compute to succeed, since it involves running SQL * queries. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java index e4b4c789b..a4ebad7bd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java @@ -11,7 +11,7 @@ /** Role represents a Postgres role within a Branch. */ @Generated public class Role { - /** */ + /** A timestamp indicating when the role was created. */ @JsonProperty("create_time") private Timestamp createTime; @@ -47,7 +47,7 @@ public class Role { @JsonProperty("status") private RoleRoleStatus status; - /** */ + /** A timestamp indicating when the role was last updated. */ @JsonProperty("update_time") private Timestamp updateTime; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleAttributes.java index a7b3b974f..a2b5037c0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleAttributes.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleAttributes.java @@ -15,15 +15,19 @@ */ @Generated public class RoleAttributes { - /** */ + /** + * Whether the role bypasses every row-level security policy (the Postgres BYPASSRLS attribute). + */ @JsonProperty("bypassrls") private Boolean bypassrls; - /** */ + /** Whether the role can create databases (the Postgres CREATEDB attribute). */ @JsonProperty("createdb") private Boolean createdb; - /** */ + /** + * Whether the role can create, alter and drop other roles (the Postgres CREATEROLE attribute). + */ @JsonProperty("createrole") private Boolean createrole; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleSpec.java index b16db3902..f33b023ef 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleSpec.java @@ -10,7 +10,7 @@ @Generated public class RoleRoleSpec { - /** The desired API-exposed Postgres role attribute to associate with the role. Optional. */ + /** The Postgres role attributes to grant to the role. */ @JsonProperty("attributes") private RoleAttributes attributes; @@ -39,7 +39,9 @@ public class RoleRoleSpec { private RoleAuthMethod authMethod; /** - * The type of role. When specifying a managed-identity, the chosen postgres_role must be a valid: + * The type of Databricks identity that backs the role. Leave unset to create a native Postgres + * role that is not associated with a Databricks identity. When specifying a managed-identity, the + * chosen postgres_role must be a valid: * *

* application ID for SERVICE_PRINCIPAL * user email for USER * group name for GROUP * @@ -67,7 +69,7 @@ public class RoleRoleSpec { *

If you wish to create a Postgres Role backed by a managed Databricks identity, then * postgres_role must be one of the following: * - *

1. user email for IdentityType.USER 2. app ID for IdentityType.SERVICE_PRINCIPAL 2. group + *

1. user email for IdentityType.USER 2. app ID for IdentityType.SERVICE_PRINCIPAL 3. group * name for IdentityType.GROUP * *

This value cannot be changed after creation. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleStatus.java index ec722bd95..e8984be99 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/RoleRoleStatus.java @@ -10,19 +10,19 @@ @Generated public class RoleRoleStatus { - /** The PG role attributes associated with the role. */ + /** The Postgres role attributes currently granted to the role. */ @JsonProperty("attributes") private RoleAttributes attributes; - /** */ + /** How the role authenticates when it connects to Postgres. */ @JsonProperty("auth_method") private RoleAuthMethod authMethod; - /** The type of the role. */ + /** The type of Databricks identity that backs the role, if any. */ @JsonProperty("identity_type") private RoleIdentityType identityType; - /** An enum value for a standard role that this role is a member of. */ + /** The standard roles that the role is currently a member of. */ @JsonProperty("membership_roles") private Collection membershipRoles; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingAccessPolicy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingAccessPolicy.java index 698c78634..b35dc6c0f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingAccessPolicy.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingAccessPolicy.java @@ -9,7 +9,11 @@ @Generated public class AibiDashboardEmbeddingAccessPolicy { - /** */ + /** + * Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved + * domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). + * Defaults to ALLOW_APPROVED_DOMAINS. + */ @JsonProperty("access_policy_type") private AibiDashboardEmbeddingAccessPolicyAccessPolicyType accessPolicyType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingApprovedDomains.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingApprovedDomains.java index ecfa50971..319b0887f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingApprovedDomains.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/AibiDashboardEmbeddingApprovedDomains.java @@ -10,7 +10,11 @@ @Generated public class AibiDashboardEmbeddingApprovedDomains { - /** */ + /** + * Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of + * a domain. The list applies, and can only be changed, while the embedding access policy is + * ALLOW_APPROVED_DOMAINS. + */ @JsonProperty("approved_domains") private Collection approvedDomains; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessage.java index 549f0f9a1..6632e6bc4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessage.java @@ -9,23 +9,39 @@ @Generated public class ClusterAutoRestartMessage { - /** */ + /** + * Whether the workspace can change the enabled state. Databricks computes this value: it is false + * when the compliance security profile forces the feature on or when the workspace lacks the + * Enhanced Security and Compliance entitlement. A value sent in an update request has no effect. + */ @JsonProperty("can_toggle") private Boolean canToggle; - /** */ + /** + * Whether automatic cluster update is enabled for the workspace. The effective value is always + * true while the compliance security profile is enabled on the workspace. + */ @JsonProperty("enabled") private Boolean enabled; - /** */ + /** + * Why the feature is forced on or unavailable. Databricks sets these details for information + * only; they do not determine whether the feature is enabled. + */ @JsonProperty("enablement_details") private ClusterAutoRestartMessageEnablementDetails enablementDetails; - /** */ + /** + * When the maintenance window runs. When unset, it defaults to the first Sunday of every month at + * 01:00 UTC. + */ @JsonProperty("maintenance_window") private ClusterAutoRestartMessageMaintenanceWindow maintenanceWindow; - /** */ + /** + * Whether compute resources restart during every maintenance window even when no update is + * available. When false, they restart only when an update is available. + */ @JsonProperty("restart_even_if_no_updates_available") private Boolean restartEvenIfNoUpdatesAvailable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageEnablementDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageEnablementDetails.java index 9f8a4e2c6..408f4d7e4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageEnablementDetails.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageEnablementDetails.java @@ -21,8 +21,8 @@ public class ClusterAutoRestartMessageEnablementDetails { private Boolean forcedForComplianceMode; /** - * The feature is unavailable if the corresponding entitlement disabled (see - * getShieldEntitlementEnable) + * The feature is unavailable because the workspace does not have the Enhanced Security and + * Compliance entitlement. */ @JsonProperty("unavailable_for_disabled_entitlement") private Boolean unavailableForDisabledEntitlement; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindow.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindow.java index cdef6ec8d..df14da79e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindow.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindow.java @@ -9,7 +9,7 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindow { - /** */ + /** Schedule anchored to a day of the week, either every week or on given weeks of the month. */ @JsonProperty("week_day_based_schedule") private ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule weekDayBasedSchedule; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java index b4b7b3ced..737869af5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java @@ -9,15 +9,18 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule { - /** */ + /** Day of the week on which the maintenance window starts. */ @JsonProperty("day_of_week") private ClusterAutoRestartMessageMaintenanceWindowDayOfWeek dayOfWeek; - /** */ + /** + * How often the maintenance window occurs: every week, or only on the listed occurrences of the + * day of the week within each month. + */ @JsonProperty("frequency") private ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency frequency; - /** */ + /** Time of day, in UTC, at which the maintenance window starts. */ @JsonProperty("window_start_time") private ClusterAutoRestartMessageMaintenanceWindowWindowStartTime windowStartTime; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java index 35107cdc0..8d232bcc0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java @@ -9,11 +9,11 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindowWindowStartTime { - /** */ + /** Hour of the day on a 24-hour clock. */ @JsonProperty("hours") private Long hours; - /** */ + /** Minute of the hour. */ @JsonProperty("minutes") private Long minutes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/RestrictWorkspaceAdminsMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/RestrictWorkspaceAdminsMessage.java index 3b299d81d..0e01b2702 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/RestrictWorkspaceAdminsMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/RestrictWorkspaceAdminsMessage.java @@ -16,7 +16,15 @@ public class RestrictWorkspaceAdminsMessage { @JsonProperty("disable_gov_tag_creation") private Boolean disableGovTagCreation; - /** */ + /** + * Controls what workspace admins can do with service principal tokens and job identities. With + * ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service + * principal in the workspace, change a job owner to any workspace user, and set a job's run_as + * identity to any workspace user or to a service principal they have the Service Principal User + * role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service + * principals they have the Service Principal User role on, change a job owner to themselves, and + * set run_as to themselves or to a service principal they have that role on. + */ @JsonProperty("status") private RestrictWorkspaceAdminsMessageStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingAccessPolicy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingAccessPolicy.java index 130433c6c..52d32a2fb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingAccessPolicy.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingAccessPolicy.java @@ -9,7 +9,11 @@ @Generated public class AibiDashboardEmbeddingAccessPolicy { - /** */ + /** + * Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved + * domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). + * Defaults to ALLOW_APPROVED_DOMAINS. + */ @JsonProperty("access_policy_type") private AibiDashboardEmbeddingAccessPolicyAccessPolicyType accessPolicyType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingApprovedDomains.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingApprovedDomains.java index 1124e20e2..258eaa7b7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingApprovedDomains.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AibiDashboardEmbeddingApprovedDomains.java @@ -10,7 +10,11 @@ @Generated public class AibiDashboardEmbeddingApprovedDomains { - /** */ + /** + * Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of + * a domain. The list applies, and can only be changed, while the embedding access policy is + * ALLOW_APPROVED_DOMAINS. + */ @JsonProperty("approved_domains") private Collection approvedDomains; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AllowedAppsUserApiScopesMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AllowedAppsUserApiScopesMessage.java index 8f20505c4..f94651493 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AllowedAppsUserApiScopesMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/AllowedAppsUserApiScopesMessage.java @@ -10,7 +10,11 @@ @Generated public class AllowedAppsUserApiScopesMessage { - /** */ + /** + * OAuth scopes that app developers can request when an app acts on behalf of a user. A list with + * the single entry * allows every supported scope and cannot be combined with other scopes. An + * empty list disables user authorization for apps. + */ @JsonProperty("allowed_scopes") private Collection allowedScopes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessage.java index c3be977f1..3dac577f2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessage.java @@ -9,23 +9,39 @@ @Generated public class ClusterAutoRestartMessage { - /** */ + /** + * Whether the workspace can change the enabled state. Databricks computes this value: it is false + * when the compliance security profile forces the feature on or when the workspace lacks the + * Enhanced Security and Compliance entitlement. A value sent in an update request has no effect. + */ @JsonProperty("can_toggle") private Boolean canToggle; - /** */ + /** + * Whether automatic cluster update is enabled for the workspace. The effective value is always + * true while the compliance security profile is enabled on the workspace. + */ @JsonProperty("enabled") private Boolean enabled; - /** */ + /** + * Why the feature is forced on or unavailable. Databricks sets these details for information + * only; they do not determine whether the feature is enabled. + */ @JsonProperty("enablement_details") private ClusterAutoRestartMessageEnablementDetails enablementDetails; - /** */ + /** + * When the maintenance window runs. When unset, it defaults to the first Sunday of every month at + * 01:00 UTC. + */ @JsonProperty("maintenance_window") private ClusterAutoRestartMessageMaintenanceWindow maintenanceWindow; - /** */ + /** + * Whether compute resources restart during every maintenance window even when no update is + * available. When false, they restart only when an update is available. + */ @JsonProperty("restart_even_if_no_updates_available") private Boolean restartEvenIfNoUpdatesAvailable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageEnablementDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageEnablementDetails.java index 8ad4dbbd4..f938beca9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageEnablementDetails.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageEnablementDetails.java @@ -21,8 +21,8 @@ public class ClusterAutoRestartMessageEnablementDetails { private Boolean forcedForComplianceMode; /** - * The feature is unavailable if the corresponding entitlement disabled (see - * getShieldEntitlementEnable) + * The feature is unavailable because the workspace does not have the Enhanced Security and + * Compliance entitlement. */ @JsonProperty("unavailable_for_disabled_entitlement") private Boolean unavailableForDisabledEntitlement; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindow.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindow.java index 2f21126b1..aafc0a2b2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindow.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindow.java @@ -9,7 +9,7 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindow { - /** */ + /** Schedule anchored to a day of the week, either every week or on given weeks of the month. */ @JsonProperty("week_day_based_schedule") private ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule weekDayBasedSchedule; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java index 852f03f1d..a50650ccc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule.java @@ -9,15 +9,18 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule { - /** */ + /** Day of the week on which the maintenance window starts. */ @JsonProperty("day_of_week") private ClusterAutoRestartMessageMaintenanceWindowDayOfWeek dayOfWeek; - /** */ + /** + * How often the maintenance window occurs: every week, or only on the listed occurrences of the + * day of the week within each month. + */ @JsonProperty("frequency") private ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency frequency; - /** */ + /** Time of day, in UTC, at which the maintenance window starts. */ @JsonProperty("window_start_time") private ClusterAutoRestartMessageMaintenanceWindowWindowStartTime windowStartTime; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java index c74aca76d..0876718ef 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/ClusterAutoRestartMessageMaintenanceWindowWindowStartTime.java @@ -9,11 +9,11 @@ @Generated public class ClusterAutoRestartMessageMaintenanceWindowWindowStartTime { - /** */ + /** Hour of the day on a 24-hour clock. */ @JsonProperty("hours") private Long hours; - /** */ + /** Minute of the hour. */ @JsonProperty("minutes") private Long minutes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/GetPublicWorkspaceSettingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/GetPublicWorkspaceSettingRequest.java index 762c2ea6c..9433f1d85 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/GetPublicWorkspaceSettingRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/GetPublicWorkspaceSettingRequest.java @@ -9,7 +9,7 @@ @Generated public class GetPublicWorkspaceSettingRequest { - /** Name of the setting */ + /** Name of the setting to retrieve. */ @JsonIgnore private String name; public GetPublicWorkspaceSettingRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/OperationalEmailCustomRecipientMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/OperationalEmailCustomRecipientMessage.java index a4fe2a479..3dd59d87c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/OperationalEmailCustomRecipientMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/OperationalEmailCustomRecipientMessage.java @@ -9,7 +9,11 @@ @Generated public class OperationalEmailCustomRecipientMessage { - /** */ + /** + * Email address that receives this workspace's operational emails in addition to the workspace + * admins. Use a distribution list address to reach several people. An empty string clears the + * additional recipient. + */ @JsonProperty("email") private String email; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PatchPublicWorkspaceSettingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PatchPublicWorkspaceSettingRequest.java index e3722e5b5..40c411ff8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PatchPublicWorkspaceSettingRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PatchPublicWorkspaceSettingRequest.java @@ -10,7 +10,7 @@ @Generated public class PatchPublicWorkspaceSettingRequest { - /** Name of the setting */ + /** Name of the setting to update. */ @JsonIgnore private String name; /** */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PersonalComputeMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PersonalComputeMessage.java index 1b0248ac5..0bdd9e1d5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PersonalComputeMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/PersonalComputeMessage.java @@ -9,7 +9,11 @@ @Generated public class PersonalComputeMessage { - /** */ + /** + * ON grants all users in all workspaces of the account access to the Personal Compute default + * policy. DELEGATE moves control to each workspace, where users or groups must be added to the + * policy's permissions before they can create compute with it. + */ @JsonProperty("value") private PersonalComputeMessagePersonalComputeMessageEnum value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/RestrictWorkspaceAdminsMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/RestrictWorkspaceAdminsMessage.java index 8468d5dbc..523db66bc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/RestrictWorkspaceAdminsMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/RestrictWorkspaceAdminsMessage.java @@ -16,7 +16,15 @@ public class RestrictWorkspaceAdminsMessage { @JsonProperty("disable_gov_tag_creation") private Boolean disableGovTagCreation; - /** */ + /** + * Controls what workspace admins can do with service principal tokens and job identities. With + * ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service + * principal in the workspace, change a job owner to any workspace user, and set a job's run_as + * identity to any workspace user or to a service principal they have the Service Principal User + * role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service + * principals they have the Service Principal User role on, change a job owner to themselves, and + * set run_as to themselves or to a service principal they have that role on. + */ @JsonProperty("status") private RestrictWorkspaceAdminsMessageStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/Setting.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/Setting.java index 7f954c711..818da5909 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/Setting.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/Setting.java @@ -7,6 +7,15 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A setting and its value at the workspace or account scope. Each setting has one value type, so + * one value field applies to it: a primitive wrapper (boolean_val, string_val or integer_val) or a + * setting-specific message. The settings metadata endpoint reports the field each setting uses. + * When updating a setting, set only the value field that matches its type. Responses return that + * field with the value configured at this scope, if one is set, together with the matching + * effective_* field, which holds the value in effect after Databricks applies account policies and + * defaults. + */ @Generated public class Setting { /** @@ -150,7 +159,9 @@ public class Setting { @JsonProperty("integer_val") private IntegerMessage integerVal; - /** Name of the setting. */ + /** + * Name of the setting. The settings metadata endpoint lists the names available at each scope. + */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceLabelMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceLabelMessage.java index 7261b57d3..37cf29e24 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceLabelMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceLabelMessage.java @@ -10,11 +10,17 @@ /** Workspace label and color for display (e.g. in account console). */ @Generated public class WorkspaceLabelMessage { - /** */ + /** + * Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, + * purple and pink. It is an empty string when no label is set. + */ @JsonProperty("color") private String color; - /** */ + /** + * Text of the label shown next to the workspace name in the top navigation bar. An empty string + * means no label is set. + */ @JsonProperty("label") private String label; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2API.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2API.java index 8f1a5d3f0..d58c7bffb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2API.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2API.java @@ -30,7 +30,7 @@ public Setting getPublicWorkspaceSetting(String name) { /** * Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata - * for list of setting available via public APIs. + * for the list of settings available via public APIs. */ public Setting getPublicWorkspaceSetting(GetPublicWorkspaceSettingRequest request) { return impl.getPublicWorkspaceSetting(request); @@ -58,7 +58,7 @@ public Iterable listWorkspaceSettingsMetadata( /** * Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata - * for list of setting available via public APIs at workspace level. To determine the correct + * for the list of settings available via public APIs at workspace level. To determine the correct * field to include in a patch request, refer to the type field of the setting returned in the * :method:settingsv2/listworkspacesettingsmetadata response. * diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2Service.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2Service.java index c4017f4e5..f26a9d6b6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2Service.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settingsv2/WorkspaceSettingsV2Service.java @@ -14,7 +14,7 @@ public interface WorkspaceSettingsV2Service { /** * Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata - * for list of setting available via public APIs. + * for the list of settings available via public APIs. */ Setting getPublicWorkspaceSetting( GetPublicWorkspaceSettingRequest getPublicWorkspaceSettingRequest); @@ -29,7 +29,7 @@ ListWorkspaceSettingsMetadataResponse listWorkspaceSettingsMetadata( /** * Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata - * for list of setting available via public APIs at workspace level. To determine the correct + * for the list of settings available via public APIs at workspace level. To determine the correct * field to include in a patch request, refer to the type field of the setting returned in the * :method:settingsv2/listworkspacesettingsmetadata response. * diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactRequest.java new file mode 100644 index 000000000..8577103c4 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactRequest.java @@ -0,0 +1,65 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.softwareartifacts; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.QueryParam; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class DeleteSoftwareArtifactRequest { + /** + * Force deletion even if the software artifact has versions, deleting them with it. Default is + * false. + */ + @JsonIgnore + @QueryParam("force") + private Boolean force; + + /** + * Resource name of the software artifact, of the form + * `software-artifacts/{catalog}.{schema}.{artifact}`. + */ + @JsonIgnore private String name; + + public DeleteSoftwareArtifactRequest setForce(Boolean force) { + this.force = force; + return this; + } + + public Boolean getForce() { + return force; + } + + public DeleteSoftwareArtifactRequest setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + DeleteSoftwareArtifactRequest that = (DeleteSoftwareArtifactRequest) o; + return Objects.equals(force, that.force) && Objects.equals(name, that.name); + } + + @Override + public int hashCode() { + return Objects.hash(force, name); + } + + @Override + public String toString() { + return new ToStringer(DeleteSoftwareArtifactRequest.class) + .add("force", force) + .add("name", name) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactVersionRequest.java new file mode 100644 index 000000000..b6018063a --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/DeleteSoftwareArtifactVersionRequest.java @@ -0,0 +1,45 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.softwareartifacts; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class DeleteSoftwareArtifactVersionRequest { + /** + * Resource name of the version, of the form + * `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the + * version's content digest, for example `sha256:`. + */ + @JsonIgnore private String name; + + public DeleteSoftwareArtifactVersionRequest setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + DeleteSoftwareArtifactVersionRequest that = (DeleteSoftwareArtifactVersionRequest) o; + return Objects.equals(name, that.name); + } + + @Override + public int hashCode() { + return Objects.hash(name); + } + + @Override + public String toString() { + return new ToStringer(DeleteSoftwareArtifactVersionRequest.class).add("name", name).toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsAPI.java index 34a559484..47abed96f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsAPI.java @@ -24,6 +24,26 @@ public SoftwareArtifactsAPI(SoftwareArtifactsService mock) { impl = mock; } + public void deleteSoftwareArtifact(String name) { + deleteSoftwareArtifact(new DeleteSoftwareArtifactRequest().setName(name)); + } + + /** + * Deletes a software artifact. Fails if the artifact still has versions unless `force` is set. + */ + public void deleteSoftwareArtifact(DeleteSoftwareArtifactRequest request) { + impl.deleteSoftwareArtifact(request); + } + + public void deleteSoftwareArtifactVersion(String name) { + deleteSoftwareArtifactVersion(new DeleteSoftwareArtifactVersionRequest().setName(name)); + } + + /** Deletes a software artifact version. */ + public void deleteSoftwareArtifactVersion(DeleteSoftwareArtifactVersionRequest request) { + impl.deleteSoftwareArtifactVersion(request); + } + public SoftwareArtifact getSoftwareArtifact(String name) { return getSoftwareArtifact(new GetSoftwareArtifactRequest().setName(name)); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsImpl.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsImpl.java index 4e0d49590..28712a7f1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsImpl.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsImpl.java @@ -16,6 +16,40 @@ public SoftwareArtifactsImpl(ApiClient apiClient) { this.apiClient = apiClient; } + @Override + public void deleteSoftwareArtifact(DeleteSoftwareArtifactRequest request) { + String path = String.format("/api/2.1/unity-catalog/%s", request.getName()); + try { + Request req = new Request("DELETE", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + apiClient.execute(req, Void.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + + @Override + public void deleteSoftwareArtifactVersion(DeleteSoftwareArtifactVersionRequest request) { + String path = String.format("/api/2.1/unity-catalog/%s", request.getName()); + try { + Request req = new Request("DELETE", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + apiClient.execute(req, Void.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + @Override public SoftwareArtifact getSoftwareArtifact(GetSoftwareArtifactRequest request) { String path = String.format("/api/2.1/unity-catalog/%s", request.getName()); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsService.java index f1c8b652c..15a3c97c0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactsService.java @@ -12,6 +12,15 @@ */ @Generated public interface SoftwareArtifactsService { + /** + * Deletes a software artifact. Fails if the artifact still has versions unless `force` is set. + */ + void deleteSoftwareArtifact(DeleteSoftwareArtifactRequest deleteSoftwareArtifactRequest); + + /** Deletes a software artifact version. */ + void deleteSoftwareArtifactVersion( + DeleteSoftwareArtifactVersionRequest deleteSoftwareArtifactVersionRequest); + /** * Gets a software artifact by its resource name. Returns `NOT_FOUND` if the artifact does not * exist. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Channel.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Channel.java index 4ed901e2a..8150f640a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Channel.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Channel.java @@ -13,11 +13,14 @@ */ @Generated public class Channel { - /** */ + /** Databricks SQL version to pin to. Set it if and only if name is CHANNEL_NAME_CUSTOM. */ @JsonProperty("dbsql_version") private String dbsqlVersion; - /** */ + /** + * Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW carries the + * upcoming Databricks SQL release for testing. + */ @JsonProperty("name") private ChannelName name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateWarehouseRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateWarehouseRequest.java index 3c1495787..9101ae243 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateWarehouseRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateWarehouseRequest.java @@ -22,7 +22,7 @@ public class CreateWarehouseRequest { @JsonProperty("auto_stop_mins") private Long autoStopMins; - /** Channel Details */ + /** Channel that determines which Databricks SQL version the warehouse runs. */ @JsonProperty("channel") private Channel channel; @@ -37,7 +37,7 @@ public class CreateWarehouseRequest { @JsonProperty("cluster_size") private String clusterSize; - /** warehouse creator name */ + /** Name of the user who created the warehouse. Set by the server and ignored in requests. */ @JsonProperty("creator_name") private String creatorName; @@ -93,9 +93,9 @@ public class CreateWarehouseRequest { private Long minNumClusters; /** - * Logical name for the cluster. + * Logical name for the warehouse. * - *

Supported values: - Must be unique within an org. - Must be less than 100 characters. + *

Supported values: - Must be unique within an org. - Must be 1 to 100 characters. */ @JsonProperty("name") private String name; @@ -112,11 +112,19 @@ public class CreateWarehouseRequest { @JsonProperty("reyden_cluster_size_multiplier") private Double reydenClusterSizeMultiplier; - /** Configurations whether the endpoint should use spot instances. */ + /** + * Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances + * where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances + * only. + */ @JsonProperty("spot_instance_policy") private SpotInstancePolicy spotInstancePolicy; - /** Warehouse statement timeout in seconds. */ + /** + * Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set + * to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts + * it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. + */ @JsonProperty("statement_timeout") private Long statementTimeout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EditWarehouseRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EditWarehouseRequest.java index c49994183..1934f567b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EditWarehouseRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EditWarehouseRequest.java @@ -27,7 +27,7 @@ public class EditWarehouseRequest { @JsonProperty("auto_stop_mins") private Long autoStopMins; - /** Channel Details */ + /** Channel that determines which Databricks SQL version the warehouse runs. */ @JsonProperty("channel") private Channel channel; @@ -42,7 +42,7 @@ public class EditWarehouseRequest { @JsonProperty("cluster_size") private String clusterSize; - /** warehouse creator name */ + /** Name of the user who created the warehouse. Set by the server and ignored in requests. */ @JsonProperty("creator_name") private String creatorName; @@ -101,9 +101,9 @@ public class EditWarehouseRequest { private Long minNumClusters; /** - * Logical name for the cluster. + * Logical name for the warehouse. * - *

Supported values: - Must be unique within an org. - Must be less than 100 characters. + *

Supported values: - Must be unique within an org. - Must be 1 to 100 characters. */ @JsonProperty("name") private String name; @@ -120,11 +120,19 @@ public class EditWarehouseRequest { @JsonProperty("reyden_cluster_size_multiplier") private Double reydenClusterSizeMultiplier; - /** Configurations whether the endpoint should use spot instances. */ + /** + * Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances + * where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances + * only. + */ @JsonProperty("spot_instance_policy") private SpotInstancePolicy spotInstancePolicy; - /** Warehouse statement timeout in seconds. */ + /** + * Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set + * to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts + * it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. + */ @JsonProperty("statement_timeout") private Long statementTimeout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointConfPair.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointConfPair.java index 5373b6508..3b53c8fbb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointConfPair.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointConfPair.java @@ -9,11 +9,11 @@ @Generated public class EndpointConfPair { - /** */ + /** Name of the configuration parameter. */ @JsonProperty("key") private String key; - /** */ + /** Value of the configuration parameter. */ @JsonProperty("value") private String value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointInfo.java index f6169d975..f9b0d4eb2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointInfo.java @@ -21,7 +21,7 @@ public class EndpointInfo { @JsonProperty("auto_stop_mins") private Long autoStopMins; - /** Channel Details */ + /** Channel that determines which Databricks SQL version the warehouse runs. */ @JsonProperty("channel") private Channel channel; @@ -36,7 +36,7 @@ public class EndpointInfo { @JsonProperty("cluster_size") private String clusterSize; - /** warehouse creator name */ + /** Name of the user who created the warehouse. Set by the server and ignored in requests. */ @JsonProperty("creator_name") private String creatorName; @@ -60,7 +60,7 @@ public class EndpointInfo { @JsonProperty("health") private EndpointHealth health; - /** unique identifier for warehouse */ + /** Unique identifier of the warehouse. */ @JsonProperty("id") private String id; @@ -68,7 +68,7 @@ public class EndpointInfo { @JsonProperty("instance_profile_arn") private String instanceProfileArn; - /** the jdbc connection string for this warehouse */ + /** JDBC connection string for the warehouse. */ @JsonProperty("jdbc_url") private String jdbcUrl; @@ -104,9 +104,9 @@ public class EndpointInfo { private Long minNumClusters; /** - * Logical name for the cluster. + * Logical name for the warehouse. * - *

Supported values: - Must be unique within an org. - Must be less than 100 characters. + *

Supported values: - Must be unique within an org. - Must be 1 to 100 characters. */ @JsonProperty("name") private String name; @@ -115,7 +115,10 @@ public class EndpointInfo { @JsonProperty("num_active_sessions") private Long numActiveSessions; - /** current number of clusters running for the service */ + /** + * Number of clusters currently allocated to the warehouse, including clusters that are still + * starting. + */ @JsonProperty("num_clusters") private Long numClusters; @@ -135,15 +138,23 @@ public class EndpointInfo { @JsonProperty("reyden_cluster_size_multiplier") private Double reydenClusterSizeMultiplier; - /** Configurations whether the endpoint should use spot instances. */ + /** + * Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances + * where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances + * only. + */ @JsonProperty("spot_instance_policy") private SpotInstancePolicy spotInstancePolicy; - /** state of the endpoint */ + /** Current state of the warehouse. */ @JsonProperty("state") private State state; - /** Warehouse statement timeout in seconds. */ + /** + * Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set + * to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts + * it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. + */ @JsonProperty("statement_timeout") private Long statementTimeout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTagPair.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTagPair.java index 115249962..415fb1e21 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTagPair.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTagPair.java @@ -9,11 +9,14 @@ @Generated public class EndpointTagPair { - /** */ + /** + * Tag key. Keys must be unique within the warehouse and cannot use the keys that Databricks + * reserves for the tags it sets automatically. + */ @JsonProperty("key") private String key; - /** */ + /** Tag value. Keys and values must follow the tagging rules of the cloud provider. */ @JsonProperty("value") private String value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTags.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTags.java index 9c49de20b..3ab61d7aa 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTags.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/EndpointTags.java @@ -10,7 +10,7 @@ @Generated public class EndpointTags { - /** */ + /** User-defined tags, applied in addition to the tags Databricks sets automatically. */ @JsonProperty("custom_tags") private Collection customTags; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExecuteStatementRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExecuteStatementRequest.java index 7256b5eee..23e917f92 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExecuteStatementRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExecuteStatementRequest.java @@ -119,9 +119,9 @@ public class ExecuteStatementRequest { * *

The parameters can be passed in the request body as follows: * - *

` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND date = :my_date", + *

``` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND date = :my_date", * "parameters": [ { "name": "my_name", "value": "the name" }, { "name": "my_date", "value": - * "2020-01-01", "type": "DATE" } ] } ` + * "2020-01-01", "type": "DATE" } ] } ``` * *

Currently, positional parameters denoted by a `?` marker are not supported by the Databricks * SQL Statement Execution API. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalLink.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalLink.java index c56793c91..2bfe50098 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalLink.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalLink.java @@ -49,7 +49,7 @@ public class ExternalLink { /** * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are * no more chunks. The next chunk can be fetched with a - * :method:statementexecution/getstatementresultchunkn request. + * :method:statementexecution/getStatementResultChunkN request. */ @JsonProperty("next_chunk_index") private Long nextChunkIndex; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetStatementResultChunkNRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetStatementResultChunkNRequest.java index 64829aa0e..5e1a0a324 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetStatementResultChunkNRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetStatementResultChunkNRequest.java @@ -9,7 +9,7 @@ @Generated public class GetStatementResultChunkNRequest { - /** */ + /** The zero-based index of the result chunk to fetch. */ @JsonIgnore private Long chunkIndex; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWarehouseResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWarehouseResponse.java index 70cd14fb9..98cec6f35 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWarehouseResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWarehouseResponse.java @@ -21,7 +21,7 @@ public class GetWarehouseResponse { @JsonProperty("auto_stop_mins") private Long autoStopMins; - /** Channel Details */ + /** Channel that determines which Databricks SQL version the warehouse runs. */ @JsonProperty("channel") private Channel channel; @@ -36,7 +36,7 @@ public class GetWarehouseResponse { @JsonProperty("cluster_size") private String clusterSize; - /** warehouse creator name */ + /** Name of the user who created the warehouse. Set by the server and ignored in requests. */ @JsonProperty("creator_name") private String creatorName; @@ -60,7 +60,7 @@ public class GetWarehouseResponse { @JsonProperty("health") private EndpointHealth health; - /** unique identifier for warehouse */ + /** Unique identifier of the warehouse. */ @JsonProperty("id") private String id; @@ -68,7 +68,7 @@ public class GetWarehouseResponse { @JsonProperty("instance_profile_arn") private String instanceProfileArn; - /** the jdbc connection string for this warehouse */ + /** JDBC connection string for the warehouse. */ @JsonProperty("jdbc_url") private String jdbcUrl; @@ -104,9 +104,9 @@ public class GetWarehouseResponse { private Long minNumClusters; /** - * Logical name for the cluster. + * Logical name for the warehouse. * - *

Supported values: - Must be unique within an org. - Must be less than 100 characters. + *

Supported values: - Must be unique within an org. - Must be 1 to 100 characters. */ @JsonProperty("name") private String name; @@ -115,7 +115,10 @@ public class GetWarehouseResponse { @JsonProperty("num_active_sessions") private Long numActiveSessions; - /** current number of clusters running for the service */ + /** + * Number of clusters currently allocated to the warehouse, including clusters that are still + * starting. + */ @JsonProperty("num_clusters") private Long numClusters; @@ -135,15 +138,23 @@ public class GetWarehouseResponse { @JsonProperty("reyden_cluster_size_multiplier") private Double reydenClusterSizeMultiplier; - /** Configurations whether the endpoint should use spot instances. */ + /** + * Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses spot instances + * where the cloud provider supports them, and RELIABILITY_OPTIMIZED uses on-demand instances + * only. + */ @JsonProperty("spot_instance_policy") private SpotInstancePolicy spotInstancePolicy; - /** state of the endpoint */ + /** Current state of the warehouse. */ @JsonProperty("state") private State state; - /** Warehouse statement timeout in seconds. */ + /** + * Maximum time in seconds that a statement can run on this warehouse before it is cancelled. Set + * to 0 to remove the warehouse-level timeout. Changing the value of a running warehouse restarts + * it. See https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. + */ @JsonProperty("statement_timeout") private Long statementTimeout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWorkspaceWarehouseConfigResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWorkspaceWarehouseConfigResponse.java index a7d3b787a..8763b086c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWorkspaceWarehouseConfigResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetWorkspaceWarehouseConfigResponse.java @@ -19,8 +19,10 @@ public class GetWorkspaceWarehouseConfigResponse { private RepeatedEndpointConfPairs configParam; /** - * Spark confs for external hive metastore configuration JSON serialized size must be less than <= - * 512K + * Spark configuration applied to every warehouse in the workspace, for example to connect to an + * external Hive metastore or to configure access to cloud storage. Only allowlisted keys are + * accepted, and the JSON-serialized size must be at most 512 KB. See + * https://docs.databricks.com/aws/en/admin/sql/data-access-configuration. */ @JsonProperty("data_access_config") private Collection dataAccessConfig; @@ -33,8 +35,7 @@ public class GetWorkspaceWarehouseConfigResponse { * List of Warehouse Types allowed in this workspace (limits allowed value of the type field in * CreateWarehouse and EditWarehouse). Note: Some types cannot be disabled, they don't need to be * specified in SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing warehouses - * to be converted to another type. Used by frontend to save specific type availability in the - * warehouse create and edit form UI. + * to be converted to another type. */ @JsonProperty("enabled_warehouse_types") private Collection enabledWarehouseTypes; @@ -43,7 +44,10 @@ public class GetWorkspaceWarehouseConfigResponse { @JsonProperty("global_param") private RepeatedEndpointConfPairs globalParam; - /** GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage */ + /** + * GCP only: Google service account that the warehouse clusters use to access Google Cloud + * Storage. + */ @JsonProperty("google_service_account") private String googleServiceAccount; @@ -58,7 +62,11 @@ public class GetWorkspaceWarehouseConfigResponse { @JsonProperty("security_policy") private GetWorkspaceWarehouseConfigResponseSecurityPolicy securityPolicy; - /** SQL configuration parameters */ + /** + * SQL configuration parameters applied to every warehouse in the workspace. Only parameters that + * can be set at the workspace scope are accepted. See + * https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters. + */ @JsonProperty("sql_configuration_parameters") private RepeatedEndpointConfPairs sqlConfigurationParameters; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/OdbcParams.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/OdbcParams.java index 46aa1fa53..c9d5ceb63 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/OdbcParams.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/OdbcParams.java @@ -9,19 +9,19 @@ @Generated public class OdbcParams { - /** */ + /** Hostname of the workspace to connect to. */ @JsonProperty("hostname") private String hostname; - /** */ + /** HTTP path of the warehouse. */ @JsonProperty("path") private String path; - /** */ + /** The connection port is always 443. */ @JsonProperty("port") private Long port; - /** */ + /** The transport protocol is always https. */ @JsonProperty("protocol") private String protocol; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/RepeatedEndpointConfPairs.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/RepeatedEndpointConfPairs.java index 34188d381..8f45fad5a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/RepeatedEndpointConfPairs.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/RepeatedEndpointConfPairs.java @@ -14,7 +14,7 @@ public class RepeatedEndpointConfPairs { @JsonProperty("config_pair") private Collection configPair; - /** */ + /** Configuration parameters, each a key-value pair. */ @JsonProperty("configuration_pairs") private Collection configurationPairs; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultData.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultData.java index 7dac3a3c2..e87da2f83 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultData.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultData.java @@ -35,14 +35,16 @@ public class ResultData { @JsonProperty("data_array") private Collection> dataArray; - /** */ + /** + * Short-lived cloud-storage links to the result data, used with the `EXTERNAL_LINKS` disposition. + */ @JsonProperty("external_links") private Collection externalLinks; /** * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are * no more chunks. The next chunk can be fetched with a - * :method:statementexecution/getstatementresultchunkn request. + * :method:statementexecution/getStatementResultChunkN request. */ @JsonProperty("next_chunk_index") private Long nextChunkIndex; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultManifest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultManifest.java index 14c187208..cd9246877 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultManifest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultManifest.java @@ -15,11 +15,11 @@ public class ResultManifest { @JsonProperty("chunks") private Collection chunks; - /** */ + /** The format of the result data, as requested with `format`. */ @JsonProperty("format") private Format format; - /** */ + /** The schema of the result set: the ordered list of column descriptions. */ @JsonProperty("schema") private ResultSchema schema; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultSchema.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultSchema.java index 034793281..0289ccb6f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultSchema.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ResultSchema.java @@ -11,11 +11,11 @@ /** The schema is an ordered list of column descriptions. */ @Generated public class ResultSchema { - /** */ + /** The number of columns in the result set. */ @JsonProperty("column_count") private Long columnCount; - /** */ + /** The column descriptions, in result set order. */ @JsonProperty("columns") private Collection columns; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ServiceError.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ServiceError.java index 5a22d70ea..dad2eabc8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ServiceError.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ServiceError.java @@ -9,7 +9,7 @@ @Generated public class ServiceError { - /** */ + /** The error code that classifies the failure. */ @JsonProperty("error_code") private ServiceErrorCode errorCode; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/SetWorkspaceWarehouseConfigRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/SetWorkspaceWarehouseConfigRequest.java index b2018a461..16fb64049 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/SetWorkspaceWarehouseConfigRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/SetWorkspaceWarehouseConfigRequest.java @@ -25,8 +25,10 @@ public class SetWorkspaceWarehouseConfigRequest { private RepeatedEndpointConfPairs configParam; /** - * Spark confs for external hive metastore configuration JSON serialized size must be less than <= - * 512K + * Spark configuration applied to every warehouse in the workspace, for example to connect to an + * external Hive metastore or to configure access to cloud storage. Only allowlisted keys are + * accepted, and the JSON-serialized size must be at most 512 KB. See + * https://docs.databricks.com/aws/en/admin/sql/data-access-configuration. */ @JsonProperty("data_access_config") private Collection dataAccessConfig; @@ -39,8 +41,7 @@ public class SetWorkspaceWarehouseConfigRequest { * List of Warehouse Types allowed in this workspace (limits allowed value of the type field in * CreateWarehouse and EditWarehouse). Note: Some types cannot be disabled, they don't need to be * specified in SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing warehouses - * to be converted to another type. Used by frontend to save specific type availability in the - * warehouse create and edit form UI. + * to be converted to another type. */ @JsonProperty("enabled_warehouse_types") private Collection enabledWarehouseTypes; @@ -49,7 +50,10 @@ public class SetWorkspaceWarehouseConfigRequest { @JsonProperty("global_param") private RepeatedEndpointConfPairs globalParam; - /** GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage */ + /** + * GCP only: Google service account that the warehouse clusters use to access Google Cloud + * Storage. + */ @JsonProperty("google_service_account") private String googleServiceAccount; @@ -64,7 +68,11 @@ public class SetWorkspaceWarehouseConfigRequest { @JsonProperty("security_policy") private SetWorkspaceWarehouseConfigRequestSecurityPolicy securityPolicy; - /** SQL configuration parameters */ + /** + * SQL configuration parameters applied to every warehouse in the workspace. Only parameters that + * can be set at the workspace scope are accepted. See + * https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters. + */ @JsonProperty("sql_configuration_parameters") private RepeatedEndpointConfPairs sqlConfigurationParameters; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java index de4dffd93..c7ba4a779 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java @@ -14,11 +14,17 @@ */ @Generated public class StatementResponse { - /** */ + /** The schema and metadata of the result set. Present when `status.state` is `SUCCEEDED`. */ @JsonProperty("manifest") private ResultManifest manifest; - /** */ + /** + * Contains the result data of a single chunk when using `INLINE` disposition. When using + * `EXTERNAL_LINKS` disposition, the array `external_links` is used instead to provide short-lived + * cloud-storage URLs to the result data in cloud storage. Exactly one of these alternatives is + * used. Calls to `getResultData` return the link for the requested chunk; `executeStatement` and + * `getStatementResult` responses can contain links for multiple chunks. + */ @JsonProperty("result") private ResultData result; @@ -29,7 +35,7 @@ public class StatementResponse { @JsonProperty("statement_id") private String statementId; - /** */ + /** The execution state of the statement and, if it failed, the error details. */ @JsonProperty("status") private StatementStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementStatus.java index 63f35231e..a490a252c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementStatus.java @@ -10,7 +10,7 @@ /** The status response includes execution state and if relevant, error information. */ @Generated public class StatementStatus { - /** */ + /** The error that caused the statement to fail. Only populated when `state` is `FAILED`. */ @JsonProperty("error") private ServiceError error; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/WarehouseTypePair.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/WarehouseTypePair.java index b634eeaca..8b47e43a7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/WarehouseTypePair.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/WarehouseTypePair.java @@ -20,7 +20,7 @@ public class WarehouseTypePair { @JsonProperty("enabled") private Boolean enabled; - /** */ + /** Warehouse type that this entry enables or disables. */ @JsonProperty("warehouse_type") private WarehouseTypePairWarehouseType warehouseType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java index 1737b4e5b..799818c2c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java @@ -123,9 +123,9 @@ public class ExecuteStatementRequest { * *

The parameters can be passed in the request body as follows: * - *

` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND date = :my_date", + *

``` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND date = :my_date", * "parameters": [ { "name": "my_name", "value": "the name" }, { "name": "my_date", "value": - * "2020-01-01", "type": "DATE" } ] } ` + * "2020-01-01", "type": "DATE" } ] } ``` * *

Currently, positional parameters denoted by a `?` marker are not supported by the Databricks * SQL Statement Execution API. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/DeleteTagPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/DeleteTagPolicyRequest.java index b06742357..e54411a51 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/DeleteTagPolicyRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/DeleteTagPolicyRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteTagPolicyRequest { - /** */ + /** The key of the governed tag whose policy to delete. */ @JsonIgnore private String tagKey; public DeleteTagPolicyRequest setTagKey(String tagKey) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/GetTagPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/GetTagPolicyRequest.java index 3c9942615..48ae12440 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/GetTagPolicyRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/GetTagPolicyRequest.java @@ -9,7 +9,7 @@ @Generated public class GetTagPolicyRequest { - /** */ + /** The key of the governed tag whose policy to get. */ @JsonIgnore private String tagKey; public GetTagPolicyRequest setTagKey(String tagKey) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagPolicy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagPolicy.java index f2f5ba8af..10e0d6e83 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagPolicy.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagPolicy.java @@ -8,21 +8,26 @@ import java.util.Collection; import java.util.Objects; +/** + * A tag policy makes a tag key governed and defines the values that can be assigned to it. Governed + * tags are enforced across all workspaces in the account, and only users with the ASSIGN permission + * on the governed tag can assign it. See https://docs.databricks.com/aws/en/admin/governed-tags/. + */ @Generated public class TagPolicy { /** Timestamp when the tag policy was created */ @JsonProperty("create_time") private String createTime; - /** */ + /** A description of the governed tag, such as its purpose or the meaning of its values. */ @JsonProperty("description") private String description; - /** */ + /** The unique identifier of the tag policy, generated when the policy is created. */ @JsonProperty("id") private String id; - /** */ + /** The tag key that this policy governs. Tag keys are case-sensitive. */ @JsonProperty("tag_key") private String tagKey; @@ -30,7 +35,10 @@ public class TagPolicy { @JsonProperty("update_time") private String updateTime; - /** */ + /** + * The allowed values of the governed tag. Only these values can be assigned to the tag key, and + * each value must be unique. A policy without values defines a key-only governed tag. + */ @JsonProperty("values") private Collection values; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagPolicyRequest.java index 7991f1854..f813edc22 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagPolicyRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagPolicyRequest.java @@ -11,7 +11,7 @@ @Generated public class UpdateTagPolicyRequest { - /** */ + /** The tag key that this policy governs. Tag keys are case-sensitive. */ @JsonIgnore private String tagKey; /** */ @@ -19,15 +19,8 @@ public class UpdateTagPolicyRequest { private TagPolicy tagPolicy; /** - * The field mask must be a single string, with multiple fields separated by commas (no spaces). - * The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields - * (e.g., `author.given_name`). Specification of elements in sequence or map fields is not - * allowed, as only the entire collection field can be specified. Field names must exactly match - * the resource field names. - * - *

A field mask of `*` indicates full replacement. It’s recommended to always explicitly list - * the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if - * the API changes in the future. + * The comma-separated list of tag policy fields to update. When the mask includes `values`, the + * values in the request replace all existing allowed values. */ @JsonIgnore @QueryParam("update_mask") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/Value.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/Value.java index 4ccab0c84..e3142b182 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/Value.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/Value.java @@ -7,9 +7,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** An allowed value of a governed tag. */ @Generated public class Value { - /** */ + /** The value that can be assigned to the tag key. Values are case-sensitive. */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AclItem.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AclItem.java index 268fa95ab..09dd98f8c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AclItem.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AclItem.java @@ -17,7 +17,9 @@ public class AclItem { @JsonProperty("permission") private AclPermission permission; - /** The principal in which the permission is applied. */ + /** + * The user name or group name of an existing Databricks principal that the permission applies to. + */ @JsonProperty("principal") private String principal; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AzureKeyVaultSecretScopeMetadata.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AzureKeyVaultSecretScopeMetadata.java index d2ec8ea6b..61090ed28 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AzureKeyVaultSecretScopeMetadata.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/AzureKeyVaultSecretScopeMetadata.java @@ -10,11 +10,11 @@ /** The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT` */ @Generated public class AzureKeyVaultSecretScopeMetadata { - /** The DNS of the KeyVault */ + /** The DNS name of the key vault, for example ``https://my-key-vault.vault.azure.net/``. */ @JsonProperty("dns_name") private String dnsName; - /** The resource id of the azure KeyVault that user wants to associate the scope with. */ + /** The Azure resource ID of the key vault to associate with the scope. */ @JsonProperty("resource_id") private String resourceId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateScope.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateScope.java index b66751139..21310a0d4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateScope.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateScope.java @@ -21,10 +21,7 @@ public class CreateScope { @JsonProperty("scope") private String scope; - /** - * The backend type the scope will be created with. If not specified, will default to - * ``DATABRICKS`` - */ + /** The backend type of the new scope. Defaults to ``DATABRICKS``. */ @JsonProperty("scope_backend_type") private ScopeBackendType scopeBackendType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutAcl.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutAcl.java index 7655ef791..c3d2c1ef3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutAcl.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutAcl.java @@ -13,7 +13,9 @@ public class PutAcl { @JsonProperty("permission") private AclPermission permission; - /** The principal in which the permission is applied. */ + /** + * The user name or group name of an existing Databricks principal that the permission applies to. + */ @JsonProperty("principal") private String principal; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ScopeBackendType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ScopeBackendType.java index 3506c284a..1c049d0f8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ScopeBackendType.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ScopeBackendType.java @@ -4,10 +4,7 @@ import com.databricks.sdk.support.Generated; -/** - * The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes - * will be supported in a later release. - */ +/** The types of secret scope backends in the Secret Manager. */ @Generated public enum ScopeBackendType { AZURE_KEYVAULT, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretScope.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretScope.java index 35c00938d..4e35d7ab7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretScope.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretScope.java @@ -8,9 +8,9 @@ import java.util.Objects; /** - * An organizational resource for storing secrets. Secret scopes can be different types - * (Databricks-managed, Azure KeyVault backed, etc), and ACLs can be applied to control permissions - * for all secrets within a scope. + * An organizational resource for storing secrets. A secret scope is either Databricks-backed or + * Azure Key Vault-backed, and ACLs can be applied to control permissions for all secrets within a + * scope. */ @Generated public class SecretScope { @@ -18,7 +18,7 @@ public class SecretScope { @JsonProperty("backend_type") private ScopeBackendType backendType; - /** The metadata for the secret scope if the type is ``AZURE_KEYVAULT`` */ + /** The metadata for the secret scope if the type is ``AZURE_KEYVAULT``. */ @JsonProperty("keyvault_metadata") private AzureKeyVaultSecretScopeMetadata keyvaultMetadata; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsAPI.java index 320ab756f..ffbc1d61c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsAPI.java @@ -40,34 +40,23 @@ public SecretsAPI(SecretsService mock) { *

The scope name must consist of alphanumeric characters, dashes, underscores, and periods, * and may not exceed 128 characters. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-simple-databricks-scope", "initial_manage_principal": "users" - * "scope_backend_type": "databricks|azure_keyvault", # below is only required if scope type is - * azure_keyvault "backend_azure_keyvault": { "resource_id": - * "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx", - * "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dns_name": - * "https://xxxx.vault.azure.net/", } } - * *

If ``initial_manage_principal`` is specified, the initial ACL applied to the scope is * applied to the supplied principal (user or group) with ``MANAGE`` permissions. The only * supported principal for this option is the group ``users``, which contains all users in the * workspace. If ``initial_manage_principal`` is not specified, the initial ACL with ``MANAGE`` * permission applied to the scope is assigned to the API request issuer's user identity. * - *

If ``scope_backend_type`` is ``azure_keyvault``, a secret scope is created with secrets from - * a given Azure KeyVault. The caller must provide the keyvault_resource_id and the tenant_id for - * the key vault. If ``scope_backend_type`` is ``databricks`` or is unspecified, an empty secret - * scope is created and stored in Databricks's own storage. + *

If ``scope_backend_type`` is ``AZURE_KEYVAULT``, a secret scope is created with secrets from + * an existing Azure key vault. The caller must provide the key vault's resource ID and DNS name + * in ``backend_azure_keyvault``. If ``scope_backend_type`` is ``DATABRICKS`` or is unspecified, + * an empty secret scope is created and stored in Databricks-managed storage. * *

Throws ``RESOURCE_ALREADY_EXISTS`` if a scope with the given name already exists. Throws * ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of scopes in the workspace is exceeded. Throws * ``INVALID_PARAMETER_VALUE`` if the scope name is invalid. Throws ``BAD_REQUEST`` if request - * violated constraints. Throws ``CUSTOMER_UNAUTHORIZED`` if normal user attempts to create a - * scope with name reserved for databricks internal usage. Throws ``UNAUTHENTICATED`` if unable to - * verify user access permission on Azure KeyVault + * violated constraints. Throws ``CUSTOMER_UNAUTHORIZED`` if the scope name is reserved for + * Databricks internal use. Throws ``UNAUTHENTICATED`` if Databricks cannot verify the caller's + * access to the Azure key vault. */ public void createScope(CreateScope request) { impl.createScope(request); @@ -78,12 +67,6 @@ public void createScope(CreateScope request) { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope", "principal": "data-scientists" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope, principal, or ACL exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. @@ -99,15 +82,8 @@ public void deleteScope(String scope) { /** * Deletes a secret scope. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if the scope does not exist. Throws ``PERMISSION_DENIED`` - * if the user does not have permission to make this API call. Throws ``BAD_REQUEST`` if system - * user attempts to delete internal secret scope. + * if the user does not have permission to make this API call. */ public void deleteScope(DeleteScope request) { impl.deleteScope(request); @@ -119,8 +95,7 @@ public void deleteScope(DeleteScope request) { * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws - * ``BAD_REQUEST`` if system user attempts to delete an internal secret, or request is made - * against Azure KeyVault backed scope. + * ``BAD_REQUEST`` if the request is made against an Azure Key Vault-backed scope. */ public void deleteSecret(DeleteSecret request) { impl.deleteSecret(request); @@ -135,12 +110,6 @@ public AclItem getAcl(String scope, String principal) { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example response: - * - *

.. code:: - * - *

{ "principal": "data-scientists", "permission": "READ" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. @@ -181,13 +150,6 @@ public Iterable listAcls(String scope) { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example response: - * - *

.. code:: - * - *

{ "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": - * "data-scientists", "permission": "READ" }] } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ @@ -199,13 +161,6 @@ public Iterable listAcls(ListAclsRequest request) { /** * Lists all secret scopes available in the workspace. * - *

Example response: - * - *

.. code:: - * - *

{ "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" },{ "name": - * "mount-points", "backend_type": "DATABRICKS" }] } - * *

Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ public Iterable listScopes() { @@ -238,24 +193,9 @@ public Iterable listSecrets(ListSecretsRequest request) { * - Allowed to read and write to this secret scope. * ``READ`` - Allowed to read this secret * scope and list what secrets are available. * - *

Note that in general, secret values can only be read from within a command on a cluster (for - * example, through a notebook). There is no API to read the actual secret value material outside - * of a cluster. However, the user's permission will be applied based on who is executing the - * command, and they must have at least READ permission. - * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope", "principal": "data-scientists", "permission": "READ" } - * - *

The principal is a user or group name corresponding to an existing Databricks principal to - * be granted or revoked access. - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws - * ``RESOURCE_ALREADY_EXISTS`` if a permission for the principal already exists. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsService.java index ce21a5b7e..46fd59fbd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretsService.java @@ -26,34 +26,23 @@ public interface SecretsService { *

The scope name must consist of alphanumeric characters, dashes, underscores, and periods, * and may not exceed 128 characters. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-simple-databricks-scope", "initial_manage_principal": "users" - * "scope_backend_type": "databricks|azure_keyvault", # below is only required if scope type is - * azure_keyvault "backend_azure_keyvault": { "resource_id": - * "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx", - * "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dns_name": - * "https://xxxx.vault.azure.net/", } } - * *

If ``initial_manage_principal`` is specified, the initial ACL applied to the scope is * applied to the supplied principal (user or group) with ``MANAGE`` permissions. The only * supported principal for this option is the group ``users``, which contains all users in the * workspace. If ``initial_manage_principal`` is not specified, the initial ACL with ``MANAGE`` * permission applied to the scope is assigned to the API request issuer's user identity. * - *

If ``scope_backend_type`` is ``azure_keyvault``, a secret scope is created with secrets from - * a given Azure KeyVault. The caller must provide the keyvault_resource_id and the tenant_id for - * the key vault. If ``scope_backend_type`` is ``databricks`` or is unspecified, an empty secret - * scope is created and stored in Databricks's own storage. + *

If ``scope_backend_type`` is ``AZURE_KEYVAULT``, a secret scope is created with secrets from + * an existing Azure key vault. The caller must provide the key vault's resource ID and DNS name + * in ``backend_azure_keyvault``. If ``scope_backend_type`` is ``DATABRICKS`` or is unspecified, + * an empty secret scope is created and stored in Databricks-managed storage. * *

Throws ``RESOURCE_ALREADY_EXISTS`` if a scope with the given name already exists. Throws * ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of scopes in the workspace is exceeded. Throws * ``INVALID_PARAMETER_VALUE`` if the scope name is invalid. Throws ``BAD_REQUEST`` if request - * violated constraints. Throws ``CUSTOMER_UNAUTHORIZED`` if normal user attempts to create a - * scope with name reserved for databricks internal usage. Throws ``UNAUTHENTICATED`` if unable to - * verify user access permission on Azure KeyVault + * violated constraints. Throws ``CUSTOMER_UNAUTHORIZED`` if the scope name is reserved for + * Databricks internal use. Throws ``UNAUTHENTICATED`` if Databricks cannot verify the caller's + * access to the Azure key vault. */ void createScope(CreateScope createScope); @@ -62,12 +51,6 @@ public interface SecretsService { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope", "principal": "data-scientists" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope, principal, or ACL exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. @@ -77,15 +60,8 @@ public interface SecretsService { /** * Deletes a secret scope. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if the scope does not exist. Throws ``PERMISSION_DENIED`` - * if the user does not have permission to make this API call. Throws ``BAD_REQUEST`` if system - * user attempts to delete internal secret scope. + * if the user does not have permission to make this API call. */ void deleteScope(DeleteScope deleteScope); @@ -95,8 +71,7 @@ public interface SecretsService { * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws - * ``BAD_REQUEST`` if system user attempts to delete an internal secret, or request is made - * against Azure KeyVault backed scope. + * ``BAD_REQUEST`` if the request is made against an Azure Key Vault-backed scope. */ void deleteSecret(DeleteSecret deleteSecret); @@ -105,12 +80,6 @@ public interface SecretsService { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example response: - * - *

.. code:: - * - *

{ "principal": "data-scientists", "permission": "READ" } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. @@ -139,13 +108,6 @@ public interface SecretsService { * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example response: - * - *

.. code:: - * - *

{ "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": - * "data-scientists", "permission": "READ" }] } - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ @@ -154,13 +116,6 @@ public interface SecretsService { /** * Lists all secret scopes available in the workspace. * - *

Example response: - * - *

.. code:: - * - *

{ "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" },{ "name": - * "mount-points", "backend_type": "DATABRICKS" }] } - * *

Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ ListScopesResponse listScopes(); @@ -183,24 +138,9 @@ public interface SecretsService { * - Allowed to read and write to this secret scope. * ``READ`` - Allowed to read this secret * scope and list what secrets are available. * - *

Note that in general, secret values can only be read from within a command on a cluster (for - * example, through a notebook). There is no API to read the actual secret value material outside - * of a cluster. However, the user's permission will be applied based on who is executing the - * command, and they must have at least READ permission. - * *

Users must have the ``MANAGE`` permission to invoke this API. * - *

Example request: - * - *

.. code:: - * - *

{ "scope": "my-secret-scope", "principal": "data-scientists", "permission": "READ" } - * - *

The principal is a user or group name corresponding to an existing Databricks principal to - * be granted or revoked access. - * *

Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws - * ``RESOURCE_ALREADY_EXISTS`` if a permission for the principal already exists. Throws * ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid. Throws * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. */ diff --git a/examples/docs/pom.xml b/examples/docs/pom.xml index 879af0e90..efd805640 100644 --- a/examples/docs/pom.xml +++ b/examples/docs/pom.xml @@ -24,7 +24,7 @@ com.databricks databricks-sdk-java - 0.183.0 + 0.184.0 diff --git a/examples/spring-boot-oauth-u2m-demo/pom.xml b/examples/spring-boot-oauth-u2m-demo/pom.xml index 64de34367..332ae409c 100644 --- a/examples/spring-boot-oauth-u2m-demo/pom.xml +++ b/examples/spring-boot-oauth-u2m-demo/pom.xml @@ -40,7 +40,7 @@ com.databricks databricks-sdk-java - 0.183.0 + 0.184.0 diff --git a/lockfile.json b/lockfile.json index c8e84a4e0..ae2d29333 100644 --- a/lockfile.json +++ b/lockfile.json @@ -1,7 +1,7 @@ { "artifactId": "databricks-sdk-parent", "groupId": "com.databricks", - "version": "0.183.0", + "version": "0.184.0", "lockFileVersion": 1, "dependencies": [], "mavenPlugins": [], diff --git a/pom.xml b/pom.xml index f48cb819a..100473623 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ 4.0.0 com.databricks databricks-sdk-parent - 0.183.0 + 0.184.0 pom Databricks SDK for Java The Databricks SDK for Java includes functionality to accelerate development with Java for diff --git a/shaded/pom.xml b/shaded/pom.xml index a2780353d..78ad300e6 100644 --- a/shaded/pom.xml +++ b/shaded/pom.xml @@ -4,7 +4,7 @@ 4.0.0 - 0.183.0 + 0.184.0 com.databricks